Disclaimer: This article contains AI translations and should only be used as reference. Contact Cobo’s support team through help@cobo.com if you have any questions.
Webhook events
| Event name | Trigger condition | Event content |
|---|---|---|
payment.status.updated | [Applicable only to order mode]Pay-in order status has changed. Pay-in order statuses include: - Pending: Order has been created, waiting for payment. No deposit transaction has been detected yet.- Processing: The first deposit transaction has been detected at the receiving address.- Completed: Full payment received within the order validity period- Expired: No completed deposit transactions within the order validity period, or the order has been canceled.- Underpaid: There are completed deposit transactions within the order validity period, but the actual received amount is less than the amount payable. | PaymentOrder |
payment.address.updated | [Applicable only to top-up mode]Top-up address updated | PaymentAddressUpdate |
payment.transaction.created | A new deposit transaction has been detected. In order mode, even if the order has reached a final state (Underpaid, Expired, or Completed), this event will still be triggered. | PaymentTransaction |
payment.transaction.late | [Applicable only to order mode]The deposit transaction has passed compliance screening, but the order is already in a final state (Underpaid, Expired, or Completed). | PaymentTransaction |
payment.transaction.held | The deposit transaction is undergoing compliance screening. In order mode, even if the order has reached a final state (Underpaid, Expired, or Completed), this event will still be triggered. | PaymentTransaction |
payment.transaction.completed | The deposit transaction has passed compliance screening, and the funds have been successfully credited and counted towards the actual received amount. | PaymentTransaction |
payment.refund.status.updated | [Applicable only to order mode]Refund order status has changed. Refund order statuses include: - Pending: A refund order has been created, but no transaction has been initiated yet.- Processing: At least one refund transaction is in progress.- Completed: All refund transactions have been completed.- PartiallyCompleted: Some refund transactions have been completed, and some refund transactions have failed.- Failed: All refund transactions have failed. | PaymentRefund |
payment.settlement.status.updated | Payout/transfer request status has changed. Payout/transfer request statuses include: - Pending: Payout/transfer request has been created, waiting for processing.- Processing: Payout/transfer request is being processed, and at least one payout/transfer is in progress.- Completed: All payouts/transfers have been completed.- PartiallyCompleted: Some payouts/transfers have been completed, and some payouts/transfers have failed.- Failed: All payouts/transfers have failed. | PaymentSettlement |
Event details
PaymentOrder
Refer to the response parameter description of Get pay-in order information.PaymentAddressUpdate
This data structure includes the following fields:custom_payer_id: The unique identifier used in your system to track and identify the payerpayer_id: The unique identifier assigned by Cobo to track and identify the payerchain: Chain ID, such as “ETH”previous_address: Old addressupdated_address: New address
PaymentTransaction
This data structure includes all fields in the response parameters of Get transaction information, and also includes the following fields:acquiring_type: Payment collection type.Orderindicates order mode,TopUpindicates top-up mode.order_id: Pay-in order ID.psp_order_code: The unique identifier used in your system to identify the order.payer_id: The unique identifier assigned by Cobo to track and identify the payer.custom_payer_id: The unique identifier used in your system to track and identify the payer.
PaymentRefund
Refer to the response parameter description of Get refund order informationPaymentSettlement
Refer to the response parameter description of Get settlement request informationFeel free to share your feedback to improve our documentation!