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
Name | Type | Description |
---|---|---|
Content-Type* | string |
|
Payload-Signature* | string | Control Signature |
Request Body
Name | Type | Description |
---|---|---|
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 |
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
Request Fields
Field | Format | Description |
---|---|---|
| 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 |
| 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 |
| Number | |
| 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
Response fields
Field | Format | Type | Description |
| Number | Success | |
| String | Success | If shown, it described the new status of the cashout. |
| Number | Error | Error code |
| String | Error | Error description |
Last updated