API Integration

Our Cashouts API enable merchants to generate local withdrawals in every country that D24 operates. In order to do so, merchants need provide the in each transaction the local banking details required.

Therefore, it is important to properly understand the Countries validations within each market that the merchant is willing to operate.

---

Integration flow

1

Cashout creation

Example request

Merchants need to send all the required local information for creating the transaction.

In this example, in 🇲🇽 Mexico we need the document, the bank account, the beneficiary name and last name.

curl -L \
  --request POST \
  --url 'https://api-stg.onekeypayments.com/v3/cashout' \
  --header 'Content-Type: application/json' \
  --header 'Payload-Signature: text' \
  --data '{
    "login": "your_cashout_login",
    "pass": "your_cashout_pass",
    "external_id": "30000000001",
    "country": "MX",
    "currency": "MXN",
    "amount": 100,
    "document_id": "848392783",
    "bank_account": "021790064060296642",
    "beneficiary_name": "Luis",
    "beneficiary_lastname": "Miguel",
    "notification_url": "https://merchant.site/webhooks/onekeypayments",
    "type": "json"
}'

Example response

For technical details, please visit the API Reference Create a cashout

2

Webhook notification

Each time that a cashout changes its status we will send a webhook notification.

Example notification

    date=2020-03-12%2020%3A26%3A11
    &bank_reference_id=
    &comments=
    &external_id=cashoutV35381
    &control=A4CFF64E78C4BD01F8BFCA4AFF04632EC4A33CC61BD6BBD156BA1289897892EB
    &cashout_id=8405147
    &status_reason=

Please visit Notifications

3

Retrieve the cashout status

By creating a request to the cashout status endpoint you will capable od retrieving the final status of the transaction.

Example request

curl -L \
  --request POST \
  --url 'https://api-stg.onekeypayments.com/v3/cashout/status' \
  --header 'Content-Type: application/json' \
  --header 'Payload-Signature: text' \
  --data '{
    "login": "your_cashout_login",
    "pass": "your_cashout_pass",
    "cashout_id": 8405147
  }'

Example response

For technical details, please visit the API Reference Get a cashout status

Additional flows

Note that the flow described above corresponds to a regular cashout completion flow.

Within the cashout lifecycle, cashouts can also be CANCELLED or put ON_HOLD status. For more information visit the API References:

• Cashout cancellation

• Update to On Hold