payByAlipayTradeCreate - inner-gateway

请求参数

Header 参数

token

string

可选

默认值:

eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJ7XCJpc3NcIjpcIkJXX0lOTkVSX0dBVEVXQVlcIixcImlhdFwiOjE3NDg3NDg5NzUsXCJwbGF0Zm9ybVwiOlwiU0dcIixcImp0aVwiOlwiU0dcIn0iLCJpc3MiOiJCV19JTk5FUl9HQVRFV0FZIiwiZXhwIjoxNzQ5NzQ4OTc1LCJpYXQiOjE3NDg3NDg5NzUsInBsYXRmb3JtIjoiU0ciLCJqdGkiOiJTRyJ9.rKbxbIyuPr2Pk29FnlzirOZhIor3GzHyCFnG49FkQ43JlxteCm2ow-EoSQdShtRzexQ0qou89ap72TQzJ3ce8sVt2SvDQ2iHriOWbVDeAItIV8FDyvxJZQiRBpw0rTqm7weBUVvVHOQndb9URtJ35vA0hYtWRmY-Kn3A-fVGDw0

customer

string

可选

默认值:

428166320547168262

user

string

可选

默认值:

ljing

Body 参数application/json

reqId

string

流水号

可选

reqCustomerId

integer <int64>

客户id

可选

paymentInfoAlipayId

integer <int64>

可选

amount

integer <int64>

可选

outTradeNo

string

可选

subject

string

可选

buyerId

string

可选

timeoutMinute

integer

可选

authAppId

string

可选

notifyUrl

string

可选

model

object (AlipayTradeCreateModel)

可选

agreementSignParams

object (SignParams)

可选

签约参数。如果希望使用支付并签约，需要在这里传入签约信息。

alipayStoreId

string

可选

支付宝店铺编号。
指商户创建门店后支付宝生成的门店ID。

bkagentReqInfo

object (BkAgentReqInfo)

可选

间联交易下，由收单机构上送的信息

body

string

可选

订单附加信息。
如果请求时传递了该参数，将在异步通知、对账单中原样返回，同时会在商户和用户的pc账单详情中作为交易描述展示

businessParams

object (BusinessParams)

可选

商户传入业务信息，具体值要和支付宝约定，应用于安全，营销等参数直传场景，格式为json格式

buyerId

string

可选

买家支付宝用户ID。
2088开头的16位纯数字，小程序场景下获取用户ID请参考：用户授权;
其它场景下获取用户ID请参考：网页授权获取用户信息;
注：交易的买家与卖家不能相同。

buyerLogonId

string

可选

买家支付宝登录账号。建议通过open_id来传递买家信息。

buyerOpenId

string

可选

买家支付宝用户唯一标识

disablePayChannels

string

可选

禁用渠道,用户不可用指定渠道支付，多个渠道以逗号分割
注，与enable_pay_channels互斥
渠道列表

discountableAmount

string

可选

可打折金额。
参与优惠计算的金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]。
如果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】，则必须满足如下条件：【订单总金额】=【可打折金额】+【不可打折金额】。
如果订单金额全部参与优惠计算，则【可打折金额】和【不可打折金额】都无需传入。

enablePayChannels

string

可选

指定支付渠道。
用户只能使用指定的渠道进行支付，多个渠道以逗号分割。
与disable_pay_channels互斥，支持传入的值：渠道列表。
注：如果传入了指定支付渠道，则用户只能用指定内的渠道支付，包括营销渠道也要指定才能使用。该参数可能导致用户支付受限，慎用。

extUserInfo

object (ExtUserInfo)

外部指定买家

可选

extendParams

object (ExtendParams)

业务扩展参数

可选

goodsDetail

array[object (GoodsDetail) {11}]

可选

订单包含的商品列表信息，json格式。

logisticsDetail

object (LogisticsDetail)

物流信息

可选

merchantOrderNo

string

商户的原始订单号

可选

opAppId

string

可选

小程序支付中，商户实际经营主体的小程序应用的appid

opBuyerOpenId

string

可选

买家支付宝用户唯一标识（商户实际经营主体的小程序应用关联的买家open_id）

operatorId

string

商户操作员编号。

可选

outTradeNo

string

可选

商户订单号。
由商家自定义，64个字符以内，仅支持字母、数字、下划线且需保证在商户端不重复。

passbackParams

string

可选

公用回传参数。
如果请求时传递了该参数，支付宝会在异步通知时将该参数原样返回。

productCode

string

