# Cashout Status Endpoint ## Endpoint Estado de Retiro `POST` `https://api-stg.tupayonline.com/v3/cashout/status` #### 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

(max length: 32)

Tupay "Withdrawals" Passphrase key, found in the merchant panel under Settings -> API Access.

| {% tabs %} {% tab title="200 Withdrawal request created successfully." %} ```bash { "cashout_status": 1, "cashout_status_description": "Completed" } { "cashout_status": 3, "cashout_status_description": "Rejected", "rejection_code": 808, "rejection_reason": "ERROR_OTHER" } ``` {% endtab %} {% tab title="401 The specified credentials are incorrect." %} ```bash { "code": 401, "message": "Invalid credentials." } ``` {% endtab %} {% tab title="412 Withdrawal not found with this ID" %} ```bash { "code": 509, "message": "Cashout not found with this ID" } ``` {% endtab %} {% endtabs %} ## Request Example ```java { "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.

--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.tupayonline.com/english/api-documentation/cashout/cashout-status-endpoint.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.