GAgate

Place Order

Changed on

Create an order. When the order currency and payment currency are consistent, create a direct address payment order; if the order currency and payment currency are inconsistent, create a convert address payment order.

post/v1/pay/address/create

Request

  • Base URL
    https://openplatform.gateapi.io
  • URL
    https://openplatform.gateapi.io/v1/pay/address/create
  • Auth
    none declared. Required headers: X-GatePay-Certificate-ClientId, X-GatePay-Signature, X-GatePay-Timestamp, X-GatePay-Nonce

Headers

X-GatePay-Certificate-ClientIdstring required

Merchant client ID, obtained from GatePay platform

X-GatePay-Signaturestring required

HMAC-SHA256 signature for request validation

X-GatePay-Timestampstring required

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

X-GatePay-Noncestring required

Random nonce for replay attack prevention

Request body

merchantTradeNostring required

Merchant transaction ID in the merchant's system.

currencystring

Crypto currency in uppercase. Required for crypto orders together with orderAmount. Omit when creating a pure fiat order with fiatCurrency and fiatAmount (system converts to USDT). Must equal payCurrency (or payCurrency is backfilled from this).

orderAmountstring

Crypto order amount. Required together with currency for crypto orders. Omit for pure fiat orders that use fiatCurrency and fiatAmount.

toleranceAmountstring

Tolerance Amount：If the remaining unpaid amount is less than or equal to the configured tolerance amount, the order will be automatically marked as Paid, with no further payment required.

fiatCurrencystring

Fiat currency in uppercase, such as EUR, GBP, USD, CNY, JPY, AUD, CAD, CHF. For pure fiat orders, provide together with fiatAmount and omit currency/orderAmount.

fiatAmountstring

Fiat order amount, with a maximum precision of 2 digits. For pure fiat orders, provide together with fiatCurrency and omit currency/orderAmount.

surchargeAmountstring

Surcharge, a fee borne by the consumer.

payCurrencystring

Payment currency. Optional; if omitted, it is backfilled from currency. If provided, it must equal currency.

orderExpireTimeinteger required

Merchant-specified expiration time of the order, in milliseconds.

returnUrlstring

Callback URL for payment completion.

cancelUrlstring

Callback URL for payment cancellation.

merchantUserIdinteger required

Unique consumer ID from the merchant’s platform.

chainstring required

Selected chain name.

fullCurrTypestring required

Currency field that includes the chain name and corresponds to the specific currency on the specific chain.

channelIdstring required

Client Name.

payerEmailstring email

Payer email. Optional; required when the merchant's abnormal refund mode is automatic refund. Used for email notifications in abnormal payment scenarios (e.g. underpayment reminders, claim refund).

Example request

{
  "payerEmail": "payer@example.com"
}

Response

SUCCESS

statusstring
codestring
errorMessagestring

Changes