API Reference

Create Payment Order

post
https://{environment}/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.



Body Params

create payment request

string
deprecated

Merchant's external order identifier (outerOrder).

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

Merchant's external order identifier (outerOrderSn).

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

Merchant's external user id (outerUid).

  • Max length: 32 characters.
number
required

Order total amount in fiat.

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

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

int64

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

string
required

Payment environment. One of:

  • H5
  • WEB
  • APP
number
0 to 1

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

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

string
required

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

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
string
required

product goods code;the text must be under 20 characters

string
required

product goods name;the text must be under 32 characters

int32
required
1 to 100000

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

number
required
0 to 10000

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

string
required

product goods coin

buyer
object

payment buyer information

string

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

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

string

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

Headers
string
required

request timestamp in milliseconds

string
required

merchant's appKey

string
required

request signature

string

merchant's private key version, default is 1

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated 4 months ago