Parameters
Merchant Order No (merchantOrderNo)
Merchant Order No is generated by the merchant, it supports only the combination of alphanumeric characters, dashes(-), and underscores(_). BonusPay requires the merchant order number to be unique (it is recommended to generate order numbers based on the current system time plus random sequence). When making a new payment, use the original order number to avoid duplicate payments; order numbers that have already been paid or canceled (see the following API list) cannot be paid again.
Field Type Description
WithdrawOrder
Merchant Order No
merchantOrderNo
Required
String(64)
S10000
BonusPay Order No
orderNo
Required
String(32)
O1000
Order Status
status
Required
WithdrawOrderStatus
-
Expected Amount
expectedReceivedAmount
Optional(when refAmount is exist)
Money
"totalAmount":{ "currency":"ETH", "amount":1.01 }
The total amount of the order
Reference Amount
refAmount
Optional
"refAmount":{ "exchangeCurrencyCode":"[Order Currency]", "refAmount":{ "amount":[Original amount], "currency":"[Original Currency]" } }
"refAmount":{ "exchangeCurrencyCode":"USDT", "refAmount":{ "amount":100000, "currency":"INR" } }
The refAmount will convert to exchangeCurrency and amount to be the total amount of orders,eg: send 10000 INR and convert to USDT to accecpt
Actual Amount
actualReceivedAmount
Optional
Money
Fee
partnerFee
Optional
Money
TX Hash
txid
Optional
String(200)
Created Time
createdTime
Required
Timestamp(3)
1581493898000
Callback URL
notifyUrl
Required
String(200)
-
Withdrawal Address
address
Required
String(200)
-
Error Description
failDes
Optional
String(200)
-
The reason for the failed order
Network
network
Required
String(200)
-
Money
Amount
amount
Required
Decimal(12,8)
123.45
Currency
currency
Required
String(32)
BUSD
WithdrawNetwork
Network
network
Required
String(200)
-
Name
name
Required
String(200)
-
Address Regex
addressRegex
Required
String(200)
-
Precision
digit
Required
Integer
-
Min Amount
withdrawMin
Required
Decimal(12,8)
-
Max Amount
withdrawMax
Required
Decimal(12,8)
-
Fee
partnerFee
Required
Decimal(12,8)
-
ResponseHeader
Request Status
applyStatus
Required
String(16)
SUCCESS
SUCCESS-successful application FAIL-application failed ERROR-application exception
Return Code
code
Required
String(10)
0
Return code
Return Message
msg
Last updated