Webhook fields are:
Field | Type | Description |
---|---|---|
attempt_number | number | Delivery attempt number |
event | object | Event data |
id | string | uuid of webhook event |
scheduled_for | hash | Delivery schedule time |
Available webhook events are:
Event | Description |
---|---|
charge:created | A new charge has been initiated. |
charge:pending | The charge has been posted to the blockchain and funds are received by the merchant. |
charge:confirmed | The charge has been fully confirmed, and the payment is considered finalized. |
charge:failed | The charge could not be completed. |
What is considered a valid payment?
There are two ways a merchant can determine if a charge has been paid in full:
type
field contains a charge:pending
value.timeline
array contains a status
object with a status": "PENDING"
value.To learn more about the difference between PENDING and CONFIRMED, please reference Payment Status
Example of a webhook payload:
See Also: