Getting Started
Transactions
Information
This feature allows you to transfer funds to your users who may not yet have an active Luxon account. User identification will be based on their email address. Funds will remain in a PROCESSING status until the user opens an active Luxon account, at which point the payout will be PROCESSED.
To utilize this feature, the user’s email should be provided in the ‘email’ parameter and you also have to add a ‘isPendingPayout=true‚ parameter in the request body.
Optionally, to enhance security, you can also provide the user’s date of birth in the ‘dateOfBirth’ parameter. This identifier will be cross-checked with the user’s verified Luxon account KYC details. If the details don’t match, the payout won’t proceed and you’ll receive a notification.
Scenario A: User with an Active Luxon Account
If the provided email address is already associated with a Luxon account, it is processed as a regular Payout with Email.
Scenario B: User Without an Active Luxon Account
If the user doesn’t have an active Luxon account:
Once the user activates their Luxon account:
Scenario C: Unclaimed Funds
If the user does not activate their Luxon account within 14 days, the payout transaction expires and the expired funds are available for you to use again.
Request parameters
Name | Type | Description |
merchantTransactionId | String | A Unique ID to identify the transaction. |
merchantUserId | String | A unique ID to identify the user. |
String | The email address of the user to whom the PayOut is being sent. | |
comment | String | A text comment that accompanies the withdrawal (visible to the user and merchant). |
amount | Integer | A positive integer in cents represents how much the user wishes to withdraw.
e.g. 100 EUR would be 10000 / 50 USD would be 5000 |
currency | String | The ISO 3 letter currency code in lowercase, see the supported currency list for details. |
brand | String | An optional string that can be used to send identifying information for the merchant to allow grouping of transactions. |
isPendingPayout | boolean | Specifies the creation of the Claim Pending Payout feature. |
dateOfBirth | LocalDate | The user’s date of birth formatted in ISO8601 (YYYY-MM-DD). |
{
"amount": 100000,
"merchantTransactionId": 248512321,
"comment": "Payout",
"currency": "USD",
"merchantUserId": 811226,
"brand": null,
"email": "Mi***ru"
"isPendingPayout": true
"dateOfBirth": 2000-12-29
}
The response is the same as for PayOut.