Skip to content

Payout Webhook

Currently, the types of payout webhooks are as follows:

payout.paid: Payout processing (this status can be ignored), please rely on completed and failed for confirmation.

payout.completed: Payout successful event. This event notification is triggered after the successful completion of a payout, indicating that the payout was successful.

payout.failed: Payout failed event. This event notification is triggered after the failure of a payout, indicating that the payout has failed.

The data returned for both payout.completed and payout.failed is as follows:

Notification Parameters:

FieldTypeDescription
orderNoStringPayout system order number
merOrderNoStringMerchant-side merchant order number
currencyStringCryptocurrency currency, e.g., USDT, BTC, etc. View the currency list
totalAmountBigDecimalCryptocurrency amount
tradeStartTimeLongPayout start time
chainPaymentInfoInvoiceChainPaymentInfoPublic chain payout information (These parameters will only be returned if it is a blockchain payout)
messageStringIf the payout fails, the reason for the failure
statusStringPayout order status (paid: processing, completed: paid and completed, failed: processing failed)

InvoiceChainPaymentInfo:

FieldTypeDescription
networkStringPublic chain information
payeeAddressStringWallet address
transactionIdStringBlockchain transaction ID
blockHashStringPacked block hash
blockHeightLongPacked block height
packageTimeLongPackage time