What is ActiveDeposit

ActiveDeposits is a feature of AzPay for making it no longer necessary for the user to previously place a deposit order before sending a deposit.

Please note that ActiveDeposits are, by default, disabled, in non-individualized setups. You should ask the team to enable ActiveDeposits in your setup once you have finished integrating. Use the simulator for mimicking ActiveDeposits-created order during the development stage.

For ActiveDeposits to work, you do not need to register deposit orders: once new incoming transfers are identified that do not match any pre-existing orders, a new order is created at our side. For the partner, it is given two methods for obtaining the newly created orders: through a webhook (a "OrderCreated" webhook is called - see "Webhooks") or through a queueing mechanism for API polling.

📘

It's important to mention that if your setup has ActiveDeposits enabled, it is still possible to create deposit orders. It is up to you whether to offer both solutions to customers or only one of them.

Furthermore, for ActiveDeposits to start working for a customer, it is needed to register the customer through the "Register Customer" endpoint. The registration is the very same as when "Orders: Create Order" endpoint is used, and the users registered are the same listed in the endpoints at the section "User". Therefore, if one user has already made deposits, regardless of being through ActiveDeposits or not, such user is already registered. However there is no problem in trying to register one user once again, as the system pre-checks if the user is already registered and, in this case, simply returns the stored information.

If you prefer not to have your user creating deposit orders before actually sending transfers, you may request us to enable ActiveDeposits on your setup. This is enabled by default on individualized setups.

With ActiveDeposits, once a transaction is received, an order is created on our side. You may retrieve the credited orders in real time through webhook or through polling at the dedicated ActiveDeposits queue endpoint.

📘

Please note that ActiveDeposits are only compatible with "deposits" order ("buy" or cash-out is not supported).