标准-jsapi支付 - 易企通1.0

除付款码支付场景外，商户系统都可先通过易生调用该接口生成预支付交易单，返回正确的预支付交易回话标识后商户再按扫码、JSAPI、APP 等不同场景生成的交易串调起支付，支付完成后，异步通知商户支付结果。

请求参数

Body 参数application/json

orgId

string

机构号

必需

orgMercode

string

商户号

必需

orgTermno

string

终端号

必需

orgTrace

string

交易流水

必需

28位定长，规则：orgId 前四位+后四位+yyyyMMddhhmmss+6位自定义合计28位长度（唯一）

sign

string

签名

必需

signType

string

签名方式

必需

prodTrace

string

产品流水

可选

appendData

object

附加请求数据-仅正向交易需要

必需

orgBasestation

string

基站信息

可选

orgDeviceIp

string

交易设备IP

可选

orgGpstype

string

GPS坐标系

可选

orgLatitude

string

维度

可选

orgLongitude

string

经度

可选

dgtlEnvlp

string

数字信封

可选

identity

string

实名支付

可选

支付宝-支持上传所有字段：商户可直接使用；微信-仅支持W:开头的字段：并且需要向微信申请，仅支持商户为“保险”类目

qrLimitAmt

object (QrLimitAmt)

银联二维码当笔订单对应的借记卡支付限额

可选

qrPnrInsIdCd

string

银联服务商机构标识码

可选

queryOptions

string

查询支付宝分期参数

可选

terminalinfo

object (TerminalInfo)

终端信息

可选

unQrAppCustomerInfo

string

银行卡验证信息及身份信息

可选

整体加密后以字符串形式上送，具体结构参考:UnQrAppCustomerInfo

unQrAppInstalTransInfo

object (UnQrAppInstalTransInfo)

分期信息域

可选

unQrAppReserved

object (UnQrAppReserved)

保留域

可选

wxLimitPay

string

wx:交易限制支付类型

可选

取值-含义：{"no_credit":"禁用信用类型"}

示例值:

no_credit

invoiceSt

boolean

wx:是否支持发票

可选

示例值:

false

wxDetail

object (WxDetail)

可选

wxGoodsTag

string

可选

wx:订单优惠标记，代金券或立减优惠功能的参数

wxSceneInfo

object (WxSceneInfo)

可选

aliDisablePayChannels

string

可选

ali:禁用支付渠道,逗号分隔 https://docs.open.alipay.com/common/wifww7

aliEnablePayChannels

string

可选

ali:可用支付渠道,逗号分隔,与aliDisablePayChannels互斥,被扫无法支持此字段 https://docs.open.alipay.com/common/wifww7

aliExtendParams

object

可选

ali:业务拓展信息，支持功能：花呗分期、附加信息、扫码点单标识信息

aliGoodsDetail

array[object (AliGoodsDetail) {9}]

可选

ali:商品详情列表

aliBusinessParams

object

可选

ali:商户传入业务信息,用于安全/营销等参数直传场景, json

示例值:

{"data":"123"}

aliDiscountableAmount

string

ali:可打折金额

可选

示例值:

aliOperatorId

string

ali:操作员编号

可选

aliSellerId

string

ali:卖家id

可选

aliStoreId

string

可选

ali:商户门店编号

aliTerminalParams

object

ali:终端参数

可选

示例值:

{"credential":"28763443825664394:20180207192030954:abcdefGHIJKLMN","signature":"xxxxxxx","terminalType":"IOT"}

aliUndiscountableAmount

string

可选

ali:不可打折金额

示例值:

alipayStoreId

string

可选

ali:支付宝门店编号

qrAcqAddnData

object (QrAcqAddnData)

可选

qrSpecFeeInfo

string

可选

qr:特殊计费信息；固定长度3位。位置1~2：特殊计费类型；位置3：特殊计费档次

qrCode

string

可选

二维码（只有云闪付jsapi交易必传）

userAuthCode

string

可选

授权码（只有云闪付jsapi交易必传）

data

object

必需

orgBackUrl

string

支付成功后的结果通知地址

