申请付款
- Endpoint:
POST /v2/delSuffixStart10 - Tags: 出款
Description
此接口为API付款接口，该接口返回参数请注意以下事项，否则可能会有资损风险：
- 当"bizCode": "0000"且返回tradeNo，代表下单成功，订单状态请以回调或查询接口status为准；
- 当"bizCode": "4000"且"message": "Duplicate orderId/orderId already exist"，代表该orderId已经下过单，请等待回调或查询接口确认订单状态，每次下单需确保orderId唯一；
- 其他场景请检查参数后，不换orderId重新发起；
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 |
|---|---|---|---|---|---|
version | string | Yes | 接口版本 | ||
bizType | string | Yes | maxLength: 32 | 接口业务代码，此处需传入“singlePayment” | |
merchantId | string | Yes | maxLength: 32 | PayerMax 分配给商户的唯一标识 | |
orderId | string | Yes | maxLength: 63 | 商户订单号，只能包含字母、数字、下划线。每次调用下单时不能重复 | |
userId | string | No | maxLength: 64, minLength: 0 | 商户内部的用户Id，需要保证每个ID唯一性 | |
riskParams | string | No | maxLength: 10240, minLength: 0 | 风控业务数据， registerNo：商户网站/app上用户的注册标识，选填，最长128位 nickName：商户网站/app上用户的昵称，选填，最长128位 registerName：注册账号持有人姓名，选填，最长128位 thirdAccountNoType：第三方 帐户类型：枚举值 Facebook, Google, AppleID，Others ，选填，最长128位 thirdAccountNo：第三方账号标识，选填，最长128位 bindEmail：账号绑定邮箱，选填，最长64位 bindPhoneNo：账号绑定手机号，选填，最长32位 regTime：账号注册时间，格式：yyyy-MM-dd HH:mm:ss，选填，最长32位 accountLevel：账号等级，选填，最长64位 vipLevel：VIP等级，选填，最长64位 liveCountry：现居住地址（国家维度）。如：CN，选填，最长128位 lastLoginTime：最后一次登录/活跃时间，格式：yyyy-MM-dd HH:mm:ss，选填，最长32位 cumPayoutAmount：用户在商户侧，最近3个月累计出款成功金额（USD），选填，最长20位 cumPayoutTxn：用户在商户侧，最近3个月累计出款成功笔数，选填，最长128位 accountBalance：用户在商户侧，用户账号当前余额 (金币/钻石)，选填，最长128位 expressMerchantID：针对平台类商户下，在平台注册的卖家注册账号，选填，最长128位 taxID：用户税号，选填，最长128位 | |
bizModel | string | No | maxLength: 30 | 对应所签约付款服务的业务类型， 仅在交易国家为印度时必填：CB | |
countryCode | string | Yes | maxLength: 32 | 收款方所在国家代码，大写字母，参见【支持的国家与币种】 | |
chargeOption | string | No | 费用承担模式，是否必传参照《付款申请模板及填写规范》 | ||
clearingRail | string | No | 枚举值为：SWIFT, SEPA, LOCAL，分别对应签约的SWIFT、SEPA、Local Banks支付方式，请根据实际要用的支付方式来上送，请参照《付款申请模板及填写规范》 | ||
currency | string | Yes | maxLength: 3 | 付款金额对应货币代码，大写字母，参见【支持的国家与币种】 | |
paymentMethodType | string | No | maxLength: 64 | 支付方式类型，参见【支付方式类型及目标机构说明】 | |
targetOrg | string | No | 目标机构，参见【支付方式类型及目标机构说明】 | ||
payeeType | string | No | maxLength: 16 | 收款方类型（PERSONAL/CORPORATION），默认PERSONAL | |
amount | number | Yes | max: 9999999999, min: 0 | 付款金额，单位元，小数点后最多支持2位。 注意：印尼，越南，韩国，智利，巴基斯坦，哥伦比亚地区，本币不支持带小数金额 | |
payeeAccount | string | Yes | maxLength: 64 | 收款方账号，根据付款方式不同填入相应账号 | |
payeeAccountType | string | No | maxLength: 5 | 收款账户类型,在不同国家-支付方式下规范不同 | |
payeeName | string | No | maxLength: 100 | 收款方姓名，在不同国家-支付方式下填写规范不同 | |
payeePhone | string | No | maxLength: 32 | 收款方移动电话号码，在不同国家-支付方式下填写规范不同 | |
payeeDocumentType | string | No | maxLength: 5 | 收款方个人身份证明类型，在不同国家下可选类型不同，参见《付款申请模板及填写规范》 | |
payeeDocumentId | string | No | maxLength: 50 | 收款方个人识别号码，在不同国家下可选类型不同，参见《付款申请模板及填写规范》 | |
payeeDocumentDate | string | No | maxLength: 10 | 收款方个人识别号码对应日期，在不同国家下可选类型不同，yyyy-MM-dd格式 | |
payeeBirthDate | string | No | maxLength: 10 | 收款方出生日期，yyyy-MM-dd格式 | |
payeeNationality | string | No | maxLength: 2 | 收款人国籍，ISO 3166-1 alpha-2标准，如CN，US | |
payeeGender | string | No | maxLength: 1 | 收款人性别，枚举值F 或M（F=Female，M=Male） | |
payeeBirthCountry | string | No | maxLength: 2 | 收款人出生国家，ISO 3166-1 alpha-2标准，如CN，US | |
payeeBankCode | string | No | maxLength: 32 | 用于识别特定金融机构下的收款方银行代码，在不同国家下填写规范不同，参见【付款申请模板及填写规范】以及【支持银行范围列表】 | |
payeeBankName | string | No | maxLength: 100 | 收款方银行名称 | |
payeeBankBranch | string | No | maxLength: 6 | 收款人银行网点号/分行号 | |
checkDigit | string | No | maxLength: 4 | 收款方账户验证数字 | |
payeeCorAccount | string | No | maxLength: 64 | 收款方银行的代理账号（correspondent account） | |
payeeBankCity | string | No | maxLength: 64 | 收款方银行所在城市 | |
notifyAddress | string | No | maxLength: 128 | 收款方通知邮件地址，在支持通知收款方的支付方式下，可按照规范传入通知地址，不传则默认不通知 | |
email | string | No | maxLength: 64 | 收款方邮箱 | |
city | string | No | maxLength: 64 | 收款方所在城市 | |
payeePostCode | string | No | maxLength: 64 | 收款方所在地邮政编码 | |
address | string | No | maxLength: 100 | 收款方地址， 允许英文，数字，中划线，空格，点；受渠道约束，该字段可能会进行特殊处理，如超长截断或填充默认值。 | |
transactionNote | string | No | maxLength: 100 | 出款附言或备注，允许英文，数字，中划线，空格，点；受渠道约束，该字段可能会进行特殊处理，如超长截断或填充默认值； | |
expiryDays | string | No | maxLength: 3 | 取款码有效天数，当前仅在埃及的FawryCash中有效，支持传入1~15整数（1=24Hours），其他值或不传则默认为7 | |
passBackParams | string | No | maxLength: 256 | 透传数据，在付款异步回调通知中原样返回，该字段主要用于商户携带订单的自定义数据 | |
sourceAccount | string | No | maxLength: 3 | 指定扣款账户（币种） | |
destinationCurrency | string | No | maxLength: 3 | 指定到账币种 | |
state | string | No | maxLength: 8 | 地址，州 | |
purpose | string | No | maxLength: 32 | 出款目的，枚举值，ISUBIL:向公用事业提供商付款(i.e.水电煤账单)； EPTOUR:旅游业； EPTKAG:支付旅游门票或旅行社费用； ISPAYR:支付工资； ISPAYRA:支付代理工资； ISGDDS:货物买卖； ISSCVE:购买和销售服务； ISSUPP:供应商付款； ISLOGS:物流和运输服务付款； INCEN:激励/促销/用户获取活动； GAME:游戏设备、游戏币和其他游戏物品； SAMENM:企业同名账户转账； PAYCMSN:报销/福利发放/佣金发放； SAMENMC:法人/股东/董事个人账户； AGOPEXP:代运营费用结算； ADEXP:广告费用结算；RFND:退货；SMCNTST:子商户结算；LGTEP:供应商付款-物流费用结算；GOODPAY:供应商付款-货款结算；SINVEST:股票投资；FINVEST:基金投资；TAXPAY:纳税/支付税款；LOANPAY:支付贷款； OTHER:其他； | |
businessLegalName | string | No | maxLength: 70 | 付款公司主体注册名 | |
registrationCountry | string | No | maxLength: 2, minLength: 2 | 付款公司主体注册国家，2位大写国家编码 | |
merchantCategoryCode | string | No | 付款公司行业分类，枚举值，DIGITAL_GOODS_MEDIA：数娱类产品-媒介；DIGITAL_GOODS_APPLICATION：数字产品-应用软件类；TRAVEL_AGENCIES_AND_TRAVEL_RELATED_SERVICES：旅行社；COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS：快递服务-空运、陆运及货物运输代理商；ADVERTISING_SERVICES：广告业务；TELECOMMUNICATION_SERVICE：电信服务；COMPUTER_NETWORKS_AND_INFORMATION_SERVICES：计算机网络/信息服务；MISCELLANEOUS_GENERAL_MERCHANDISE：电商-杂项百货。 | ||
payerId | string | No | maxLength: 70 | 付款公司所属机构/平台商户号 | |
callbackUrl | string | No | maxLength: 256 | 商户接收付款结果的后台回调地址，以http/https开头 |
Example
json
{
"amount": 12,
"bizType": "singlePayment",
"orderId": "WD16764533552zzz3111",
"userId": "abc123456789",
"riskParams": "{\"registerName\":\"lily\",\"regTime\":\"2023-07-01 12:08:34\",\"liveCountry\":\"VN\",\"payerAccount\":\"987654XXX\",\"payerName\":\"lily\",\"taxId\":\"1234567890\"}",
"version": "2.0",
"paymentMethodType": "WALLET",
"targetOrg": "DANA",
"merchantId": "SP12345678",
"countryCode": "ID",
"currency": "IDR",
"payeeAccount": "081212345678",
"payeeBankCity": "CN",
"payeeAccountType": "C",
"payeeBirthDate": "2000-03-29",
"payeeNationality": "ID",
"payeeGender": "M",
"payeeBirthCountry": "ID",
"checkDigit": "1",
"destinationCurrency": "IDR",
"sourceAccount": "IDR",
"address": "ShangHai, China",
"passBackParams": "velit ad et ullamco",
"email": "example@gmail.com",
"payeeCorAccount": "1234567",
"payeeType": "PERSONAL",
"payeeBankBranch": "ABC",
"purpose": "GAME",
"payeeName": "payee's name",
"payeePhone": "08123456789",
"callbackUrl": "http://example.com/callback/",
"notifyAddress": "example@gmail.com",
"payeeBankName": "ICBC",
"payeeDocumentType": "S",
"transactionNote": "deserunt anim dolore dolor in",
"bizModel": "CB",
"expiryDays": "7",
"payeePostCode": "0987",
"payeeDocumentId": "58786868",
"payeeDocumentDate": "2005-11-30",
"payeeBankCode": "NBCD",
"state": "",
"city": "ShangHai"
}Responses
200
| Field | Type | Required | Constraints | Description | Enum |
|---|---|---|---|---|---|
data | object | Yes | 具体返回数据 | ||
data.tradeNo | string | Yes | PayerMax 平台订单号 | ||
data.orderId | string | Yes | 商户订单号 | ||
bizCode | string | Yes | 接口响应码，仅代表接口调用的结果。 交易的状态请以回调接口及查询接口中的status 为准。 | ||
message | string | Yes | 接口响应描述 |
Response Example: 1
成功示例
json
{
"data": {
"tradeNo": "20230428081551DO4429724600475529002",
"orderId": "12re32wdds2342343454354r3123"
},
"bizCode": "0000",
"message": "success"
}Response Example: 2
异常示例
json
{
"msg": "System is busy, please try again later.",
"code": "SYSTEM_ERROR"
}