Deposit Status Endpoint
Retrieve the status of a previously created deposit
Deposit Status
POST
https://api-stg.directa24.com/apd/webpaystatus
This endpoint allows you to retrieve the status of a deposit
Headers
Name | Type | Description |
---|---|---|
Content-Type* | string | application/x-www-form-urlencoded |
Request Body
Name | Type | Description |
---|---|---|
x_login* | string | Your Directa24 WEB STATUS API Key, found on the Merchant Panel by going to Settings -> API Access -> Web Status Credentials -> API Key |
x_trans_key* | string | Your Directa24 WEB STATUS API Passphrase, found on Merchant Panel by going to Settings -> API Access -> Web Status Credentials -> API Passphrase |
x_invoice* | string | The transaction's ID in your end to verify its status |
type | string | The format of the response: JSON, XML or STRING. If none is specified the response will be a pipe separated string |
All the requests must be in x-www-form-urlencoded format and contain the following header:
Content-Type: application/x-www-form-urlencoded
Example Request
Example Response
Request fields description
Field | Format | Description |
---|---|---|
x_login | string (max length: 32) | Your D24 WEB STATUS API Key, found on Settings -> API Access. |
x_trans_key | string (max length: 32) | Your D24 WEB STATUS API Passphrase, found on Settings -> API Access. |
x_invoice | string (max length: 125) | The transaction's ID in your end to verify its status |
type | string (max length: 20) | The format of the response: JSON, XML or STRING. If none is specified the response will be a pipe separated string. |
Response fields description
Field | Description |
result | Transaction status. See possible status codes |
x_iduser | Unique user ID in your side |
x_invoice | Unique identification for the transaction in your end |
x_amount | Payment's amount |
PT | Indicates whether the transaction was created with Test purposes or not, with the values: 0 for Production, 1 for Test |
Sign | Control signature |
x_document | Unique transaction's ID at D24's end |
x_bank | Payment Method code. See Payment Method codes |
x_payment_type | Payment type. See payment types |
x_bank_name | Payment Method name |
x_currency | Transaction's currency in ISO 4217 |
x_approval_detail | Deposit's description |
card_number | Credit Card info |
Control signature of the Webpaystatus Response
The response control signature includes the following fields:
x_login - your DEPOSITS API Key which can be found in the Merchant Panel by going to Settings -> API Access -> Deposit Credentials -> API Key
result
x_amount
x_invoice
secretKey - your DEPOSITS Signature Key which can be found in the Merchant Panel by going to Settings -> API Access -> Deposit Credentials -> API Signature
Status Flow
Click here to see each Deposit Status meaning.
Hosted Checkout Status Flow
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.
COMPLETED and CANCELLED* are final status.
*There are cases in which the users pays after the deposit expired, or payed an incorrect amount and the deposit gets expired. When that happens manual intervention is required to approve the deposit hence a deposit could change its status from CANCELLED to COMPLETED.
If the user doesn't pays, the transaction will expire and be marked as CANCELLED.
No transaction will change from COMPLETED to CANCELLED.
Status codes
Check all the possible status in the following page:
API CodesLast updated