Create Order (Deprecated)
The API is deprecated, please migrate to Create Order V2 ASAP,
Create order API used for merchant/partner to initiate acquiring order.
#
EndPoint#
Request ParametersAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
subMerchantId | string | N | maximum length 19 | The sub merchant account id, issued when sub merchant been created at Binance, The parameter subMerchantId is required when configuring show subMerchant info. |
merchantTradeNo | string | Y | letter or digit, no other symbol allowed, maximum length 32 | The order id, Unique identifier for the request |
tradeType | string | Y | "WEB", "APP", "WAP", "MINI_PROGRAM", "PAYMENT_LINK", "OTHERS" | operate entrance |
totalFee | decimal | Y | Amount Range: 0.01 - 20000; Max Unit Range: 8 decimal places | order amount |
currency | string | Y | only "BUSD","USDT","MBOX" can be accepted, fiat NOT supported. | order currency |
productType | string | N | maximum length 16 | product type |
productName | string | N | maximum length 256 | product name |
productDetail | string | N | maximum length 256 | product detail |
returnUrl | string | N | maximum length 256 | The URL to redirect to when the payment is successful |
cancelUrl | string | N | maximum length 256 | The URL to redirect to when payment is failed |
orderExpireTime | long | N | maximum order time is 1 hour | OrderExpireTime is the time at which order will expire. Please input orderExpireTime in Epoch timestamp in milliseconds. If not specified, order time will be 1 hour |
supportPayCurrency | string | N | maximum length 1024. Input to be separated by commas, e.g. "BUSD,BNB" | SupportPayCurrency determines the currencies that a customer is allowed to use to pay for the order. If not specified, all Binance Pay supported currencies will be allowed. |
universalUrlAttach | string | N | maximum length 120. e.g. "countryCode=1&phone=1234567" | the attachment parameter for the response field "universalUrl" |
#
Sample Request Body#
Response ParametersAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
status | string | Y | "SUCCESS" or "FAIL" | status of the API request |
code | string | Y | - | request result code, refer to |
data | OrderResult | N | - | response body, refer to |
errorMessage | string | N | maximum length 256 |
#
Child Attribute#
OrderResultAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
prepayId | string | Y | maximum length 19 | unique id generated by binance |
tradeType | string | Y | "WEB", "APP", "WAP", "MINI_PROGRAM", "PAYMENT_LINK", "OTHERS" | operate entrance |
expireTime | long | Y | - | expire time in milli seconds |
qrcodeLink | string | Y | maximum length 256 | qr code img link |
qrContent | string | Y | maximum length 256 | qr contend info |
checkoutUrl | string | Y | maximum length 256 | binance hosted checkout page url |
deeplink | string | Y | maximum length 256 | deeplink to open binance app to finish payment |
universalUrl | string | Y | maximum length 512 | universal url to finish the payment |
#
Sample Response#
Result CodeName | Code | Reason | Solution |
---|---|---|---|
UNKNOWN_ERROR | 400000 | An unknown error occurred while processing the request. | Try again later |
INVALID_REQUEST | 400001 | Parameter format is wrong or parameter transferring doesn't follow the rules. | Please check whether the parameters are correct. |
INVALID_SIGNATURE | 400002 | Incorrect signature result | Check whether the signature parameter and method comply with signature algorithm requirements. |
INVALID_TIMESTAMP | 400003 | Timestamp for this request is outside of the time window. | Sync server clock |
INVALID_API_KEY_OR_IP | 400004 | API identity key not found or invalid. | Check API identity key |
BAD_API_KEY_FMT | 400005 | API identity key format invalid. | Check API identity key. |
BAD_HTTP_METHOD | 400006 | Request method not supported. | Check Request method. |
MEDIA_TYPE_NOT_SUPPORTED | 400007 | Media type not supported. | Check Request Media type. |
INVALID_REQUEST_BODY | 400008 | Request body is not a valid json object. | Check Request body |
MANDATORY_PARAM_EMPTY_OR_MALFORMED | 400100 | A parameter was missing/empty/null, or malformed. | |
INVALID_PARAM_WRONG_LENGTH | 400101 | A parameter was not valid, was empty/null, or too long/short, or wrong format. | |
INVALID_PARAM_WRONG_VALUE | 400102 | A parameter was not valid, the value is out of range. | |
INVALID_PARAM_ILLEGAL_CHAR | 400103 | A parameter was not valid, contains illegal characters | |
INVALID_REQUEST_TOO_LARGE | 400104 | Invalid request, content length too large | |
INVALID_MERCHANT_TRADE_NO | 400201 | merchantTradeNo is invalid or duplicated | |
INVALID_ACCOUNT_STATUS | 400203 | Not support for this account, please check account status. | |
SUB_MERCHANT_INVALID | 400206 | The sub merchant does not exist or is in an unavailable state. |