Cashout Status Endpoint
Learn how to use the Endpoint to retrieve the status of a cashout
Cashout Status Request
Request Example
Request Fields Description
Field | Format | Description |
---|---|---|
| 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 |
| 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 |
| Number | Identifier of the cashout on Tupay end. It is the one returned by the Cashout Creation Endpoint |
| 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 Status Response
Response Example
Response Fields Description
Field | Format | Description |
---|---|---|
| Number | Status code of the cashout. |
| String | Description of the status |
| Number | Rejection code if sent by the bank. |
| String | Reason of the rejection if sent by the bank |
Cashout Statuses
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.
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.
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.
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.
COMPLETED: If the cashout was successfully completed, its status will be set to COMPLETED. Final status
REJECTED: If the cashout was rejected by the bank, its status will be set to REJECTED. Final status.
Última actualización