必需

orgFrontUrl

string

前台通知地址

必需

云闪付-支付成功后的页面跳转地址

payerId

string

按类型取值为：用户唯一标识

必需

W：支付的appId(wxSubAppid)下的openId；Z：支付宝用户唯一标识buyer_user_id；

payerOtherInfo

string

可选

按类型取值为：W:机构appId下的openId；Z:支付宝登录账号（脱敏）；

tradeCode

string

WAJS1:支付宝-生活号支付;WAJS2:支付宝-小程序支付;WTJS1:微信-公众号支付;WTJS2:微信-小程序支付;WUJS1:银联二维码-JS支付

必需

tradeAmt

integer <int64>

金额

必需

单位分；取值范围：1-10000000000

示例值:

timeoutMinutes

integer <int32>

订单支付超时时间

可选

长度：8。单位：秒, 不填默认为300（5分钟)这个值会传给对应的支付渠道，但是条码本身有限制支付有时间，一般为1分钟。

示例值:

orderInfo

string

订单标题

可选

商品描述，对应微信description，码牌中固定为终端名称

infoAttach

string

订单描述

可选

附加消息，对应微信attach

delaySettleFlag

string

清算-延迟结算标识

可选

取值-含义：{"0":标准不延迟（默认"","1":"延迟结算）"}

patnerSettleFlag

string

清算-秒到标识

可选

取值-含义：{"0":"D0清算（前提：开通秒到功能）","1":"T1清算（默认）"}

splitSettleFlag

string

清算-分账标识

可选

取值-含义：{"0":"标准不分账（默认）","1":"分账"}，分账标识优先判断，标识1不清算

investor

string

优惠出资方编号

可选

长度：32

orgPreferentialAmt

string

下游优惠金额

可选

wxSubAppid

string

wx:支付使用的appid

可选

attach

string

下游外部订单号/缴费号

可选

仅涉及“合规改造的四方平台”适用；长度：50

handingFee

string

下游手续费

可选

仅涉及“合规改造的四方平台”适用；长度：12

orgSmercode

string

下游机构商户唯一标识

可选

仅涉及“合规改造的四方平台”适用

orgSterminalcode

string

小商户终端号

可选

otherfee

string

特殊计费

可选

仅涉及“合规改造的四方平台”适用；长度：121

orgInfo

string

请求方自定义信息

可选

示例

