Before you begin, it is highly recommended to review the Deposit Flows (Pay-in) start page, as it explains some of the terms used here as well, in case you haven't seen it yet.
What does this endpoint do?
The primary purpose of this endpoint is to create a deposit order by generating a dynamic QR codes according to the user's necessity.
In dynamic QR codes is possible to configure a expiration time and they can be only paid once. If this parameter is not informed the default value is 900 seconds (or 15 minutes).
It is important to note that the currency used in the transaction will be determined by the target account specified by the accountId.
The amount parameter is required, so make sure that is not be null, less than or equal to zero, or exceed 10,000,000.
Deposit orders can have the following statuses:
- DepositCreated: QR code created and awaiting payment
- DepositCompleted: QR code successfully paid
- DepositError: This occurs when a generic error happens during the deposit flow, preventing the generation of the QR code.
- DepositReimbursedCompleted: This status appears when a flow is blocked due to certain mapped conditions, resulting in a refund of the deposited amount. These flow blocks typically occur due to issues with the sender's tax ID, such as when the ID is invalid, belongs to a minor, or is on our blacklist, making transactions impossible.
When a deposit is identified by Transfero, a credit transaction is created with the same referenceId. However, the status will only change on the first deposit, updating to "DepositCompleted." This status change occurs only once. Any subsequent payments using the same QR code will not result in a status change but will generate a new credit transaction.
The externalId parameter can be used as a identifier for the deposit. This identifier will be included in the credit transaction document, allowing for external monitoring of the transaction. However, it's important to note that the externalId is not a unique identifier.