跳转到主要内容
POST
/
v1
/
pay
/
order
创建订单
curl --request POST \
  --url https://openplatform.gateapi.io/v1/pay/order \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "merchantTradeNo": "22212345678555",
  "env": {
    "terminalType": "APP"
  },
  "currency": "GT",
  "orderAmount": "1.21",
  "goods": {
    "goodsType": "312221",
    "goodsName": "NF2T",
    "goodsDetail": "123444"
  }
}
'
{
  "code": "SUCCESS",
  "message": "订单创建成功",
  "data": {
    "orderId": "GATE202400001",
    "merchantTradeNo": "22212345678555",
    "paymentUrl": "https://pay.gateapi.io/paypage?order=GATE202400001",
    "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "orderAmount": "1.21",
    "currency": "GT",
    "expireTime": 1672909255498,
    "orderStatus": "CREATED",
    "createTime": 1672905655498
  }
}

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.

概述

本页说明 /v1/pay/order 接口。完整的请求参数、响应结构与示例由上方关联的 OpenAPI 定义渲染。

说明

请求头

X-GatePay-Certificate-ClientId
string
必填

商户客户端ID,在 GatePay 平台申请获得

示例:

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

X-GatePay-Signature
string
必填

HMAC-SHA256签名,用于验证请求合法性

示例:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

X-GatePay-Timestamp
string
必填

时间戳(毫秒),与服务器时间差不能超过5分钟

示例:

"1672905655498"

X-GatePay-Nonce
string
必填

随机数,用于防止重放攻击

示例:

"9578"

请求体

application/json

支付订单创建参数

merchantTradeNo
string
必填

商户订单号,必须唯一

Required string length: 5 - 32
示例:

"22212345678555"

env
object
必填
currency
string
必填

订单币种。请参考上方“支持的网络币种”确认当前可用范围。

示例:

"GT"

orderAmount
string
必填

订单金额,必须为正数,支持小数

Pattern: ^\d+(\.\d{1,2})?$
示例:

"1.21"

goods
object
必填
orderExpireTime
integer<int64>

订单过期时间,UTC时间戳,millisecond。不设置时默认为1小时,最大过期时间为1小时

示例:

1770789143000

returnUrl
string<uri>

订单支付成功后返回跳转地址,最长256字符。仅在独立页面支付完成后会跳转到该Url

Maximum string length: 512
示例:

"http://47.99.158.63:8205/payment/redirect"

cancelUrl
string<uri>

订单支付取消后返回跳转地址

Maximum string length: 512
示例:

"http://47.99.158.63:8205/payment/redirect"

channelId
string

客户渠道名称

Maximum string length: 32
示例:

"123456"

响应

200 - application/json

支付订单创建成功

code
enum<string>

响应码

可用选项:
SUCCESS,
ERROR
示例:

"SUCCESS"

message
string

响应消息

示例:

"订单创建成功"

data
object