Merchant Callback API
Withdrawal Secondary Confirmation Callback
When a merchant uses the Request Withdrawal Order (Secondary Confirmation Required) API, the platform will call this callback interface to ask the merchant to confirm the details of the withdrawal order.
This interface is only applicable for callback type 2(NOTIFY_REQUEST_WITHDRAW
)。Merchants need to confirm the details of the withdrawal order based on the callback content.
Although it shares the same request and response parameter templates as the general Webhook callback interface, the URL for this interface is independent.
API Example
- API Endpoint:
https://xxxx/api/v1/uu/withdraw/info
Request Method
POST
Request Headers
Name | Type | Required | Example Value | Description |
---|---|---|---|---|
Content-Type | string | Yes | application/x-www-form-urlencoded | Request Format: Form-Encoded Format |
X-API-KEY | string | Yes | your-api-key | Authorization key for authentication. |
Request Body Parameters
Below is the request body parameter template:
Attribute Name | Type | Required | Example Value | Description |
---|---|---|---|---|
tenantUserId | String | Yes | tenant123 | Merchant user identifier. |
requestUUID | String | Yes | 2137890 | Unique identifier for the request. |
trackingId | String | Yes | track-4567 | Order tracking ID. |
type | Integer | Yes | 2 | Callback type |
business | Integer | Yes | 0 | Tenant type (no actual control effect currently). |
callBackId | String | No | 12345 | Callback ID. |
toAddress | String | No | TUekuiBgdk... | Target address. |
chainName | String | No | TRON | Blockchain name. |
txId | String | No | 22e1c72076... | Transaction ID. |
symbol | String | No | USDT | Symbol |
amount | String | No | 0.5 | Amount |
txIndex | Integer | No | 20 | Transaction index. |
tag | String | No | WITHDRAW_SUCCESSS | Tag |
fromAddress | String | No | TUekuiBgdk... | Source address. |
newAddress | String | No | TUekuiBgdk... | New address (only used when type is 4). |
riskLevelFrom | Integer | No | 15 | Risk score of the source address (exists when type is 1). |
riskLevelTo | Integer | No | 15 | Risk score of the target address (exists when type is 1). |
Request Example
Response Parameters
Attribute Name | Type | Required | Example Value | Description |
---|---|---|---|---|
requestUUID | String | Yes | 2137890 | Unique identifier for the request. |
userId | String | Yes | 1308764 | Tenant ID. |
createBy | String | Yes | “ | Information about the creator (no actual control effect). |
message | String | Yes | “ | Description message (no actual control effect). |
apiKey | String | Yes | “ | apiKey |
errCode | int | Yes | “ | Error code: 0 indicates success; other values indicate failure. |
data | String | Yes | “ | Encrypted data using an RSA public key. |
Below are the descriptions for the data parameter:
Attribute Name | Type | Example Value | Description |
---|---|---|---|
requestUUID | String | 2137890 | Unique identifier for the request, used to uniquely identify it. |
userId | Integer | 1 | User ID, identifies the specific user who triggered the event. |
trackingId | String track-4567 | Order tracking ID. | |
address | String | toAddress123 | Target address, indicates the operation’s target address. |
tenantUserId | String | tenant123 | Merchant user identifier, used to differentiate merchant users. |
chainName | String | TRON | Blockchain name, identifies the blockchain where the transaction occurred. |
symbol | String | USDT | Currency symbol, identifies the token or currency involved in the transaction. |
callBackId | String | 12345 | Callback ID, identifies the current callback event. |
amount | String | 0.5 | Amount, indicates the specific transaction or operation amount. |
type | Integer | 2 | Callback type, detailed explanation can be found in the callback type |
Response Example
Response Parameter — Callback Type Description
type
:- Always 2, indicating the callback type is NOTIFY_REQUEST_WITHDRAW.
- This callback type is used for merchants to confirm the details of a withdrawal order.
- Merchants should confirm the withdrawal order details based on the callback content before proceeding with further processing.
Notes
- Merchants must ensure that the callback interface URL can be accessed normally and returns the correct response; otherwise, the callback may fail.
- The platform will retry multiple times in case of callback failure. Merchants need to handle idempotency properly to ensure that the same callback request is not processed multiple times.
- The security of the callback interface should be verified using the X-API-KEY. Please keep your key secure to prevent unauthorized access to the interface.