WebHook

Webhooks are a feature that allows you to receive real-time notifications from your server when a payment status (successful, failed, expired, canceled) changes.

Using webhooks

WebHook registration requires Callback URL registration.

You can register a callback URL by contacting us.

Webhooks are sent based on partner_order_id.

State

success

A status change that occurs when a payment or withdrawal is successfully completed. It is usually called upon successful payment and the merchant should pay out points or goods as a result.

pending

A status that occurs when a withdrawal request is successful. This usually occurs when the user's withdrawal request is successfully registered in the admin.

fail

This error code is generated when a payment/withdrawal request fails due to various reasons such as user cancellation, insufficient assets, etc. Once the status is updated, the payment for that TxId will be terminated.

Request object

Name	Type	Description
secret	string	The secret key issued by Excoinz. You can use this value to verify the security of the Webhooks API.
txId	string	The partner_order_id value sent when initiating the payment/withdrawal.
state	string	The status value of the payment.
amount	string	The amount of cryptocurrency (TRX-USDT) in which the payment was made.
symbol	string	The symbol of the payment asset. The asset currently only supports USDT.
refId	string | null	An Excoinz internal payment ID that can be used for cross-verification.