Common
Balance
Institution
Payment
OTC
Convert
Payout
Gift Card
Subscription
curl --request POST \
--url https://openplatform.gateapi.io/payment/open/institution/v1/pay/transactions/native \
--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": "118223456797",
"env": {
"terminalType": "APP"
},
"goods": {
"goodsName": "NF2T",
"goodsDetail": "nef-book"
}
}
'{
"status": "SUCCESS",
"code": "0",
"errorMessage": "",
"data": {
"prepayId": "50913213697495040",
"terminalType": "APP",
"expireTime": 1674100394000,
"qrContent": "http://openplatform.gate.io/qr/AjQHJ56mDQ26dtx5ftspl9usV9tlIA8iom35toXhX7Y=",
"location": "https://114.55.238.130:13555/webpay?prepayid=50913213697495040"
}
}Create QR Payment Order
Create a Web payment prepay order and return the prepay ID, QR content and Web payment component redirect URL.
curl --request POST \
--url https://openplatform.gateapi.io/payment/open/institution/v1/pay/transactions/native \
--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": "118223456797",
"env": {
"terminalType": "APP"
},
"goods": {
"goodsName": "NF2T",
"goodsDetail": "nef-book"
}
}
'{
"status": "SUCCESS",
"code": "0",
"errorMessage": "",
"data": {
"prepayId": "50913213697495040",
"terminalType": "APP",
"expireTime": 1674100394000,
"qrContent": "http://openplatform.gate.io/qr/AjQHJ56mDQ26dtx5ftspl9usV9tlIA8iom35toXhX7Y=",
"location": "https://114.55.238.130:13555/webpay?prepayid=50913213697495040"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.gate.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
This page documents thePOST /payment/open/institution/v1/pay/transactions/native endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.
Notes
- Authentication uses the standard GatePay signed headers.
- This page documents the standard merchant endpoint.
qrContentreturns the content URL used to generate the QR code image, not a pre-rendered QR image itself.- For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.
Headers
Merchant client ID, obtained from GatePay platform
"4186d0c6-6a35-55a9-8dc6-5312769dbff8"
HMAC-SHA256 signature for request validation
"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"
Timestamp in milliseconds, must be within 5 minutes of server time
"1672905655498"
Random nonce for replay attack prevention
"3525756760"
Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.
Body
Request body for creating a Web payment prepay order.
Merchant order number, up to 32 bytes.
Transaction source information.
Show child attributes
Show child attributes
Goods information.
Show child attributes
Show child attributes
Order currency, uppercase, such as USDT, BTC, etc.
Order amount, ranging from [0.0001, 500000].
Fiat order currency in uppercase, such as EUR, GBP, USD, CNY, JPY, AUD, CAD, CHF.
Fiat order amount. Minimum 0.01 with maximum precision of 2 decimal places.
The actual currency requested by the merchant for settlement. Use this field to specify the actual incoming currency if the settlement currency requested by the merchant is different from the order currency.
Order expiration time, UTC timestamp in milliseconds. If not set, it defaults to 1 hour, with a maximum expiration time of 1 hour.
The return URL for the order after successful payment, up to 256 characters long.
The return URL for the order after payment failure, up to 256 characters long.
Client name.