Cashout Status Endpoint

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

Endpoint Estado de Retiro

POST https://api-stg.tupayonline.com/v3/cashout

Headers

Name	Type	Description
Content-Type*	string	application/json
Payload-Signature*	string	Control signature

Request Body

Name	Type	Description
login*	string	(max length: 32) Tupay "Withdrawals" login key, found in the merchant dashboard under Settings -> API Access.
external_id*	string	(max length: 100) Unique ID for withdrawals from your side
cashout_id*	number	The withdrawal ID to check the status. It is the one that TuPay generated when the withdrawal was created.
pass*	string	(max length: 32) Tupay "Withdrawals" Passphrase key, found in the merchant panel under Settings -> API Access.

200 Withdrawal request created successfully.

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

401 The specified credentials are incorrect.

{
    "code": 401,
    "message": "Invalid credentials."
}

412 Withdrawal not found with this ID

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

Request Example

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

Withdrawal Status Flow

Status Code

Code	Meaning	Description
0		The withdrawal was accepted by Tupay, but it has not yet been sent to the bank. It can still be cancelled.
1		The money arrived in the client's account.
2		The withdrawal was canceled by you.
3		The withdrawal was canceled by the bank (invalid document, invalid account, etc.)
4		The withdrawal was sent to the bank for processing. Now it can no longer be canceled
5		The withdrawal was placed on hold. They can move it back to pending when necessary.