{
    "orgId": "string",
    "orgMercode": "string",
    "orgTermno": "string",
    "orgTrace": "string",
    "sign": "string",
    "signType": "string",
    "prodTrace": "string",
    "appendData": {
        "orgBasestation": "string",
        "orgDeviceIp": "string",
        "orgGpstype": "string",
        "orgLatitude": "string",
        "orgLongitude": "string",
        "dgtlEnvlp": "string",
        "identity": "string",
        "qrLimitAmt": {
            "creditLimitAmt": "string",
            "debitLimitAmt": "string"
        },
        "qrPnrInsIdCd": "string",
        "queryOptions": "string",
        "terminalinfo": {
            "appVersion": "string",
            "encryptRandNum": "string",
            "iccId": "string",
            "lbsNum1": "string",
            "lbsNum2": "string",
            "lbsNum3": "string",
            "lbsSignal1": "string",
            "lbsSignal2": "string",
            "lbsSignal3": "string",
            "location": "string",
            "locationCd1": "string",
            "locationCd2": "string",
            "locationCd3": "string",
            "mobileCountryCd": "string",
            "mobileNetNum": "string",
            "networkLicense": "string",
            "secretText": "string",
            "serialNum": "string",
            "telecomLbs": "string",
            "telecomLbsSignal": "string",
            "telecomNetId": "string",
            "telecomSysId": "string",
            "terminalId": "string",
            "terminalIp": "string",
            "terminalType": "string"
        },
        "unQrAppCustomerInfo": "string",
        "unQrAppInstalTransInfo": {
            "instalRate": "string",
            "mchntFeeSubsidy": "string",
            "numberOfInstallments": "string"
        },
        "unQrAppReserved": {
            "cardNumberLock": "string",
            "customerId": "string",
            "discountCode": "string",
            "fundComCode": "string",
            "fundProCode": "string",
            "fundProType": "string"
        },
        "wxLimitPay": "no_credit",
        "invoiceSt": false,
        "wxDetail": {
            "costPrice": 0,
            "goodsDetail": [
                {
                    "goodsId": "string",
                    "goodsName": "string",
                    "price": 0,
                    "quantity": 0,
                    "wxpayGoodsId": "string"
                }
            ],
            "receiptId": "string"
        },
        "wxGoodsTag": "string",
        "wxSceneInfo": {
            "address": "string",
            "areaCode": "string",
            "storeCode": "string",
            "storeName": "string"
        },
        "aliDisablePayChannels": "string",
        "aliEnablePayChannels": "string",
        "aliExtendParams": {
            "property1": {},
            "property2": {}
        },
        "aliGoodsDetail": [
            {
                "alipay_goods_id": "string",
                "body": "string",
                "categories_tree": "string",
                "goods_category": "string",
                "goods_id": "string",
                "goods_name": "string",
                "price": "string",
                "quantity": 0,
                "show_url": "string"
            }
        ],
        "aliBusinessParams": {
            "data": "123"
        },
        "aliDiscountableAmount": 1,
        "aliOperatorId": "string",
        "aliSellerId": "string",
        "aliStoreId": "string",
        "aliTerminalParams": {
            "credential": "28763443825664394:20180207192030954:abcdefGHIJKLMN",
            "signature": "xxxxxxx",
            "terminalType": "IOT"
        },
        "aliUndiscountableAmount": 1,
        "alipayStoreId": "string",
        "qrAcqAddnData": {
            "customData": "string",
            "goodsInfos": [
                {
                    "addnInfo": "string",
                    "category": "string",
                    "id": "string",
                    "name": "string",
                    "price": "string",
                    "quantity": "string"
                }
            ],
            "orderInfo": {
                "addnInfo": "string",
                "dctAmount": "string",
                "description": "string",
                "title": "string"
            }
        },
        "qrSpecFeeInfo": "string",
        "qrCode": "string",
        "userAuthCode": "string"
    },
    "data": {
        "orgBackUrl": "string",
        "orgFrontUrl": "string",
        "payerId": "string",
        "payerOtherInfo": "string",
        "tradeCode": "string",
        "tradeAmt": 1,
        "timeoutMinutes": 60,
        "orderInfo": "string",
        "infoAttach": "string",
        "delaySettleFlag": "string",
        "patnerSettleFlag": "string",
        "splitSettleFlag": "string",
        "investor": "string",
        "orgPreferentialAmt": "string",
        "wxSubAppid": "string",
        "attach": "string",
        "handingFee": "string",
        "orgSmercode": "string",
        "orgSterminalcode": "string",
        "otherfee": "string"
    },
    "orgInfo": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://t-wapi.bhecard.com:8443/standard/jsapi' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orgId": "string",
    "orgMercode": "string",
    "orgTermno": "string",
    "orgTrace": "string",
    "sign": "string",
    "signType": "string",
    "prodTrace": "string",
    "appendData": {
        "orgBasestation": "string",
        "orgDeviceIp": "string",
        "orgGpstype": "string",
        "orgLatitude": "string",
        "orgLongitude": "string",
        "dgtlEnvlp": "string",
        "identity": "string",
        "qrLimitAmt": {
            "creditLimitAmt": "string",
            "debitLimitAmt": "string"
        },
        "qrPnrInsIdCd": "string",
        "queryOptions": "string",
        "terminalinfo": {
            "appVersion": "string",
            "encryptRandNum": "string",
            "iccId": "string",
            "lbsNum1": "string",
            "lbsNum2": "string",
            "lbsNum3": "string",
            "lbsSignal1": "string",
            "lbsSignal2": "string",
            "lbsSignal3": "string",
            "location": "string",
            "locationCd1": "string",
            "locationCd2": "string",
            "locationCd3": "string",
            "mobileCountryCd": "string",
            "mobileNetNum": "string",
            "networkLicense": "string",
            "secretText": "string",
            "serialNum": "string",
            "telecomLbs": "string",
            "telecomLbsSignal": "string",
            "telecomNetId": "string",
            "telecomSysId": "string",
            "terminalId": "string",
            "terminalIp": "string",
            "terminalType": "string"
        },
        "unQrAppCustomerInfo": "string",
        "unQrAppInstalTransInfo": {
            "instalRate": "string",
            "mchntFeeSubsidy": "string",
            "numberOfInstallments": "string"
        },
        "unQrAppReserved": {
            "cardNumberLock": "string",
            "customerId": "string",
            "discountCode": "string",
            "fundComCode": "string",
            "fundProCode": "string",
            "fundProType": "string"
        },
        "wxLimitPay": "no_credit",
        "invoiceSt": false,
        "wxDetail": {
            "costPrice": 0,
            "goodsDetail": [
                {
                    "goodsId": "string",
                    "goodsName": "string",
                    "price": 0,
                    "quantity": 0,
                    "wxpayGoodsId": "string"
                }
            ],
            "receiptId": "string"
        },
        "wxGoodsTag": "string",
        "wxSceneInfo": {
            "address": "string",
            "areaCode": "string",
            "storeCode": "string",
            "storeName": "string"
        },
        "aliDisablePayChannels": "string",
        "aliEnablePayChannels": "string",
        "aliExtendParams": {
            "property1": {},
            "property2": {}
        },
        "aliGoodsDetail": [
            {
                "alipay_goods_id": "string",
                "body": "string",
                "categories_tree": "string",
                "goods_category": "string",
                "goods_id": "string",
                "goods_name": "string",
                "price": "string",
                "quantity": 0,
                "show_url": "string"
            }
        ],
        "aliBusinessParams": {
            "data": "123"
        },
        "aliDiscountableAmount": 1,
        "aliOperatorId": "string",
        "aliSellerId": "string",
        "aliStoreId": "string",
        "aliTerminalParams": {
            "credential": "28763443825664394:20180207192030954:abcdefGHIJKLMN",
            "signature": "xxxxxxx",
            "terminalType": "IOT"
        },
        "aliUndiscountableAmount": 1,
        "alipayStoreId": "string",
        "qrAcqAddnData": {
            "customData": "string",
            "goodsInfos": [
                {
                    "addnInfo": "string",
                    "category": "string",
                    "id": "string",
                    "name": "string",
                    "price": "string",
                    "quantity": "string"
                }
            ],
            "orderInfo": {
                "addnInfo": "string",
                "dctAmount": "string",
                "description": "string",
                "title": "string"
            }
        },
        "qrSpecFeeInfo": "string",
        "qrCode": "string",
        "userAuthCode": "string"
    },
    "data": {
        "orgBackUrl": "string",
        "orgFrontUrl": "string",
        "payerId": "string",
        "payerOtherInfo": "string",
        "tradeCode": "string",
        "tradeAmt": 1,
        "timeoutMinutes": 60,
        "orderInfo": "string",
        "infoAttach": "string",
        "delaySettleFlag": "string",
        "patnerSettleFlag": "string",
        "splitSettleFlag": "string",
        "investor": "string",
        "orgPreferentialAmt": "string",
        "wxSubAppid": "string",
        "attach": "string",
        "handingFee": "string",
        "orgSmercode": "string",
        "orgSterminalcode": "string",
        "otherfee": "string"
    },
    "orgInfo": "string"
}'

