Create payment order and obtain checkout URLs

post

https://acquirersandbox.rp-2023app.com/openapi/v2/order/create

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.

Body Params

create payment request

outerOrder

string

^[a-zA-Z0-9_\-|*]+$

deprecated

Merchant's external order identifier (outerOrder).

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

outerOrderSn

string

required

^[a-zA-Z0-9_\-|*]+$

Merchant's external order identifier (outerOrderSn).

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

outerUid

string

required

Merchant's external user id (outerUid).

Max length: 32 characters.

orderAmount

number

required

Order total amount in fiat.

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

orderCurrency

string

required

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

timeExpire

int64

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

env

string

required

Payment environment. One of:

rateExtra

number

0 to 1

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

orderDesc

string

required

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

goods

array of objects

required

length between 1 and 10

product list ;the size must be between 1 and 10

goods*

product list ;the size must be between 1 and 10

goodsType

string

required

product type:01-tangible goods；02-virtual goods

goodsCategory

string

required

product goods category:

0000: Electronics and Computers
1000: Books, Music and Movies
2000: Home, Garden and Tools
3000: Clothing, Shoes and Bags
4000: Toys, Kids and Babies
5000: Automotive and Accessories
6000: Games and Top-ups
7000: Entertainment and Collectibles
8000: Jewelry
9000: Housekeeping Services
A000: Beauty and Personal Care
B000: Pharmacy
C000: Sports and Outdoors
D000: Food, Groceries and Health Products
E000: Pet Supplies
F000: Industrial and Scientific
Z000: Others

goodsCode

string

required

product goods code;the text must be under 20 characters

goodsName

string

required

product goods name;the text must be under 32 characters

goodsCount

int32

required

1 to 100000

product goods count;the value must be between 1 and 100000

goodsAmount

number

required

0 to 10000

product goods amount;goods amount with maximum 5 integer digits and 2 decimal places

goodsCoin

string

required

product goods coin

buyer

object

payment buyer information

redirectUrl

string

^[^,\s]+$

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

deeplink

string

^[^,\s]+$

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

length ≤ 32

^$|^[a-zA-Z0-9_\-|*]+$

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.

200OK

400request param invalid or format error

401JWT has expired or JWT is illegal

403request ip not in the white list

429exceed api frequest frequency limit