Latest
API Documentation
Deposits Tools
Specifications
Cashout Status Endpoint
Learn how to use the Endpoint to retrieve the status of a cashout
post
https://api-stg.directa24.com
/v3/cashout/status
Cashout Status Endpoint
Cashout Status Request
Request Example
1
// HEADERS
2
Content-Type: application/json
3
Payload-Signature: 2e5023770760ea0a02230bff1a6dab934fe3b47a5e3d43854b58676600ee3868
4
5
// BODY
6
{
7
"login": "cashout_login",
8
"pass": "cashout_pass",
9
"cashout_id": 11954
10
}
Copied!
Request Fields Description
Field
Format
Description
loginString. Length 32 max
Your Directa24 CASHOUTS API Key, it can be found on the Merchant Panel: Settings -> API Access. Notice there are specific Cashout credentials
passString. Length 32 max
Your Directa24 CASHOUTS API Passphrase, it can be found on the Merchant Panel: Settings -> API Access. Notice there are specific Cashout credentials
cashout_idNumber
external_idString
Identifier of the cashout on the Merchant end. It is the one you sent while Creating the Cashout request. You can opt to send this field or
cashout_idRequest Payload Signature
The Payload-Signature of the Cashout Status Endpoint is calculated by hashing the whole JSON payload of the request using HMAC256 and your secret key (API Signature) to encrypt it.
Cashout Status Response
Response Example
1
{
2
"cashout_status": 1,
3
"cashout_status_description": "Completed"
4
}
5
6
{
7
"cashout_status": 3,
8
"cashout_status_description": "Rejected",
9
"rejection_code": 808,
10
"rejection_reason": "ERROR_OTHER"
11
}
Copied!
Response Fields Description
Field
Format
Description
cashout_status_descriptionString
Description of the status
rejection_reasonString
Reason of the rejection if sent by the bank
Status Flow
Cashout Status Flow
Cashout Status Flow Diagram
- 1.DECLINED: The DECLINED status is not a status by itself. It means the transaction couldn't be created because of an error with the data, the customer or the merchant configuration. No transaction will change its status from DECLINED.
- 2.PENDING: Once the cashout is in PENDING status, it means it was successfully created and that it will be send for processing soon, changing to DELIVERED. It can also be manually changed to ON_HOLD or CANCELLED.
- 3.ON_HOLD: A cashout will be created with ON_HOLD status only if specified while creating the cashout with on_hold: true. Otherwise, it can be manually set to ON_HOLD from the Merchant Panel. If a cashout is ON_HOLD, it won't be send for processing until you manually go and set it to PENDING from the Merchant Panel. It can still be CANCELLED.
- 4.CANCELLED: It means you didn't want to proceed with the cashout and it was CANCELLED through the Merchant Panel or through the Cancel Cashout Endpoint. Final status.
- 5.DELIVERED: As soon as the cashout is sent to the bank for processing, its status will change to DELIVERED. At which point it can't be cancelled anymore.
- 6.COMPLETED: If the cashout was successfully completed, its status will be set to COMPLETED. Final status*.
- 7.REJECTED: If the cashout was rejected by the bank, its status will be set to REJECTED. Final status.
- There are cases in which the bank confirms us that a payout was successful and after a few days, it gets rejected by the beneficiary's bank therefore the status on our platform will change to REJECTED as well. Those are very corner cases but should be considered.
Status codes
Check all the possible status codes in the following page:
Last modified 9mo ago