Create payment order and obtain checkout URLs

Create a payment order and return checkout URLs / deep links for supported channels (WEB, H5, APP). The response contains redirect URLs and the list of available payment methods. Redirect the payer to the returned URL to complete the transaction.

For PSP merchants only, the optional request field subMerchantCode may be provided to tag the order with a sub-merchant business code. Non-PSP merchants sending a non-empty subMerchantCode will be rejected (subMerchantNotAllowed). Blank / omitted is allowed for all merchants.

Sandbox

This API works in sandbox; you still must complete payment on the sandbox checkout after creating an order. See Testing Payments in the Sandbox.

Header Parameters

X-R-Ts*string

request timestamp in milliseconds

X-R-Ak*string

merchant's appKey

X-R-Signature*string

request signature

X-R-Key-Version?string

merchant's private key version, default is 1

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

create payment request

outerOrder?string

Deprecated

Merchant's external order identifier (outerOrder).

Length: 6..32 characters.
Allowed characters: letters, numbers and _ - | *

outerOrderSn*string

Merchant's external order identifier (outerOrderSn).

Length: 6..32 characters.
Allowed characters: letters, numbers and _ - | *

outerUid*string

Merchant's external user id (outerUid).

Max length: 32 characters.

orderAmount*number

Order total amount in fiat.

Precision: up to 12 integer digits and 6 decimal places.

orderCurrency*string

Order fiat currency, compliant with ISO 4217 (e.g., "USD").

timeExpire?integer

payment expire time in milliseconds, 1 hour from the current time by default.

env*string

Payment environment. One of:

rateExtra?number

Merchant exchange rate markup;extra rate with maximum 1 integer digits and 6 decimal places

orderDesc*string

order's description;The text must be under 127 characters

goods?array<>

Deprecated

product list ;the size must be between 1 and 10

buyer?

payment buyer information

redirectUrl?string

The URL to redirect to after a payment via web version;comma、space are not supported

deeplink?string

Required when the environment of payment(field env)is H5/APP.The URL to redirect to after a payment via APP/H5 ;comma、space are not supported

merchantName?string

The name of the receiving merchant, used to display the name on PayLink and Dapp PayTo.

subMerchantCode?string

Optional PSP sub-merchant business code (not a separate merchant account).

Only PSP merchants may send a non-empty value; non-PSP merchants will be rejected (subMerchantNotAllowed).
Max length: 32 characters.
Allowed characters: letters, numbers and _ - | *
Blank or omitted is treated as not provided.
Not accepted on close / refund / order query request bodies; echoed on create / query / webhook responses when present.

Response Body

`/`

`application/json`

curl -X POST "https://example.com/openapi/v2/order/create" \  -H "X-R-Ts: 1762327084929" \  -H "X-R-Ak: string" \  -H "X-R-Signature: string" \  -H "Content-Type: application/json" \  -d '{    "outerOrderSn": "ORD20260101001",    "outerUid": "user-5001",    "orderAmount": 120,    "discountAmount": 0,    "orderCurrency": "USD",    "timeExpire": 1704070800000,    "env": "H5",    "rateExtra": 0.0025,    "orderDesc": "Electronic accessories",    "goods": [      {        "goodsType": "01",        "goodsCategory": "0000",        "goodsCode": "SKU-ACC-001",        "goodsName": "Wireless Charger",        "goodsCount": 1,        "goodsAmount": 120,        "goodsCoin": "BTC"      }    ],    "buyer": {      "email": "buyer@example.com",      "country": "US"    },    "redirectUrl": "https://merchant.example.com/checkout/return",    "deeplink": "merchantapp://checkout/result",    "merchantName": "Redot Pay Connect",    "subMerchantCode": "STORE_A"  }'

"open api common response"

{  "code": "paramFormatError",  "message": "request param invalid"}

{  "code": "authorizationInvalid",  "message": "authorizationInvalid invalid"}

{  "code": "notInWhiteList",  "message": "request ip not in the white list"}

{  "code": "frequencyLimited",  "message": "Too many requests, please try again later"}

Create payment order and obtain checkout URLs

Header Parameters

Request Body

Response Body

200*/*

400application/json

401application/json

403application/json

429application/json

`/`

`application/json`

`application/json`

`application/json`

`application/json`