Skip to main content

Webhook

After a payment is processed, or status is changed, you will receive a callback (webhook) containing detailed information about the transaction. It is essential to validate the signature included in the callback to ensure the data's authenticity and integrity. (please refer to the Webhook validation section)

Once the signature is verified, you should synchronize the payment status on your side accordingly.

Below is a detailed list of parameters that may be included in the callback payload:

Field NameTypeRequiredDescription
merchant_idstringYesMerchant ID provided by Cashier Technical Support team and used in payment create request
application_keystringYesApplication Key provided by Cashier Technical Support team and used in payment create request
conversion_ratefloatYesConversion rate between currency and processed currency used during amount conversion
customerObjectYesPlease refer to Customer object description
sessionObjectYesPlease refer to Session object description
transactionObjectNoPlease refer to Transaction object description
versionstringYesAPI version, for now only 1.3 is available
timestampintYesUnix timestamp (Epoch time): Number of seconds (or milliseconds) since January 1, 1970 (UTC). Example: 1716735600