Our API was developed to facilitate the integration and automation of the process of monitoring transaction deposits and withdrawals. We will send notifications to your system in one of the following three situations:
- QRCode Generation – Whenever a QRCode is generated, we will send a notification.
- QRCode Payment – We will notify you when a deposit via QRCode has been made successfully.
- Withdrawal Success or Failed Confirmation – We will send you a notification as soon as the status of a withdrawal request is confirmed as successful or failed.
See the step by step ⇩
Step 1: Create the Notification URL
Create a URL on your system that will be used to receive event notifications, such as:
- QRCode generation,
- QRCode payment,
- Confirmation of withdrawal success or failure.
You can see how to do this in our notification documentation.
Step 2: Store Notification Data
As soon as you receive the notification, save the data, such as txid. You will need them to consult more details later.
Step 3: Authenticate and Obtain the Token
Before viewing details of any transaction, you need to authenticate to obtain an access token. The authentication process is explained here.
Step 4: View Transaction Details
Now that you have the token and webhook data, you can query what you want:
- Query a Deposit: Use the received token and
txidand follow the deposit inquiry route. - Query a Withdrawal: Use the token and
txidand follow the withdrawal query route.
By following this flow, you will have all the information necessary to manage transactions efficiently and securely. 💚