Notification parameter

For transactions generated by API payment, EPAY will notify the merchant system of the payment result as a parameter in the form of POST request according to the asynchronous notification address notifyUrl passed in the API.

Callback status

Code Merchant status Description
5 Cancel order cancellation
6 Fail order failure
7 Success order successful
8 Close order closed
20 No refund of handling fee Final status, no refund of fees for failure

Callback description

Data format: The current version uses the x-www-form-urlencoded callback.

During callback, the merchant needs to return "success". When Epay receives this information, it stops callback. By default, it retries 16 times for order number callback (10s 30s 1m 2m 3m 4m 5m 6m 7m 8m 9m 10m 20m 30m 1h 2h).

If there is a problem, you can contact EPay to call back the push status, or the merchant can actively query the order status data.

name type required desc example
epayAccount string YES Merchant account test2020@epay.com
merchantOrderNo string YES Merchant order number 211151436637284296077312
epayOrderNo string YES Epay order number 210911037
pinCode string NO withdrawal code 11021
amount string YES Order Amount 11.00
paymentAmount string YES Payment Amount 11.00
receiveAmount string YES Receivement Amount 70.65
settlementCurrency string YES Settlement currency USD
paymentCurrency string YES Currency of payment USD
receiveCurrency string YES Currency of receivement CNY
fee string YES fee 5.11
rate string YES exchange rate 0.155701
status string YES Order status 7
accountNo string NO Electronic currency payin account addd11245
payerAccount string NO Counterparty EPay account payer@epay.com
remark string NO Remark dd
extendFields string NO Extended field {\"test\":\"test\"}
timestamp string YES yyyy-MM-dd HH:mm:ss Finished time 2022-11-03 07:30:02
version string YES Version number V2.0.0
code string YES return code 1
message string NO Message info success
sign string YES Signature

Callback example

CurrentVersion 
curl --location --request POST 'http://{{ notify_url}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'epayAccount=test2020@epay.com' \
--data-urlencode 'epayOrderNo=211151436637284296077312' \
--data-urlencode 'merchantOrderNo=V1.0.0' \
--data-urlencode 'pinCode=1245' \
--data-urlencode 'bankAccount=sssswsa5451'
--data-urlencode 'amount=11.00'
--data-urlencode 'paymentAmount=11.00'
--data-urlencode 'receiveAmount=70.65'
--data-urlencode 'settlementCurrency=USD'
--data-urlencode 'paymentCurrency=USD'
--data-urlencode 'receiveCurrency=CNY'
--data-urlencode 'fee=5.11'
--data-urlencode 'rate=0.155701'
--data-urlencode 'status=7'
--data-urlencode 'timestamp=2109-11-03 07:30:02'
--data-urlencode 'code=1'
--data-urlencode 'message=success'
--data-urlencode 'version=V2.0.0'
--data-urlencode 'sign=29F424B1995A3163CF5428DAACD1F8FB59890878298C6845FF88DA05D03D4F68'

CurrentVersion

curl --location --request POST 'http://{{ notify_url}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'epayAccount=test2020@epay.com' \
--data-urlencode 'epayOrderNo=211151436637284296077312' \
--data-urlencode 'merchantOrderNo=V1.0.0' \
--data-urlencode 'pinCode=1245' \
--data-urlencode 'bankAccount=sssswsa5451'
--data-urlencode 'amount=11.00'
--data-urlencode 'paymentAmount=11.00'
--data-urlencode 'receiveAmount=70.65'
--data-urlencode 'settlementCurrency=USD'
--data-urlencode 'paymentCurrency=USD'
--data-urlencode 'receiveCurrency=CNY'
--data-urlencode 'fee=5.11'
--data-urlencode 'rate=0.155701'
--data-urlencode 'status=7'
--data-urlencode 'timestamp=2109-11-03 07:30:02'
--data-urlencode 'code=1'
--data-urlencode 'message=success'
--data-urlencode 'version=V2.0.0'
--data-urlencode 'sign=29F424B1995A3163CF5428DAACD1F8FB59890878298C6845FF88DA05D03D4F68'

results matching ""

    No results matching ""