返回响应

🟢200OK

application/json

Body

orgInfo

string

请求方自定义信息

可选

appendData

object

附加请求数据

可选

仅正向交易需要

disCount

object

优惠详情

可选

备注:长度：6000

payDetail

object

交易支付使用的资金

可选

riskInfo

object

风险控制信息

可选

data

object

业务请求数据

可选

签名数据

appendRetcode

string

附加状态码，一般为支付渠道原文返回

可选

appendRetmsg

string

附加状态描述，一般为支付渠道原文返回

可选

finRetcode

string

交易状态码

可选

tradeCode

string

交易码-->showDoc

必需

outCdnoType

string

转出卡类型

可选

outTrace

string

请求渠道-订单号

可选

patnerSettleFlag

string

正常情况下按请求报文，原文返回

可选

pcTrace

string

渠道返回-订单号。支付宝调用凭证，前端实现指引：https://opendocs.alipay.com/open/common/105591#alipay.trade.create%20(%E7%BB%9F%E4%B8%80%E6%94%B6%E5%8D%95%E4%BA%A4%E6%98%93%E5%88%9B%E5%BB%BA%E6%8E%A5%E5%8F%A3)

可选

qrRedirectUrl

string

重定向地址，云闪付支付调用凭证

可选

riskInfo

string

