v1

latestOpenAPI 3.1.0MIT2026-07-2152556.1 KB

Place Checkout Order

Place an order at the cashier. Returns prepay ID, payment URL, QR content, and chain/address information for the consumer to complete payment.

post/v1/pay/checkout/order

Headers

X-GatePay-Certificate-ClientIdstring required

Example:4186d0c6-6a35-55a9-8dc6-5312769dbff8

Merchant client ID, obtained from GatePay platform

X-GatePay-Signaturestring required

Example:672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77

HMAC-SHA256 signature for request validation

X-GatePay-Timestampstring required

Example:1672905655498

Timestamp in milliseconds, must not differ from server time by more than 5 minutes

X-GatePay-Noncestring required

Example:9578

Random nonce for replay attack prevention

Request body

merchantTradeNostring required

Merchant order number, must be unique

currencystring

Crypto currency in uppercase, e.g. USDT, BTC

orderAmountstring

Crypto order amount, max precision 6 digits

surchargeAmountstring

Surcharge, a fee borne by the consumer

toleranceAmountstring

Tolerance amount

fiatCurrencystring

Fiat currency in uppercase

fiatAmountstring

Fiat order amount, max precision 2 digits

payCurrencystring

Payment currency for address payment

orderExpireTimeinteger

Order expiration time in milliseconds

returnUrlstring uri

Return URL after successful payment

cancelUrlstring uri

Return URL after failed payment

merchantUserIdinteger required

Unique consumer ID from merchant's platform

chainstring required

Selected chain name

fullCurrTypestring required

Currency field containing chain name

channelIdstring

Client name

actualCurrencystring

Actual settlement currency

payAmountstring

Payment amount

addressstring

Blockchain address

Example request

{
  "merchantTradeNo": "163",
  "currency": "USDT",
  "orderAmount": "118.75",
  "surchargeAmount": "0",
  "fiatCurrency": "USD",
  "fiatAmount": "100",
  "payCurrency": "USDT",
  "env": {
    "terminalType": "APP"
  },
  "goods": {
    "goodsName": "Sipariş Ödemesi - 177",
    "goodsDetail": "Sipariş No : 160"
  },
  "orderExpireTime": 1677573665219,
  "returnUrl": "https://lotkeys.com/tr/gate-payment-response",
  "cancelUrl": "https://lotkeys.com/tr/gate-payment-response",
  "merchantUserId": 123,
  "chain": "MATIC",
  "fullCurrType": "USDT_MATIC",
  "channelId": "123456"
}

Response

Order created successfully

status'SUCCESS' | 'ERROR'

Response status

codestring

Response code, 000000 indicates success

errorMessagestring

Error message, empty on success

Example response

{
  "status": "SUCCESS",
  "code": "000000",
  "data": {
    "prepayId": "65466648727916544",
    "orderAmount": "1",
    "currency": "USDT",
    "surchargeAmount": "0",
    "terminalType": "APP",
    "expireTime": 1677573665219,
    "qrContent": "http://openplatform.gate.io/qr/GA0cskPehKxQpshvm3Goeve8dHpwCl6yCHLSWUYrLqo=",
    "location": "https://www.gate.com/cashier?prepayid=65466648727916544",
    "payCurrency": "USDT",
    "payAmount": "1",
    "chain": {
      "chain_type": "BSC",
      "address": "0x86608d3C9f979b98a3b2417216eD859d313E339D",
      "fullCurrType": "USDT_EOS"
    },
    "goodsName": "charge",
    "inUsdt": "93.99"
  }
}