可选

产品码。
商家和支付宝签约的产品码。枚举值（点击查看签约情况）：
FACE_TO_FACE_PAYMENT：当面付产品；
默认值为FACE_TO_FACE_PAYMENT。

queryOptions

array[string]

可选

返回参数选项。商户通过传递该参数来定制需要额外返回的信息字段，数组格式。包括但不限于：["enterprise_pay_info","hyb_amount"]

receiverAddressInfo

object (ReceiverAddressInfo)

收货人及地址信息

可选

royaltyInfo

object (RoyaltyInfo)

可选

描述分账信息，json格式。

sellerId

string

可选

卖家支付宝用户ID。
当需要指定收款账号时，通过该参数传入，如果该值为空，则默认为商户签约账号对应的支付宝用户ID。
收款账号优先级规则：门店绑定的收款账户>请求传入的seller_id>商户签约账号对应的支付宝用户ID；
注：直付通和机构间联场景下seller_id无需传入或者保持跟pid一致；
如果传入的seller_id与pid不一致，需要联系支付宝小二配置收款关系；

settleInfo

object (SettleInfo)

可选

描述结算信息，json格式。

storeId

string

可选

商户门店编号。
指商户创建门店时输入的门店编号。

subMerchant

object (SubMerchant)

可选

二级商户信息。
直付通模式和机构间连模式下必传，其它场景下不需要传入。

subject

string

可选

订单标题。
注意：不可使用特殊字符，如 /，=，& 等。

terminalId

string

商户机具终端编号。

可选

timeExpire

string

可选

订单绝对超时时间。
格式为yyyy-MM-dd HH:mm:ss。
注：time_expire和timeout_express两者只需传入一个或者都不传，如果两者都传，优先使用time_expire。

timeoutExpress

string

可选

订单相对超时时间。从交易创建时间开始计算。
该笔订单允许的最晚付款时间，逾期将关闭交易。取值范围：1m～15d。m-分钟，h-小时，d-天，1c-当天（1c-当天的情况下，无论交易何时创建，都在0点关闭）。该参数数值不接受小数点，如 1.5h，可转换为 90m。
当面付场景默认值为3h。
注：time_expire和timeout_express两者只需传入一个或者都不传，如果两者都传，优先使用time_expire。

totalAmount

string

可选

订单总金额。
单位为元，精确到小数点后两位，取值范围：[0.01,100000000] 。

undiscountableAmount

string

可选

不可打折金额。
不参与优惠计算的金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]。
如果同时传入了【可打折金额】、【不可打折金额】和【订单总金额】，则必须满足如下条件：【订单总金额】=【可打折金额】+【不可打折金额】。
如果订单金额全部参与优惠计算，则【可打折金额】和【不可打折金额】都无需传入。

示例

