Cancel a cashout

Cancel a cashout

delete

This API allows you to cancel a cashout request. Only for cashouts in PENDING state.

Header parameters

Content-TypestringRequired

Media type of the request.

Default: application/json

Payload-SignaturestringRequired

Control Signature. Calculated by hashing the JSON payload of the request using HMAC256 and your secret key (API Signature) to encrypt it.

Example: 2e5023770760ea0a02230bff1a6dab934fe3b47a5e3d43854b58676600ee3868

Body

application/json

loginstring · max: 32Required

Your onekeypayments CASHOUTS API login key.

Example: cashout_login

passstring · max: 32Required

Your onekeypayments CASHOUTS API pass key.

Example: cashout_pass

cashout_idinteger · int64Required

The ID of the cashout to cancel. It is the one generated by onekeypayments when the cashout was created.

Example: 11954

external_idstringRequired

The external ID of the cashout to cancel. It is the one you sent when generating the cashout.

Example: cashoutID2134

Responses

200

Cashout cancelled successfully

application/json

cashout_statusintegerOptional

New status code of the cashout.

Example: 2

cashout_status_descriptionstringOptional

Description of the new status of the cashout.

Example: Canceled

412

Error while cancelling the cashout. It can be cancelled only if its status is Pending. (Also used for "Cashout not found" or other "Invalid status transition" errors as per PDF examples)

application/json

delete

/cashout/cancel

HTTPcURLJavaScriptPython

DELETE /v3/cashout/cancel HTTP/1.1
Host: api-stg.onekeypayments.com
Payload-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "login": "cashout_login",
  "pass": "cashout_pass",
  "cashout_id": 11954,
  "external_id": "cashoutID2134"
}

{
  "cashout_status": 2,
  "cashout_status_description": "Canceled"
}