Cashout Cancellation Endpoint
Learn how to use the Cashout Cancellation Endpoint to cancel cashouts when needed
delete
https://api-stg.directa24.com
/v3/cashout/cancel
Cashout Cancellation Endpoint

Cancel Cashout Request

The Cancel Cashout Request endpoint is only to cancel a cashout while it is still in PENDING state (it hasn't been sent for processing).
To do that, you will need to provide both the cashout ID on our end and the external ID you sent while creating the cashout.
The method to use this endpoint has to be DELETE.

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
"external_id": "cashoutID2134"
11
}
Copied!

Request Fields

Field
Format
Description
login
String. 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
pass
String. 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_id
Number
Identifier of the cashout in the Directa24 end. Returned by the Create Cashout Endpoint
external_id
String
The external ID of the cashout to cancel. It is the one you sent when generating the cashout

Request Payload Signature

The Payload-Signature of the Cashout Status Endpoint is calculated by hashing the JSON payload of the request using HMAC256 and your secret key (API Signature) to encrypt it.
Click here for further instructions.

Cancel Cashout Response

Response Example

1
// Cashout cancelled successfully
2
{
3
"cashout_status": 2,
4
"cashout_status_description": "Canceled"
5
}
6
7
// Cashout not found
8
{
9
"code": 509,
10
"message": "Cashout not found with this ID"
11
}
12
13
// The cashout can't be cancelled because its status is not Pending
14
{
15
"code": 510,
16
"message": "Invalid status transition"
17
}
Copied!
Response fields
Field
Format
Type
Description
cashout_status
Number
Success
If shown, it is the new status code of the cashout.
cashout_status_description
String
Success
If shown, it described the new status of the cashout.
code
Number
Error
Error code
message
String
Error
Error description