Webhook Data Model

Webhook requests will always contain 4 main key-value pairs:

KeyValue
totalAmountTotal amount of the payment including all installments
statusReports the current status of the payment, can take the values of ‘created’, ‘authorized’,’charged’, ‘refunded’ or ‘expired’. The list of statuses may change in the future, so it is not advised to hardcode the set of values to expect.
orderTokenThe Scalapay reference that is generated at the time of creation of the order.
merchantReferenceThe correlation id from the merchant, typically the order id

Other keys/objects:
Depending on the status, you might receive more keys-value pairs than these (e.g. in ‘created’ and ‘refunded’) Examples