Skip to main content
POST
/
payment
/
open
/
institution
/
v1
/
pay
/
address
/
create
Create address payment order
curl --request POST \
  --url https://openplatform.gateapi.io/payment/open/institution/v1/pay/address/create \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "merchantTradeNo": "93840202212210025",
  "env": {
    "terminalType": "MINIAPP"
  },
  "goods": {
    "goodsName": "USDT_PAY_BTC_TEST",
    "goodsDetail": "yc"
  },
  "orderExpireTime": 1673410179000,
  "merchantUserId": 1336974,
  "chain": "BSC",
  "fullCurrType": "BTC_BSC"
}
'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "prepayId": "47656656276819968",
    "terminalType": "MINIAPP",
    "expireTime": "1673410179000",
    "chain": {
      "chain_type": "BSC",
      "fullCurrType": "USDT_BSC",
      "address": "0x1699dB45Dc502A0395038265fCBC4Fa05d6afFBD"
    }
  }
}
API description: Create an address order.

Headers

​
X-GatePay-Certificate-ClientId
string
required

The clientId assigned when the merchant registers an application in the Gate merchant console.

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

​
X-GatePay-Timestamp
string
required

UTC timestamp in milliseconds when the request is generated. GatePay will not process requests where the difference from the receive time exceeds 10 seconds.

Example:

"1672905655498"

​
X-GatePay-Nonce
string
required

Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.

Example:

"9578"

​
X-GatePay-Signature
string
required

Request signature. GatePay uses this signature to verify whether the request is valid.

​
X-GatePay-On-Behalf-Of
string
required

The institution account id being acted on behalf of (sub-account ID).

Example:

"2124538349"

Body

application/json
​
merchantTradeNo
string
required

Merchant transaction ID.

​
env
object
required

Transaction source: APP, WEB, WAP, MINIAPP, OTHERS.

​
goods
object
required

Goods.

​
orderExpireTime
integer<int64>
required

Order expiry timestamp, milliseconds.

​
merchantUserId
integer<int64>
required

Payer's unique ID on the merchant platform.

​
chain
string
required

Chain name.

​
fullCurrType
string
required

Currency field including chain name.

​
currency
string

Order currency.

​
orderAmount
string

Order amount.

​
surchargeAmount
string

Surcharge borne by the consumer.

​
toleranceAmount
string

Tolerance amount for auto-complete.

​
fiatCurrency
string

Fiat currency.

​
fiatAmount
string

Fiat order amount.

​
payCurrency
string

User-selected payment currency; omit for non-convert orders.

​
returnUrl
string

Callback URL after payment.

​
cancelUrl
string

Callback URL after cancel.

​
channelId
string

Client/channel name.

Response

200 - application/json

Success

​
status
string
​
code
string
​
errorMessage
string
​
data
object