​
Callback API

Notify the caller when the order status changes using the provided callback_url, details for Create payment order callback_url param

​
Callback event

Callback Event Name (event_name)Callback Event Type (event_type)Description
orderexpiredOrder Timeout Notification
orderpaidPayment Completed Notification

​
Request method

  • Method: HTTP POST
  • Content-Type: application/json
  • If the response is the string “success”, the callback is successful; otherwise, it fails.

​
Request parameters

NameTypeDescription
event_namestringEvent name
event_typestringEvent type
dataJSONStringOrder information
pidinteger(int64)Project ID
noncestring6 random string
timestampinteger(int64)Timestamp
signstringSignature

​
data Object

NameTypeDescription
cregis_idstringCregis unique id
order_idstringMerchant’s custom unique order ID
receive_amountstringThe amount of the order after exchange rate conversion
receive_currencystringThe order currency code after exchange rate conversion
pay_amountstringActual Received Amount
pay_currencystringReceived currency
order_amountstringOrder transaction amount, defined by the merchant
order_currencystringOrder currency code, i.e. ISO 4217 currency code, such as CNY, HKD, defined by the merchant
exchange_ratestringExchange rate
payment_addressstringPayment wallet address
created_timeinteger(int64)Order creation timestamp in 13-digit
cancel_timeinteger(int64)Order expiration cancel timestamp in 13-digit
transact_timeinteger(int64)Order transaction timestamp in 13-digit
valid_timeintegerTo determine the order expiration time , if not specified, the order expiration time will be 30 minutes as default. Please input in minutes. Minimum is 10 minutes
statusstringOrder Status:
new - Initial status of the order
paid - The order has been successfully paid
expired - The order has exceeded the valid time
paid_over - Payment exceeds the order amount
paid_partial - Payment is less than the order amount
remarkstringRemarks
tx_idstringTransaction hash
payer_idstringPayer unique ID. No more than 32 characters
payer_namestringPayer’s name. No more than 32 characters
payer_emailstringPayer email
Request Example
{
    "event_name": "order",
    "event_type": "paid",
    "data": {
        "cregis_id": "po20240703132452000",
        "order_id": "c9231e604da54469a735af3f449c880f",
        "receive_amount": "12.86",
        "receive_currency": "USDT",
        "pay_amount": "12.86",
        "pay_currency": "USDT",
        "order_amount": "100",
        "order_currency": "HKD",
        "exchange_rate": "0.1286",
        "payment_address": "0xd38c2cf366a731dcbe4a32c7ef24ff96d080ca7e",
        "created_time": 1719993183015,
        "cancel_time": null,
        "transact_time": 1719993183325,
        "valid_time": 30,
        "status": "paid",
        "payer_id": "p_001",
        "payer_name": "",
        "payer_email": "[email protected]"
        "remark":"remark",
        "tx_id": "0x0502f2bfd96cd0f55edea3343513940f3af7fe594eae77f08d2f46ea24829b11"
    }
}