Webhook details

The merchant provides a webhook callback address. When the user status or order status changes, OSL Pay will call the address provided by the merchant and push the current status information of the user or order.

Webhook signature verification

When we send a webhook, the request header structure is consistent with the request header format in openapi, including appId, timestamp, and signature. You can verify the signature. When verifying the signature, you need to use the webhook public key, which is provided when you obtain the production account.

Request input parameters (header)

Parameter	Type	Mandatory	Description
appId	String	Y	appId, provided by OSL Pay
timestamp	Long	Y	Timestamp of access request
signature	String	Y	Signature

Webhook content

All webhooks will be pushed according to the following standard structure, where the data content will vary depending on the scenario.

Webhook content

Parameter	Type	Mandatory	Description
type	String	Y	Webhook types User type enumeration: kyc_status_change defi_account_bind_status Order type enumeration: order_status_change
data	Object	Y	Detailed data