payByAlipayTradePay - 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

可选

timeoutMinute

integer

可选

authAppId

string

可选

notifyUrl

string

可选

model

object (AlipayTradePayModel)

可选

advancePaymentType

string

可选

支付模式类型,若值为ENJOY_PAY_V2表示当前交易允许走先享后付2.0垫资

agreementParams

object (AgreementParams)

可选

代扣信息。
代扣业务需要传入的协议相关信息，使用本参数传入协议号后scene和auth_code不需要再传值。

alipayStoreId

string

可选

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

authCode

string

可选

支付授权码。
当面付场景传买家的付款码（25~~30开头的长度为16~~24位的数字，实际字符串长度以开发者获取的付款码长度为准）或者刷脸标识串（fp开头的35位字符串）；
周期扣款或代扣场景无需传入，协议号通过agreement_params参数传递；
支付宝预授权和新当面资金授权场景无需传入，授权订单号通过 auth_no字段传入。
注：交易的买家与卖家不能相同。

authConfirmMode

string

可选

预授权确认模式。
适用于支付宝预授权和新当面资金授权场景。枚举值：
COMPLETE：转交易完成后解冻剩余冻结金额；
NOT_COMPLETE：转交易完成后不解冻剩余冻结金额；
默认值为NOT_COMPLETE。

authNo

string

可选

资金预授权单号。
支付宝预授权和新当面资金授权场景下必填。

bkagentReqInfo

object (BkAgentReqInfo)

可选

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

body

string

可选

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

businessParams

object (BusinessParams)

可选

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

buyerId

string

可选

买家支付宝用户ID。
支付宝预授权和新当面资金授权场景下必填，其它场景不需要传入。

buyerOpenId

string

可选

买家支付宝用户唯一标识

disablePayChannels

string

可选

禁用支付渠道。
多个渠道以逗号分割，如同时禁用信用支付类型和积分，则传入："credit_group,point"。
支持传入的值：渠道列表

discountableAmount

string

可选

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

extUserInfo

object (ExtUserInfo)

外部指定买家

可选

extendParams

object (ExtendParams)

可选

业务扩展参数，二级参数字段会动态新增

goodsDetail

array[object (GoodsDetail) {11}]

可选

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

isAsyncPay

boolean

可选

是否异步支付，传入true时，表明本次期望走异步支付，会先将支付请求受理下来，再异步推进。商户可以通过交易的异步通知或者轮询交易的状态来确定最终的交易结果。
只在代扣场景下有效，其它场景无需传入。

merchantOrderNo

string

商户的原始订单号

可选

operatorId

string

商户操作员编号。

可选

outTradeNo

string

可选

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

passbackParams

string

可选

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

payParams

object (PayParams)

支付相关参数

可选

productCode

string

可选

产品码。
商家和支付宝签约的产品码。枚举值（点击查看签约情况）：
FACE_TO_FACE_PAYMENT：当面付产品；
CYCLE_PAY_AUTH：周期扣款产品；
GENERAL_WITHHOLDING：代扣产品；
PRE_AUTH_ONLINE：支付宝预授权产品；
PRE_AUTH：新当面资金授权产品；
默认值为FACE_TO_FACE_PAYMENT。
注意：非当面付产品使用本接口时，本参数必填。请传入对应产品码。

promoParams

object (PromoParam)

可选

优惠明细参数，通过此属性补充营销参数

queryOptions

array[string]

可选

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

requestOrgPid

string

可选

