Cashout Status Endpoint

Learn how to use the Endpoint to retrieve the status of a cashout

Cashout Status Request

Request Example

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

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

Request Fields Description

Field	Format	Description
login	String. Length 32 max	Your Tupay 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 Tupay CASHOUTS API Passphrase, it can be found on the Merchant Panel: Settings -> API Access. Notice there are specific Cashout credentials
cashout_id	Number	Identifier of the cashout on Tupay end. It is the one returned by the Cashout Creation Endpoint
external_id	String	Identifier of the cashout on the Merchant end. It is the one you sent while creating the cashout request. You can opt to send this field or cashout_id

Cashout Status Response

Response Example

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

{
    "cashout_status": 3,
    "cashout_status_description": "Rejected",
    "rejection_code": 808,
    "rejection_reason": "ERROR_OTHER"
}

Response Fields Description

Field	Format	Description
cashout_status	Number	Status code of the cashout.
cashout_status_description	String	Description of the status
rejection_code	Number	Rejection code if sent by the bank.
rejection_reason	String	Reason of the rejection if sent by the bank

Cashout Statuses

1. DECLINED: The DECLINED status is not a status by itself. It means the transaction couldn't be created because of an error with the data, the customer or the merchant configuration. No transaction will change its status from DECLINED.

2. PENDING: Once the cashout is in PENDING status, it means it was successfully created and that it will be send for processing soon, changing to DELIVERED. It can also be manually changed to CANCELLED.

3. CANCELLED: It means you didn't want to proceed with the cashout and it was CANCELLED through the Merchant Panel or through the Cancel Cashout Endpoint. Final status.

4. DELIVERED: As soon as the cashout is sent to the bank for processing, its status will change to DELIVERED. At which point it can't be cancelled anymore.

5. COMPLETED: If the cashout was successfully completed, its status will be set to COMPLETED. Final status

6. REJECTED: If the cashout was rejected by the bank, its status will be set to REJECTED. Final status.