5. Create Order
- Introduction: This interface mainly provides to create order requests. We support selecting a single payment method for placing an order, as well as placing an order without specifying a payment method. If you choose a single payment method, we will directly jump to a specific payment page to place an order; if you do not specify a payment method, we will display our own cashier(Multiple Payment Methods) to the user to place an order.
- Endpoint: /v1/order/create-order
- Method: POST
- Request
| Field Name | Type | Required | Description |
|---|---|---|---|
| fiatCurrency | String | Y | Fiat currency |
| cryptoCurrency | String | Y | Cryptocurrency |
| baseCurrency | String | N | Base currency |
| fiatAmt | String | N | Amount in fiat currency (mandatory for BUY/BUY_TO_WALLET) |
| cryptoAmt | String | N | Amount in cryptocurrency (mandatory for SELL) |
| paymentMethod | String | N | Payment method, refer to enum type definitions. When paymentMethod is empty or ALL, a cashier page will be displayed for the user to choose available payment methods. When paymentMethod is specified, a trading page for the specific payment method will be displayed. |
| side | String | Y | Transaction type, refer to enum type definitions |
| merchantUserId | String | Y | Unique identifier of the user on the merchant's platform |
| merchantOrderNo | String | N | Unique identifier of the order on the merchant's platform |
| walletNetwork | String | N | The network of the user's wallet address, mandatory for BUY_TO_WALLET/BANK_TRANSFER |
| walletAddress | String | N | The user's wallet address, mandatory for BUY_TO_WALLET/BANK_TRANSFER |
| walletMemo | String | N | The user's wallet memo |
| clientType | String | Y | Client type, refer to enum type definitions |
| clientIp | String | N | Client IP |
| clientLang | String | N | client language (country code in 2 letters) |
| clientMode | String | N | client mode: dark or white |
| redirectUrl | String | Y | URL to redirect back to the merchant's site after order completion |
| clientVersion | String | Y | Used to control the compatibility of mini program versions |
| merchantRemark | String | N | merchant remark (max length:64) |
- Response
| Field Name | Type | Description |
|---|---|---|
| orderId | String | Unique identifier of the order in Paymonade system |
| tranId | String | Transaction ID, corresponding to orderId |
| redirectUrl | String | URL to Paymonade's H5 page |
| redirectClientType | Enum | The client type of Paymonade, MINI or H5 |
| redirectClientId | String | The appId of Paymonade mini program |
| queryString | String | The query string of Paymonade mini program |
| startPagePath | String | The start page path of Paymonade mini program |
Note:
When the payment method is of type BANK_TRANSFER, the parameter orderId returned by the API can be ignored.Response Example:
{
"status": 200,
"msg": "OK",
"data": {
"orderId": "buy202218839330",
"checkoutUrl": "https://13.39.202.125/login?tranId=61374548144164864&tranType=buy&cTag=0&redirectUrl=https://www.merchant.com/order/result/3454354343535"
},
"traceId": "77ec4eeb-86ea-42e3-97f2-e5ff1c81e7fc"
}