メインコンテンツまでスキップ

Webhook

You can set an Webhook URL on the gateway GUI interface. When there is an event, the gateway will notify the event to the Webhook URL. A typical example of a webhook is an event notification when the payment status of an order changes.

picture 1

whenever a order status change, a GET request will be sent to the webhook URL, with below parameters.

nametypedesc
typestringevent type
instancestringthe merchant_order_id
codestringevent code
messagestring
signaturestringsignature result

Please find below a sample request data

{
"type": "Order",
"instance": "1623817182537",
"code": "StatusChange",
"message": "Order Paid",
"signature": "944EFC0C6DB000A28C7BACEC6709AF119586F4E361F908DEAC576DA937A6F746"
}

Note the signature is used for you to validate the web hook is actually come from the Payment Gateway or not. you should validate the signature using the same algorithm as other API call.