Update a cashout status

Update Cashout Status

put

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.

Header parameters

Content-Typestring · enumRequired

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

Default: application/jsonPossible values:

Payload-SignaturestringRequired

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

Example: 2e5023770760ea0a02230bff1a6dab934fe3b47a5e3d43854b58676600ee3868

Body

application/json

loginstring · max: 32Required

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

Example: cashout_login

passstring · max: 32Required

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

Example: cashout_pass

cashout_idnumber · int64Required

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

Example: 97875

statusstring · enumRequired

The status to be assigned to the cashout.

Example: ON_HOLDPossible values:

Responses

200

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

application/json

cashout_statusintegerOptional

Numeric code representing the cashout's current status.

Example: 1

cashout_status_descriptionstringOptional

Textual description of the cashout's current status.

Example: Completed

rejection_codeinteger · nullableOptional

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

Example: 0

rejection_reasonstring · nullableOptional

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

Example: Test

400

Bad Request. This can occur due to various reasons such as an invalid status transition (e.g., trying to change status from DELIVERED).

application/json

401

Unauthorized. Invalid API credentials (login/pass) or Payload-Signature.

application/json

412

Precondition Failed. The specified cashout_id was not found.

application/json

500

Internal Server Error. An unexpected error occurred on the server side.

application/json

put

/v3/cashout/status

HTTPcURLJavaScriptPython

PUT /v3/cashout/status HTTP/1.1
Host: api-stg.onekeypayments.com
Payload-Signature: 2e5023770760ea0a02230bff1a6dab934fe3b47a5e3d43854b58676600ee3868
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "login": "cashout_login",
  "pass": "cashout_pass",
  "cashout_id": 97875,
  "status": "ON_HOLD"
}

{
  "cashout_status": 1,
  "cashout_status_description": "Completed"
}