Skip to content

创建 - Payment create

请求地址

HTTP
https://{{gateway_domain}}/pg/v2/payment/create

请求参数

HTTP Method

POST

HTTP Header

字段数据类型长度限制是否必填项说明
Content-TypeStringN/A字段值只支持 application/json
AcceptStringN/A字段值只支持 application/json
AuthorizationStringAuthorization: {type} {credentials},详情参考签名规范部分

HTTP Body

字段数据类型长度限制是否必填项说明
merchantTradeNoString50商户自行生成的订单号,建议商户保证唯一性
amountString18金额大小,整数 1-15 位,保留2位小数,比如:"100.05"
currencyEnum String3国际统一币种简称,表示amount金额的币种,参照国家币种表
descriptionString80订单的标题,有些场景如果消费者看到订单信息,可能会展示此字段内容
payerJSON Object付款人信息
payMethodJSON Object支付方式信息
tradeEnvJSON Object用户交易环境信息
merchantAttachString255如使用此字段,同步/异步通知、订单查询接口将原样返回该字段值
notifyUrlString255订单在支付成功时,支付平台会通过后台调用此url通知商户
returnUrlString255订单支付完毕时,如果上游支持同步跳转,支付平台会将用户的页面跳转到此url上
  • payer 参数说明
字段数据类型长度限制是否必填项说明
userIdString64付款人Id
nameString80付款人名称
emailString80付款人Email
phoneString20付款人手机号
  • payMethod 参数说明

    • payMethod 为动态参数,包含了固定字段 type,以及根据 type 的不同包含不同的字段
    • type 约定大写,多个单词使用下划线分隔,取值范围:[UPI,UPI_COLLECT,UPI_INTENT,PIX,PIX_QRCODE]
字段数据类型长度限制是否必填项说明
typeEnum String20
  • tradeEnv 参数说明
字段数据类型长度限制是否必填项说明
deviceIdString50付款人设备ID
ipString32付款人设备IP

响应结果

HTTP Header

字段数据类型是否必填项说明
Content-TypeString字段值只支持 application/json
AuthorizationStringAuthorization: {type} {credentials},详情参考签名规范部分

HTTP Body

字段数据类型是否必填项说明
codeEnum String
errorMessageString错误信息
dataJSON Object

data 字段说明

字段数据类型是否必填项说明
paymentNoString支付平台交易流水号
merchantTradeNoString商户生成的订单号
amountString订单金额
currencyString订单的币种
actionJSON Object可变返回字段

action 字段说明

TIP

action 为可变字段,根据 payMethod.type 字段不同返回不同值

JSON
{
    "action": {
        "payMethodType": "UPI_COLLECT",
        "type": "await"
    }
}

示例

请求

Shell
curl https://{{gateway_domain}}/pg/v2/payment/create \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H 'Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=9e494e8a91bcdd08f18ad5b2cfdbfd5654f5c00c89f8216eebd7c1637b6ce01b,timestamp=1714128828114,nonce=C7CA27DC6D55DA935DFC8450C721CC99' \
  -d '{
  "merchantTradeNo": "MTU-1161",
  "amount": "1.00",
  "currency": "INR",
  "description": "payment test",
  "payer": {
    "userId": "test_id",
    "name": "testName",
    "email": "[email protected]",
    "phone": "00000000"
  },
  "payMethod": {
    "type": "UPI"
  },
  "tradeEnv": {
    "ip": "127.0.0.1",
    "deviceId": "02efc74d-3988-4f0d-8cc8-0cb78bded719"
  },
  "merchantAttach": "merchant attach",
  "notifyUrl": "https://example.com/notifyurl",
  "returnUrl": "https://example.com/returnurl"
}'

响应

Shell
HTTP/1.1 200 OK
Content-Type: application/json
Server: nginx/1.18.0
Date: Mon, 06 Mar 2024 12:00:00 GMT
Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=ac6ae72f8c46f5c2092c3dab9bb0e08b6cdb6d5e7ff8ad190499a8955d57f297,timestamp=1714128245401,nonce=28FA11BF8FD1309767551B4FD8A57BD5

{
    "code": "OK",
    "errorMessage": null,
    "data": {
        "paymentNo": "20240423220624300800001097000004",
        "merchantTradeNo": "MTU-1161",
        "amount": "1.00",
        "currency": "INR",
        "action": {
            "payMethodType": "UPI",
            "type": "REDIRECT",
            "url": "https://{{gateway_domain}}/pg/checkout/upi/e6df5e061d21401d8941fff14df4df09",
            "method": "GET"
        }
    }
}