{
    "reqId": "string",
    "reqCustomerId": 0,
    "paymentInfoAlipayId": 0,
    "amount": 0,
    "outTradeNo": "string",
    "subject": "string",
    "buyerId": "string",
    "timeoutMinute": 0,
    "authAppId": "string",
    "notifyUrl": "string",
    "model": {
        "agreementSignParams": {
            "accessParams": {
                "channel": "string"
            },
            "allowHuazhiDegrade": true,
            "externalAgreementNo": "string",
            "externalLogonId": "string",
            "periodRuleParams": {
                "executeTime": "string",
                "period": 0,
                "periodType": "string",
                "singleAmount": "string",
                "totalAmount": "string",
                "totalPayments": 0
            },
            "personalProductCode": "string",
            "productCode": "string",
            "recommendSortChannelParams": [
                {
                    "assetTypeCode": "string",
                    "instId": "string"
                }
            ],
            "signNotifyUrl": "string",
            "signScene": "string",
            "subMerchant": {
                "subMerchantId": "string",
                "subMerchantName": "string",
                "subMerchantServiceDescription": "string",
                "subMerchantServiceName": "string"
            }
        },
        "alipayStoreId": "string",
        "bkagentReqInfo": {
            "acqCode": "string",
            "deviceType": "string",
            "location": "string",
            "merchCode": "string",
            "serialNum": "string"
        },
        "body": "string",
        "businessParams": {
            "actualOrderTime": "string",
            "campusCard": "string",
            "cardType": "string",
            "enterprisePayAmount": "string",
            "enterprisePayInfo": "string",
            "goodTaxes": "string",
            "mcCreateTradeIp": "string",
            "tinyAppMerchantBizType": "string"
        },
        "buyerId": "string",
        "buyerLogonId": "string",
        "buyerOpenId": "string",
        "disablePayChannels": "string",
        "discountableAmount": "string",
        "enablePayChannels": "string",
        "extUserInfo": {
            "certNo": "string",
            "certType": "string",
            "fixBuyer": "string",
            "identityHash": "string",
            "minAge": "string",
            "mobile": "string",
            "name": "string",
            "needCheckInfo": "string"
        },
        "extendParams": {
            "cardType": "string",
            "hbFqNum": "string",
            "hbFqSellerPercent": "string",
            "industryRefluxInfo": "string",
            "royaltyFreeze": "string",
            "specifiedSellerName": "string",
            "sysServiceProviderId": "string",
            "tcInstallmentOrderId": "string",
            "tradeComponentOrderId": "string"
        },
        "goodsDetail": [
            {
                "alipayGoodsId": "string",
                "body": "string",
                "categoriesTree": "string",
                "goodsCategory": "string",
                "goodsId": "string",
                "goodsName": "string",
                "outItemId": "string",
                "outSkuId": "string",
                "price": "string",
                "quantity": 0,
                "showUrl": "string"
            }
        ],
        "logisticsDetail": {
            "logisticsType": "string"
        },
        "merchantOrderNo": "string",
        "opAppId": "string",
        "opBuyerOpenId": "string",
        "operatorId": "string",
        "outTradeNo": "string",
        "passbackParams": "string",
        "productCode": "string",
        "queryOptions": [
            "string"
        ],
        "receiverAddressInfo": {
            "address": "string",
            "divisionCode": "string",
            "mobile": "string",
            "name": "string",
            "zip": "string"
        },
        "royaltyInfo": {
            "royaltyDetailInfos": [
                {
                    "amount": "string",
                    "amountPercentage": "string",
                    "batchNo": "string",
                    "desc": "string",
                    "outRelationId": "string",
                    "serialNo": 0,
                    "transIn": "string",
                    "transInType": "string",
                    "transOut": "string",
                    "transOutType": "string"
                }
            ],
            "royaltyType": "string"
        },
        "sellerId": "string",
        "settleInfo": {
            "settleDetailInfos": [
                {
                    "actualAmount": "string",
                    "amount": "string",
                    "settleEntityId": "string",
                    "settleEntityType": "string",
                    "summaryDimension": "string",
                    "transIn": "string",
                    "transInType": "string"
                }
            ],
            "settlePeriodTime": "string"
        },
        "storeId": "string",
        "subMerchant": {
            "merchantId": "string",
            "merchantType": "string"
        },
        "subject": "string",
        "terminalId": "string",
        "timeExpire": "string",
        "timeoutExpress": "string",
        "totalAmount": "string",
        "undiscountableAmount": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/portal/payment/payByAlipayTradeCreate' \
--header 'token: eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJ7XCJpc3NcIjpcIkJXX0lOTkVSX0dBVEVXQVlcIixcImlhdFwiOjE3NDg3NDg5NzUsXCJwbGF0Zm9ybVwiOlwiU0dcIixcImp0aVwiOlwiU0dcIn0iLCJpc3MiOiJCV19JTk5FUl9HQVRFV0FZIiwiZXhwIjoxNzQ5NzQ4OTc1LCJpYXQiOjE3NDg3NDg5NzUsInBsYXRmb3JtIjoiU0ciLCJqdGkiOiJTRyJ9.rKbxbIyuPr2Pk29FnlzirOZhIor3GzHyCFnG49FkQ43JlxteCm2ow-EoSQdShtRzexQ0qou89ap72TQzJ3ce8sVt2SvDQ2iHriOWbVDeAItIV8FDyvxJZQiRBpw0rTqm7weBUVvVHOQndb9URtJ35vA0hYtWRmY-Kn3A-fVGDw0' \
--header 'customer: 428166320547168262' \
--header 'user: ljing' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reqId": "string",
    "reqCustomerId": 0,
    "paymentInfoAlipayId": 0,
    "amount": 0,
    "outTradeNo": "string",
    "subject": "string",
    "buyerId": "string",
    "timeoutMinute": 0,
    "authAppId": "string",
    "notifyUrl": "string",
    "model": {
        "agreementSignParams": {
            "accessParams": {
                "channel": "string"
            },
            "allowHuazhiDegrade": true,
            "externalAgreementNo": "string",
            "externalLogonId": "string",
            "periodRuleParams": {
                "executeTime": "string",
                "period": 0,
                "periodType": "string",
                "singleAmount": "string",
                "totalAmount": "string",
                "totalPayments": 0
            },
            "personalProductCode": "string",
            "productCode": "string",
            "recommendSortChannelParams": [
                {
                    "assetTypeCode": "string",
                    "instId": "string"
                }
            ],
            "signNotifyUrl": "string",
            "signScene": "string",
            "subMerchant": {
                "subMerchantId": "string",
                "subMerchantName": "string",
                "subMerchantServiceDescription": "string",
                "subMerchantServiceName": "string"
            }
        },
        "alipayStoreId": "string",
        "bkagentReqInfo": {
            "acqCode": "string",
            "deviceType": "string",
            "location": "string",
            "merchCode": "string",
            "serialNum": "string"
        },
        "body": "string",
        "businessParams": {
            "actualOrderTime": "string",
            "campusCard": "string",
            "cardType": "string",
            "enterprisePayAmount": "string",
            "enterprisePayInfo": "string",
            "goodTaxes": "string",
            "mcCreateTradeIp": "string",
            "tinyAppMerchantBizType": "string"
        },
        "buyerId": "string",
        "buyerLogonId": "string",
        "buyerOpenId": "string",
        "disablePayChannels": "string",
        "discountableAmount": "string",
        "enablePayChannels": "string",
        "extUserInfo": {
            "certNo": "string",
            "certType": "string",
            "fixBuyer": "string",
            "identityHash": "string",
            "minAge": "string",
            "mobile": "string",
            "name": "string",
            "needCheckInfo": "string"
        },
        "extendParams": {
            "cardType": "string",
            "hbFqNum": "string",
            "hbFqSellerPercent": "string",
            "industryRefluxInfo": "string",
            "royaltyFreeze": "string",
            "specifiedSellerName": "string",
            "sysServiceProviderId": "string",
            "tcInstallmentOrderId": "string",
            "tradeComponentOrderId": "string"
        },
        "goodsDetail": [
            {
                "alipayGoodsId": "string",
                "body": "string",
                "categoriesTree": "string",
                "goodsCategory": "string",
                "goodsId": "string",
                "goodsName": "string",
                "outItemId": "string",
                "outSkuId": "string",
                "price": "string",
                "quantity": 0,
                "showUrl": "string"
            }
        ],
        "logisticsDetail": {
            "logisticsType": "string"
        },
        "merchantOrderNo": "string",
        "opAppId": "string",
        "opBuyerOpenId": "string",
        "operatorId": "string",
        "outTradeNo": "string",
        "passbackParams": "string",
        "productCode": "string",
        "queryOptions": [
            "string"
        ],
        "receiverAddressInfo": {
            "address": "string",
            "divisionCode": "string",
            "mobile": "string",
            "name": "string",
            "zip": "string"
        },
        "royaltyInfo": {
            "royaltyDetailInfos": [
                {
                    "amount": "string",
                    "amountPercentage": "string",
                    "batchNo": "string",
                    "desc": "string",
                    "outRelationId": "string",
                    "serialNo": 0,
                    "transIn": "string",
                    "transInType": "string",
                    "transOut": "string",
                    "transOutType": "string"
                }
            ],
            "royaltyType": "string"
        },
        "sellerId": "string",
        "settleInfo": {
            "settleDetailInfos": [
                {
                    "actualAmount": "string",
                    "amount": "string",
                    "settleEntityId": "string",
                    "settleEntityType": "string",
                    "summaryDimension": "string",
                    "transIn": "string",
                    "transInType": "string"
                }
            ],
            "settlePeriodTime": "string"
        },
        "storeId": "string",
        "subMerchant": {
            "merchantId": "string",
            "merchantType": "string"
        },
        "subject": "string",
        "terminalId": "string",
        "timeExpire": "string",
        "timeoutExpress": "string",
        "totalAmount": "string",
        "undiscountableAmount": "string"
    }
}'

返回响应

🟢200成功

application/json

Body

error

object (Error)

可选

code

string

错误代码

可选

message

string

可选

错误信息描述( 子系统简称-模块名称-错误代码 )

detail

string

详细信息

可选

reqId

string

流水号

可选

reqCustomerId

integer <int64>

客户id

可选

data

string

数据

可选

示例

{
  "error": {
    "code": "",
    "message": "",
    "detail": ""
  },
  "reqId": "",
  "reqCustomerId": 0,
  "data": ""
}