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.
Through the parameter current_payer_verification you can check if the current payer is the same person who created the deposit. Below you can see the possible results for this parameter:
Match --> The document of the person who paid is the same as the one of the person who created the payment.
Unmatch --> The documents are different.
No client document -> It is when there is no document of the person who proceed with the payment (Current payer).
No current payer data -> It is when there is no document of the person who proceed with the payment (Current payer)
In order to make the experience more personalized, we may add more fields to this response's object in the future. Please develop your integration to be able to ignore new fields to avoid any issues.
If you are not sending all the payer details in the deposit request, make sure you store the details we collect and share with this endpoint so that in future attempts you can re-use them instead of having the payers to fill in the same details every time they deposit.
financial_institution Object
Example response with financial_institution object
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 paid 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 EXPIRED or CANCELLED to COMPLETED.
EARLY RELEASED will only be used if you specified it in the deposit request.
FOR REVIEW is a transient status we use to specify that the deposit is under revision.
If the user doesn't pays, the transaction will be marked as EXPIRED. After 7 days it will change to CANCELLED.
Status codes
Check all the possible status in the following page:
The financial_institution Object aims to provide insights and additional information about from which banks the deposits are being completed (nowadays only available for Pix deposits).
The bank_account Object aims to provide information about the bank account from which the deposit was paid.
Currently, this only applies to PIX deposits and Spei deposits.
deposit_id*
integer
Directa24 deposit_id. It is obtained when creating the deposit
X-Date*
string
ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ
Specifies if the bonus_amount is absolute or relative. It will be shown only if the bonus_amount is not null
payment_method
String
Payment method code specified on the deposit request or selected by the user on our checkout. It will be shown only if the user has selected a payment method