收单机构(例如银行）的标识，填写该机构在支付宝的pid。只在机构间联场景下传递该值。

royaltyInfo

object (RoyaltyInfo)

可选

分账信息。
json格式，其它说明详见分账说明

scene

string

可选

支付场景。枚举值：
bar_code：当面付条码支付场景；
security_code：当面付刷脸支付场景，对应的auth_code为fp开头的刷脸标识串；
周期扣款或代扣场景无需传入，协议号通过agreement_params参数传递；
支付宝预授权和新当面资金授权场景无需传入，授权订单号通过 auth_no字段传入。
默认值为bar_code。

sellerId

string

可选

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

settleCurrency

string

可选

商户指定的结算币种，支持英镑：GBP、港币：HKD、美元：USD、新加坡元：SGD、日元：JPY、加拿大元：CAD、澳元：AUD、欧元：EUR、新西兰元：NZD、韩元：KRW、泰铢：THB、瑞士法郎：CHF、瑞典克朗：SEK、丹麦克朗：DKK、挪威克朗：NOK、马来西亚林吉特：MYR、印尼卢比：IDR、菲律宾比索：PHP、毛里求斯卢比：MUR、以色列新谢克尔：ILS、斯里兰卡卢比：LKR、俄罗斯卢布：RUB、阿联酋迪拉姆：AED、捷克克朗：CZK、南非兰特：ZAR、人民币：CNY

settleInfo

object (SettleInfo)

可选

结算信息、
json格式，详见结算参数说明。
直付通模式下必传。

storeId

string

可选

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

subMerchant

object (SubMerchant)

可选

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

subject

string

可选

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

terminalId

string

商户机具终端编号。

可选

terminalParams

string

可选

IOT设备信息。
通过集成IOTSDK的机具发起的交易时传入，取值为IOTSDK生成的业务签名值。

timeExpire

string

可选

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

timeoutExpress

string

可选

订单相对超时时间。从交易创建时间开始计算。
该笔订单允许的最晚付款时间，逾期将关闭交易。取值范围：1m～15d。m-分钟，h-小时，d-天，1c-当天（1c-当天的情况下，无论交易何时创建，都在0点关闭）。该参数数值不接受小数点，如 1.5h，可转换为 90m。
当面付场景默认值为3h；
其它场景默认值为15d;

totalAmount

string

可选

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

transCurrency

string

可选

标价币种, total_amount 对应的币种单位。支持英镑：GBP、港币：HKD、美元：USD、新加坡元：SGD、日元：JPY、加拿大元：CAD、澳元：AUD、欧元：EUR、新西兰元：NZD、韩元：KRW、泰铢：THB、瑞士法郎：CHF、瑞典克朗：SEK、丹麦克朗：DKK、挪威克朗：NOK、马来西亚林吉特：MYR、印尼卢比：IDR、菲律宾比索：PHP、毛里求斯卢比：MUR、以色列新谢克尔：ILS、斯里兰卡卢比：LKR、俄罗斯卢布：RUB、阿联酋迪拉姆：AED、捷克克朗：CZK、南非兰特：ZAR、人民币：CNY

undiscountableAmount

string

可选

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

示例

{
    "reqId": "string",
    "reqCustomerId": 0,
    "paymentInfoAlipayId": 0,
    "amount": 0,
    "outTradeNo": "string",
    "subject": "string",
    "timeoutMinute": 0,
    "authAppId": "string",
    "notifyUrl": "string",
    "model": {
        "advancePaymentType": "string",
        "agreementParams": {
            "agreementNo": "string",
            "applyToken": "string",
            "authConfirmNo": "string",
            "deductPermission": "string"
        },
        "alipayStoreId": "string",
        "authCode": "string",
        "authConfirmMode": "string",
        "authNo": "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",
        "buyerOpenId": "string",
        "disablePayChannels": "string",
        "discountableAmount": "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"
            }
        ],
        "isAsyncPay": true,
        "merchantOrderNo": "string",
        "operatorId": "string",
        "outTradeNo": "string",
        "passbackParams": "string",
        "payParams": {
            "asyncType": "string",
            "retryType": "string"
        },
        "productCode": "string",
        "promoParams": {
            "actualOrderTime": "string"
        },
        "queryOptions": [
            "string"
        ],
        "requestOrgPid": "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"
        },
        "scene": "string",
        "sellerId": "string",
        "settleCurrency": "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",
        "terminalParams": "string",
        "timeExpire": "string",
        "timeoutExpress": "string",
        "totalAmount": "string",
        "transCurrency": "string",
        "undiscountableAmount": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/portal/payment/payByAlipayTradePay' \
--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",
    "timeoutMinute": 0,
    "authAppId": "string",
    "notifyUrl": "string",
    "model": {
        "advancePaymentType": "string",
        "agreementParams": {
            "agreementNo": "string",
            "applyToken": "string",
            "authConfirmNo": "string",
            "deductPermission": "string"
        },
        "alipayStoreId": "string",
        "authCode": "string",
        "authConfirmMode": "string",
        "authNo": "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",
        "buyerOpenId": "string",
        "disablePayChannels": "string",
        "discountableAmount": "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"
            }
        ],
        "isAsyncPay": true,
        "merchantOrderNo": "string",
        "operatorId": "string",
        "outTradeNo": "string",
        "passbackParams": "string",
        "payParams": {
            "asyncType": "string",
            "retryType": "string"
        },
        "productCode": "string",
        "promoParams": {
            "actualOrderTime": "string"
        },
        "queryOptions": [
            "string"
        ],
        "requestOrgPid": "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"
        },
        "scene": "string",
        "sellerId": "string",
        "settleCurrency": "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",
        "terminalParams": "string",
        "timeExpire": "string",
        "timeoutExpress": "string",
        "totalAmount": "string",
        "transCurrency": "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": ""
}