Create Pay-out

LUXON API

  •  
  • Integration checklist
  • API Guide
  • Authentication
  • Error Handling
  • Transactions
  • Create Payment
  • Create Pay-out
  • Get Transaction
  • Cancel Payment
  • Refund Payment
  • Resend Transaction
  • Two Step Transactions
  • Create Payment
  • One Click Payments
  • Create One-click Agreement
  • Create One-click Payment
  • Information
  • Check Transactions
  • Get Balances
  • Webhooks
  • Transactions Statuses

Create Pay-out

Create pay-out allows a merchant to initiate a withdrawal from a merchant wallet to a user

Parameters


merchantTransactionId

A Unique ID to identify the transaction.


merchantUserId

Aunique ID to identify the user.


recipientWallet

The wallet address of the user that the payout is being sent to.


comment

A text comment that accompanies the deposit (visible to the user and merchant).


amount

A positive integer in cents representing how much the user wishes to deposit.
e.g. 100 EUR would be 10000 / 50 USD would be 5000


currency

The ISO 3 letter currency code in lowercase, see the supported currency list for details.


brand

An optional string that can be used to send identifying information for the merchant to allow grouping of transactions.


 

Request Post .../api/v1/merchant/payout

{
"merchantTransactionId": "string",
"merchantUserId": "string",
"recipientWallet": "string",
"comment": "string",
"amount": number,
"currency": "String",
"brand": "string"
}

Returns


transactionId

A unique Luxon transaction identifier that can be used as a reference in other API calls.


fee

The fee charged to the merchant for this transaction in EUR cents.


status

A status object with the results of the call.


 

Response

{
"transactionId": "string",
"fee": number
"status": {
"code": "string",
"message": "string"
}
}