search

Creating Payouts

hashtag
Validate Addresses Before Making Requests

Before making an API call to create a payout, we highly recommend pre-validate the destination address format to reduce the number of errors.

It is recommended because users sometimes submit wrong addresses e.g. xyz - in such a case, the API call will result in the following error message from our API:

{
  "errorList": [
    {
      "parameter": "payOutInstruction",
      "code": "invalidPayout",
      "message": "Invalid Instruction for Payout"
    }
  ]
}

Please use the following endpoint to pre-validate addresses before making your POST /api/v1/pay/summary call:

Validate Addresschevron-right

hashtag
Use Unique References

When creating payout transactions, make sure that you use a unique value in the reference field for your POST /api/pay/summary call. Otherwise, the API responds with a relevant error message:

{
  "errorList": [
    {
      "parameter": "reference",
      "code": "unique",
      "message": "Duplicate Reference"
    }
  ]
}

hashtag
Examples

Below you can see Payout cURL examples for each one of the cryptocurrencies that Coindirect supports.

circle-exclamation

When creating USDT payouts, please specify the protool. Sending USDT to the wrong network will result in a total loss of your funds.

circle-exclamation

When creating USDT payouts, please specify the protool. Sending USDT to the wrong network will result in a total loss of your funds.

circle-exclamation

When creating XRP payouts, please specify a Destination Tag as well by appending to the "address" value via + "?dt=".

If a recipient has no destination tag, just pass "?dt=0"

Destination tags indicate the beneficiary or destination for a payment. For example, a payment to an exchange or gateway address can use a destination tag to indicate which customer to credit for the amount of the payment in that business's own systems. A payment to a merchant could indicate what item or cart the payment is buying.

PreviousPayout WebhooksNextPostman Collection

Last updated