Cashout Cancellation Endpoint

Learn how to use the Cashout Cancellation Endpoint to cancel cashouts when needed

Cashout Cancellation Endpoint

DELETE https://api-stg.lime-pay.com/v3/cashout/cancel

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

Headers

NameTypeDescription

Content-Type*

string

application/json

Payload-Signature*

string

Control Signature

Request Body

NameTypeDescription

login*

string

Your LimePay CASHOUTS API login key

pass*

string

Your LimePay CASHOUTS API pass key

cashout_id*

number

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

external_id*

string

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

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

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

// HEADERS
Content-Type: application/json 
Payload-Signature: 2e5023770760ea0a02230bff1a6dab934fe3b47a5e3d43854b58676600ee3868 

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

Request Fields

FieldFormatDescription

login

String. Length 32 max

Your Lime-Pay 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 Lime-Pay CASHOUTS API Passphrase, it can be found on the Merchant Panel: Settings -> API Access. Notice there are specific Cashout credentials

cashout_id

Number

external_id

String

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

// Cashout cancelled successfully
{
    "cashout_status": 2,
    "cashout_status_description": "Canceled"
}

// Cashout not found
{
    "code": 509,
    "message": "Cashout not found with this ID"
}

// The cashout can't be cancelled because its status is not Pending
{
    "code": 510,
    "message": "Invalid status transition"
}

Response fields

Field

Format

Type

Description

cashout_status

Number

Success

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

Last updated