Setting up Webhooks

To integrate a webhook (callback) for payments and withdrawals you need to follow these steps:

  1. Navigate to the Merchant section.

  2. Select the section you want to integrate, for example "Classic processing" or "Web3".

  3. In "General settings" enter the URL in the "Webhook URL" field for a callback on the payment status or in a separate field for withdrawals. Required https (TLS/SSL)

  4. In the "Webhook password" field enter the password, if you have one.

  5. Click on "Save" to save your webhook settings.

Merchant can setup Webhook link in Merchant menu, and instantly start receiving data about incoming payments and withdrawals in JSON such as: amount, status, timestamp, etc. Every time new crypto payment gets deposited or funds have been withdrawn Merchant will receive webhook with transaction details:

  • status

  • currency

  • amount

  • USD amount

  • blockchain transaction's hash

  • address

  • Merchants Client ID

  • Merchants ID

  • Signature

  • ...and so on

Attention

Merchant should validate webhook's signature and values of known parameters in order to avoid fraudulent activity.

After successful validation of webhook, Merchant should respond with HTTP Code: 200 OK. No additional parameters are required in the response body.

Our server expects a response to the webhook within a 3-second timeout period. If the response is not received within these 3 seconds, the system considers the delivery failed.

In case if Merchant will not validate callback System repeats it 31 times with an interval of 15 seconds. If Webhook still fails to be delivered, System sends notification to the Merchant's email indicating a problem with Webhook URL.

Webhook's test

The following integration method is used to test webhooks for payments.

To emulate test payments, the parameter Test=true must be transferred.

Link to the payment form for the test payment opens with buttons to emulate Successful Payment, Canceled Payment and Insufficient Payment. Test payment link must be opened in the same browser as the logged in merchant account.

In the case of successful validation of the callback, your system will respond with HTTP Code: 200 OK. No additional parameters are required in the response body.

To resend a non-test callback, you can use the menu Transactions

In the field of the transaction you need to press the button "Show webhooks"

And then "Resend"

Learn more about integrating callbacks in API documentation: 0xProcessing API

PreviousAPI set upNextPayment confirmation

Last updated