Sign in

v1

latestOpenAPI 3.0.02026-07-26355499.1 KB
Cashout

Update Cashout Status

This API allows you to change the status of a cashout. The primary use case is to update a cashout from PENDING to ON_HOLD, or from ON_HOLD to PENDING. A cashout in ON_HOLD will not be processed until it's set back to PENDING. This is useful for KYC checks. Only cashouts in PENDING status can be updated to ON_HOLD. Once a cashout is DELIVERED, it cannot be cancelled via this status update. Cashouts in ON_HOLD reserve funds from your balance.

put/v3/cashout/status

Headers

Content-Type'application/json' required

Media type of the request. Must be application/json.

Payload-Signaturestring required

Control Signature. Calculated by hashing the entire JSON payload of the request using HMAC256 and your secret API key.

Request body

loginstring required

Your D24 CASHOUTS API login key. Found in Merchant Panel: Settings → API Access.

passstring required

Your D24 CASHOUTS API passphrase. Found in Merchant Panel: Settings → API Access.

cashout_idnumber required

The unique identifier of the cashout on D24's end, obtained from the Create Cashout Endpoint.

status'ON_HOLD' | 'PENDING' required

The status to be assigned to the cashout.

Response

The status of the cashout was successfully updated. The response body reflects the cashout's new or current status.

cashout_statusinteger

Numeric code representing the cashout's current status.

cashout_status_descriptionstring

Textual description of the cashout's current status.

rejection_codeinteger nullable

If the cashout status is 'Rejected', this code indicates the reason for rejection.

rejection_reasonstring nullable

If the cashout status is 'Rejected', this provides a textual explanation for the rejection.