This API allows you to push global payment order notifications to a specified webhook.
Endpoint Information
Request Method: POST
Request Path: (Specify the appropriate path for your webhook notifications)
Request Body Parameters
The request body should include the following fields:
{
"webhookId": "ebab8a9663704e7cbbebe672c7c67912", // (string: ID of the webhook)
"eventType": "GLOBAL_PAYMENT_WEBHOOK", // (string: event type [GLOBAL_PAYMENT_WEBHOOK])
"orderId": "473130522693193728", // (string: ID of the order)
"clientId": "W658784738723", // (string: ID of the client)
"userId": "455472", // (string: ID of the user)
"onRampCountry": "Mexico", // (string: name of the on-ramp country)
"onRampMerchantId": 3, // (number: ID of the on-ramp merchant id)
"onRampFiat": "MXN", // (string: name of the on-ramp fiat currency)
"onRampFiatAmount": "100.00", // (decimal: amount of on-ramp fiat currency)
"onRampFiatFee": "0", // (decimal: amount of on-ramp fiat fee)
"offRampCountry": "Hong Kong", // (string: name of the off-ramp country)
"offRampMerchantId": 4, // (number: ID of the off-ramp merchant id)
"offRampFiat": "USD", // (string: name of the off-ramp fiat currency)
"offRampFiatAmount": "18.00", // (decimal: amount of off-ramp fiat currency)
"offRampFiatFee": "2.00", // (decimal: amount of off-ramp fiat fee)
"orderPrice": "20.00", // (decimal: price of the order)
"orderStatus": "41", // (string: order status [10, 30, 31, 41, 51, 60, 71, 72])
"createTime": "1735279907000", // (string: timestamp of the create time in milliseconds)
"updateTime": "1735280582000" // (string: timestamp of the update time in milliseconds)
}
Response Structure
The response will include the following fields:
{
"callbackStatus": "SUCCESS" // (string: callback status, indicates if the message was successfully notified)
}