风险控制信息

可选

tradeAmt

integer <int64>

交易金额

可选

userId

string

用户唯一编码

可选

wxPrepayId

string

微信，预支付交易会话标识

可选

wxWcPayData

string

微信，支付调用凭证。前端实现指引：微信:https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=23_9&index=1#menu1.1

可选

sign

string

签名

可选

sysRetcode

string

系统码

可选

备注:000000

sysRetmsg

string

系统码

可选

success

示例

{
    "orgInfo": "string",
    "appendData": {
        "disCount": {
            "aliDiscountGoodsDetail": "string",
            "qrCouponInfo": [
                {
                    "addnInfo": "string",
                    "desc": "string",
                    "id": "string",
                    "offstAmt": "string",
                    "spnsrId": "string",
                    "type": "string"
                }
            ],
            "wxPromotionDetailInfo": "string"
        },
        "payDetail": {
            "aliFundBillList": [
                {
                    "amount": "string",
                    "bank_code": "string",
                    "fund_channel": "string",
                    "fund_type": "string",
                    "real_amount": "string"
                }
            ],
            "aliHbFqPayInfo": "string",
            "qrPayerInfo": {
                "accNo": "string",
                "acctClass": "string",
                "cardAttr": "string",
                "certifId": "string",
                "certifTp": "string",
                "cvn2": "string",
                "expired": "string",
                "issCode": "string",
                "mobile": "string",
                "name": "string",
                "payerBankInfo": "string"
            },
            "qrPayerInfoStr": "string",
            "unqrappInfo": {
                "prepayId": "string",
                "unqrappAccNo": "string",
                "unqrappAccessType": "string",
                "unqrappAcqInsCode": "string",
                "unqrappBizType": "string",
                "unqrappCardTransData": "string",
                "unqrappExchangeDate": "string",
                "unqrappExchangeRate": "string",
                "unqrappMerId": "string",
                "unqrappOrigQryId": "string",
                "unqrappPayCardType": "string",
                "unqrappReqReserved": "string",
                "unqrappReserved": {
                    "activityId": "string",
                    "activityNm": "string",
                    "addnPrintInfo": "string",
                    "cardNumberLock": "string",
                    "customerId": "string",
                    "discountAmt": "string",
                    "discountCode": "string",
                    "fundComCode": "string",
                    "fundProCode": "string",
                    "fundProType": "string",
                    "mchtDiscountAmt": "string"
                },
                "unqrappTraceNo": "string",
                "unqrappTxnSubType": "string",
                "unqrappTxnTime": "string",
                "unqrappTxnType": "string",
                "unqrappVersion": "string"
            },
            "wxBankType": "string"
        },
        "riskInfo": {
            "riskInfo": "string",
            "userId": "string"
        }
    },
    "data": {
        "appendRetcode": "string",
        "appendRetmsg": "string",
        "finRetcode": "string",
        "tradeCode": "string",
        "outCdnoType": "string",
        "outTrace": "string",
        "patnerSettleFlag": "string",
        "pcTrace": "string",
        "qrRedirectUrl": "string",
        "riskInfo": "string",
        "tradeAmt": 0,
        "userId": "string",
        "wxPrepayId": "string",
        "wxWcPayData": "string"
    },
    "sign": "string",
    "sysRetcode": "string",
    "sysRetmsg": "string"
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found