API收款
- Endpoint:
POST /delSuffixStart4 - Tags: 收款
Description
注意请求地址不包含括号内的接口说明
Parameters
| Field | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
sign | header | string | Yes |
Parameter Examples
sign:"FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="
Request Body
Content-Type: application/json
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
merchantId | string | Yes | maxLength: 30 | PayerMax分配给商户的唯一标识 | |
bizType | string | Yes | maxLength: 30 | 对应所签约的收款服务权限,可问询商务,印度跨境传”IN_CB”,其他地区传”CUSTOMIZE” | |
version | string | Yes | maxLength: 5 | 接口版本。当前值为:4.1 | |
orderId | string | Yes | maxLength: 63 | 商户订单号,只能包含字母、数字、下划线。每次调用下单时不能重复商户订单号生成规则,不支持大小写敏感。举例:AAA和AAa被认为是相同的。 | |
userId | string | Yes | maxLength: 64 | 商户内部的用户ID,需保证每个用户ID的唯一性,支付方式保存后会根据userId进行支付方式推荐 | |
subject | string | Yes | maxLength: 256 | 订单标题,用于收银台界面显示,建议传入商品名称 注:巴西钱包Pix不能超过43位 | |
countryCode | string | Yes | maxLength: 10 | 国家代码,大写字母,如果所传的国家码与币种不匹配,则以币种对应的地区展示收银台,除印度地区外,指定支付方式时必填,参见【支持的国家与币种】 | |
currency | string | Yes | maxLength: 3 | 货币代码,大写字母,参见【支持的国家与币种】 | |
totalAmount | string | Yes | maxLength: 12 | 商户传入的交易金额,取值范围:[1,100000000],小数点后最多支持2位。【风控行业限额】 注意:巴林、科威特、约旦、阿曼、突尼斯,本币只支持两位小数; 印尼、中国台湾、韩国、越南、智利、巴基斯坦、哥伦比亚、日本、冰岛、巴拉圭,本币不支持带小数金额。 | |
frontCallBackUrl | string | Yes | maxLength: 1024 | frontCallBackUrl,frontCallBackScheme 2个参数必须填1个。商户可区分移动或PC场景使用不同格式的回调地址。 商户指定的跳转URL,用户完成支付后会被跳转到该地址。以http/https开头 | |
frontCallBackScheme | string | No | maxLength: 1024 | APP类商户建议传入frontCallBackScheme。当同时传入2个回调地址且支付方式为 AlipayHK 时,优先跳转frontCallBackScheme地址 | |
callbackUrl | string | No | 服务端回调通知URL,在商户平台配置后可不传,以http/https开头 | ||
description | string | No | 订单附加说明 | ||
paymentDetail | string | No | 定义支付方式信息,如正确传入可跳过付款人信息搜集页。内容是Json格式字符{"paymentMethodType":"WELLET","targetOrg":"DANA","cardOrg":"""paymentTokenID":"322323287723232322","accountNo":"","email":""},如传入 这个字段,则国家码必填,且国家码需与货币编码匹配,参见【支持的国家与币种】 各字段代表含义如下: paymentTokenID:通过卡token支付时,此字段为必填,最大64位 accountNo:支付账号,针对部分钱包和UPI支付可以在下单参数中 传入账号信息缩短用户的支付流程,最大64位 email:对于埃及的部分支付方式下单需要采集用户邮箱,商户可选择上传,略过渠道采集流程,缩短路径。最大32位 paymentMethodType:支付方式,为空时,拉取所有可用支付方式,参见【支付方式列表】 targetOrg:目标机构,可以为空,如果指定目标机构,则支付方式也必须指定。 cardOrg:卡组织,当paymentMethod为CARD时,为空时会默认展示所有支持卡组 具体参见【支付方式列表】 | ||
userDetail | string | No | maxLength: 512 | 供商户提交付款人信息,如正确传入可跳过付款人信息搜集页。内容是Json格式字符,如{"referralCode":"","name":"Victor Yang","email":"wwww@cybersource.com","phoneNumber":"","districtCode":"","citizenIdNo":"","deviceId":"","ip":"","postNo":""}。 各字段代表含义如下: referralCode:根据商户的需要新增推荐支付方式维度,如设备ID、设备指纹等,使用前,请联系对接工作人员 name:付款人名5-45位,凡支付渠道需用户填写姓名,将默认取该值供用户便利选择 payerLastName: 付款人姓,凡支付渠道需用户填写姓名,将默认取该值供用户便利选择 email:付款人邮箱,凡支付渠道需用户填写邮箱,将默认取该值供用户便利选择 phoneNumber:付款人手机号,凡支付渠道需用户填写手机号,将默认取该值供用户便利选择 districtCode:付款人手机的国际区号 citizenIdNo:为付款人身份证件号 deviceId:付款人设备标识 ip:付款人设备IP地址 postNo:付款人住址邮编,凡支付渠道需用户填写邮编,将默认取该值供用户便利选择 | |
reference | string | No | maxLength: 512 | 可供商户自定义,且在回调中反馈的字段 | |
language | string | No | maxLength: 8 | 收银台页面语言 | |
showResult | string | No | maxLength: 8 | 是否使用PayerMax支付结果页0:不使用1:使用 | |
receipt | string | No | maxLength: 8 | 是否在结果显示用户获取收据入口 0:不显示,1:显示。默认显示,支持自定义 | |
expireTime | string | No | maxLength: 10 | 订单有效时长,单位为秒,最长可定义至72小时,最短30分钟。 1)expireTime 传值时 - 用户没有发起支付,取expireTime; - 用户发起了支付,取expireTime和支付方式关单时间二者的最大值。 2)expireTime 未传值时 - 取这笔订单发起过的支付方式关单时间的最大值 | |
riskParams | object | No | 详见风控业务数据【商户上送信息】 |
Example
json
{
"merchantId": "SP12345678",
"bizType": "IN_CB",
"version": "4.1",
"orderId": "1535435677359",
"userId": "ZNW89",
"subject": "3510 Gigs",
"countryCode": "IN",
"currency": "INR",
"totalAmount": "150.00",
"frontCallBackUrl": "https://****.com/redirect/developer.html",
"callbackUrl": "https://****.com/payermax/rechargeNotify",
"description": "recharge 3510 Gigs",
"paymentDetail": "{\"paymentMethodType\":\"WELLET\",\"targetOrg\":\"DANA\",\"cardOrg\":\"\",\"paymentType\":\"\",\"accountNo\":\"test@yesbank\",\"email\":\"xxx@gmail.com\"}",
"userDetail": "{\"name\":\"James\",\"phoneNumber\":\"95562642\"}",
"reference": "Item157",
"language": "en",
"showResult": "1",
"receipt": "1",
"expireTime": "1800"
}Responses
200
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
bizCode | string | Yes | maxLength: 10 | 返回码 | |
message | string | No | maxLength: 256 | 返回描述,接口报错原因提示 | |
data | object | Yes | 返回数据体,由公共参数和特定参数组成,详见下方的【data参数】 | ||
data.tradeNo | string | Yes | maxLength: 64 | payermax平台订单号 | |
data.orderId | string | Yes | maxLength: 64 | 商户订单号 | |
data.requestUrl | string | Yes | maxLength: 1024 | 跳转结果地址 | |
data.status | number | Yes | 订单状态:0-待支付,1-支付成功,2-支付失败 |
Response Example
json
{
"data": {
"tradeNo": "TRADE202208150208321114567881",
"orderId": "1535433516789",
"requestUrl": "http://cashier-dev.payermax.com/index.html#/paySDKH5/cashierH5?merchantId=SP12345678&token=HrUbWDQke6gjcFp68AW2N7DOOHjb%2F9kh7RkljKNaLR7sgSfxVG5TvBbW89RNX%2ByQIU8P9auBWBCskuJJQxtO9HNZ%2BwhMG8lYR7l12k3%2FLaP%2BxhLEBDOjICucJS1bASn0V&tradeNo=TRADE202208150208321114567881&identifyId=8641054&language=en&usePayResultType=1&frontCallBackUrl=https%3A%2F%2Fxxx.com%2Fredirect%2Fdeveloper.html",
"status": 0
},
"bizCode": "0000"
}