Sign in

v1

latestOpenAPI 3.0.02026-07-26355499.1 KB
Cashout

Retrieve Cashout Status

This API allows you to retrieve the status of a cashout.

post/v3/cashout/status

Headers

Content-Typestring required

Media type of the body sent to the API. Must be application/json.

Payload-Signaturestring required

Control Signature.

Request body

loginstring required

Your D24 CASHOUTS API login key. Length 32 max.

passstring required

Your D24 CASHOUTS API pass key. Length 32 max.

cashout_idnumber

The ID of the cashout to check status of. It is the one generated by D24 when the cashout was created. (Required if external_id is not provided)

external_idstring

The ID of the cashout to check status of. It is the one you sent when the cashout was created. (Required if cashout_id is not provided)

Response

The status of the cashout was successfully retrieved.

cashout_status0 | 1 | 2 | 3 | 4 | 5

Status code of the cashout.

  • 0: PENDING - The cashout was accepted by D24 but it wasn't sent to the bank yet. It can still be Canceled.
  • 1: COMPLETED - The money reached the customer's account.
  • 2: CANCELLED - The cashout was cancelled by you.
  • 3: REJECTED - The cashout was rejected by the bank due to invalid bank account, account closed, etc.
  • 4: DELIVERED - The cashout was sent to the bank for processing. At this point it can't be cancelled anymore.
  • 5: ON HOLD - Cashout set to on hold by you. It won't be processed until manually changed again to Pending status.
cashout_status_descriptionstring

Description of the status. (e.g., "Completed", "Pending", etc.)

rejection_code800 | 801 | 802 | 803 | 804 | 805 | 806 | 807 | 808 | 809 | 810 | 811 | 812 | 813 | 814 | 815 | 816 | 817 | 818 | 819 | 820 | 821 | 822 | 824

Rejection code if the cashout status is REJECTED. See enum for possible bank rejection codes.

rejection_reasonstring

Textual reason for rejection, corresponding to the rejection_code. (e.g., "ERROR_ACCOUNT_INCORRECT")

provider_external_referencestring

ID of the transaction on the bank side. For Pix, it's the E2E ID (End-to-end).