This event is triggered whenever a checkout has its status changed.
Payload (object)
- id (string)
- buyerEmail (string) The buyer's email this sale is to
- alias (string) An easily identifiable name for this checkout, something descriptive
- description (string) A custom description for this sale
- referenceId (string) External Sale Reference Id
- amount (object)
- value (number) - The amount to be paid in float point
- currency (string) - 3 letters ISO code for currency
- formattedValue (string) - The formatted value, e.g: $10.00
- digits (number) - The amount of decimal places this currency has
- wholeValue (number)
An integer value for the least significant value for this currency, eg.: $10.00 would be 1000. It can be thought as how many cents for this operation
- status (string)
- FAILED
- PAID
- PENDING
- UNKNOWN
- expiresAt (date) - The date this checkout will not be able for payment anymore
- auditInfo (object)
- createdBy (string) - User who created this record
- updatedBy (string) - User who updated this record
- updatedAt (Date) - Last update date
- createdAt (Date) - Date of creation
- lastSucceededAt (Date) - The last date a payment attempt has succeeded
- lastErroredAt (Date) - The last date a payment attempt has errored
- links (object)
- embeddable (string) - The iframe embeddable url to render the payment form
{
id: 'string',
buyerEmail: 'string',
alias: 'string',
description: 'string',
referenceId: 'string',
amount: {
value: number,
currency: 'string',
formattedValue: 'string',
digits: number,
wholeValue: number,
},
status: 'string',
expiresAt: Date,
auditInfo: {
createdBy: 'string',
updatedBy: 'string',
updatedAt: Date,
createdAt: Date,
},
lastSucceededAt: Date,
lastErroredAt: Date,
links: {
embeddable: 'string',
}
}