Deposit Status Endpoint
Deposit Status
GET
https://api-stg.tupayonline.com/v3/deposits/{deposit_id}
This endpoint allows you to retrieve the status of a deposit request.
Path Parameters
Name | Type | Description |
---|---|---|
deposit_id* | integer | Directa24 deposit_id. It is obtained when creating the deposit |
Headers
Name | Type | Description |
---|---|---|
X-Date* | string | ISO8601 Datetime with Timezone: |
X-Login* | string | Merchant X-Login API Key |
Authorization* | string | Authentication signature hash |
Request
You can trigger the check of the status of a deposit at any moment you consider pertinent. However, every time a deposit changes its status, we will send you a notification containing the ID of the deposit so that you can check its status back to retrieve the new deposit's status.
Example request
In the status endpoint, all the request have to be sent as GET, containing the usual headers.
Regarding the Authorization value, since the body of the requests will be empty, you should use an empty ("") string or nothing as the jsonPayload
field.
Example response
Response fields
Field name | Format | Description |
| String | ID generated for the user on Tupay end |
| Number | ID of the deposit on Tupay end |
| String | ID of the deposit on the merchant end |
| String | |
| String | |
| Number | Amount in local currency |
| Number | Amount in USD |
| Number | The amount specified as bonus in the request |
| Boolean | Specifies if the |
| String | Payment Methods
|
| String | |
| Object | Object containing information about the payer. Only the values you've sent or we've collected will be shown. |
| String | Payer's document of identity |
| String | Payer's type of their document of identity |
| String | Payer's email |
| String | Payer's first name |
| String | Payer's last name |
| Object | Object containing the address details about the payer. Only the values you've sent or we've collected will be shown. |
| String | Payer's city |
| String | Payer's state ISO code |
| String | Payer's street |
| String | Payer's zip code |
| Number | Fee of the deposit in the currency of your balance. It will be shown only if the payment_method was sent by you or selected by the customer |
| String | Currency of your balance. It will be shown only if the payment_method was sent by you or selected by the customer |
| Object | Details about the credit card of the payer. This object will be shown only in case of credit card deposits and if we have the information. |
| String | Name of the card holder used to pay |
| String | Brand of the card used to pay |
| String | Masked card number used to pay |
| String | Expiration of the card used to pay in format YYYY-MM ( |
| String | Type of card used: CREDIT/DEBIT |
| String | The result message of the credit card transaction |
Última actualización