# 付款
商户业务系统通过付款接口发起付款申请，支付网关将根据请求数据传入到对应的上游接口。
# 付款接口
接口
请求API: /api/transferOrder
请求方式: POST
请求类型：application/json 或 application/x-www-form-urlencoded
# 请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商户号 | mchNo | 是 | String(30) | M1621873433953 | 商户号 |
| 应用ID | appId | 是 | String(24) | 60cc09bce4b0f1c0b83761c9 | 应用ID |
| 商户订单号 | mchOrderNo | 是 | String(30) | 20160427210604000490 | 商户生成的付款订单号 |
| 入账方式 | entryType | 是 | String(20) | PIX_XX | 付款渠道 |
| 付款金额 | amount | 是 | int | 100 | 付款金额,单位分 |
| 国家 | country | 是 | String(2) | US | 国家二字码 |
| 货币代码 | currency | 是 | String(3) | USD | 三位货币代码 |
| 费用承担方 | feeBear | 是 | String(32) | merchant | 费用承担方 merchant-商户承担 beneficiary-收款人承担 |
| *收款账号 | accountNo | 是 | String(64) | o6BcIwvTvIqf1zZZohc61biryWik | 收款人账户Id |
| *账户类型 | accountType | 否 | String(32) | account | 收款人账户类型 |
| *收款人姓名 | accountFullName | 否 | String(64) | Sky Wong | 收款人全名 |
| *FirstName | accountFirstName | 否 | String(64) | Sky | 名字 |
| *MiddleName | accountMiddleName | 否 | String(64) | sw | 中间名 |
| *LastName | accountLastName | 否 | String(64) | Wong | 姓氏 |
| *证件ID | documentId | 否 | String(64) | 12345678 | 收款证件ID |
| *证件签发日期 | docIssueDate | 否 | String(10) | 20230101 | 签发日期(yyyyMMdd) |
| *出生日期 | birthDate | 否 | String(10) | 20230101 | 出生日期(yyyyMMdd) |
| *手机号 | phone | 否 | String(20) | 764346789 | 手机号 |
| *所在城市 | city | 否 | String(32) | London | 所在城市 |
| *邮编 | postcode | 否 | String(16) | E4 7FH | 邮编 |
| *详细地址 | address | 否 | String(128) | Epping Forest District | 详细地址 |
| *收款人开户行ID | bankCode | 否 | String(64) | ACEH | 开户行ID |
| *收款人开户行名称 | bankName | 否 | String(64) | Bank Name | 银行名称 |
| *银行支行 | bankBranch | 否 | String(64) | Bank Name on where | 银行支行名称 |
| *邮箱 | 否 | String(128) | enjoy@enjoypayment.com | 收款人邮箱 | |
| 客户端IP | clientIp | 否 | String(32) | 210.73.10.148 | 客户端IPV4地址 |
| 付款备注信息 | transferDesc | 否 | String(128) | 测试付款 | 付款备注信息 |
| 异步通知地址 | notifyUrl | 否 | String(128) | https://merchant.com/testNotify/y01 | 付款完成后回调该URL,只有传了该值才会发起回调 |
| 扩展参数 | extraParam | 否 | String(512) | 134586944573118714 | 商户扩展参数,回调时会原样返回 |
| 请求时间 | reqTime | 是 | long | 1622016572190 | 请求接口时间,13位时间戳 |
| 接口版本 | version | 是 | String(3) | 1.0 | 接口版本号，固定：1.0 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值，详见签名算法 |
| 签名类型 | signType | 是 | String(32) | MD5 | 签名类型，目前只支持MD5方式 |
注意
带*号的参数根据不同的付款方式为可选必填参数,具体请参考"付款渠道支持列表"
# 请求示例数据
{
"entryType":"PIX",
"amount":1,
"accountName":"",
"mchOrderNo":"mho1629106169045",
"sign":"3EB5A3B81E92DB41677E235363E7DDE3",
"transferDesc":"测试付款",
"reqTime":"1629106169",
"version":"1.0",
"appId":"60cc3ba74ee0e6685f57eb1e",
"accountNo":"a6BcIwtTvIqv1zZZohc61biryWok",
"clientIp":"192.166.1.132",
"signType":"MD5",
"currency":"USD",
"mchNo":"M1623997351"
}
# 返回参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态 | code | 是 | int | 0 | 0-处理成功，其他-处理有误，详见错误码 |
| 返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因，例如：签名失败、参数格式校验错误 |
| 签名信息 | sign | 否 | String(32) | CCD9083A6DAD9A2DA9F668C3D4517A84 | 对data内数据签名,如data为空则不返回 |
| 返回数据 | data | 否 | String(512) | {} | 返回下单数据,json格式数据 |
# data数据格式
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 付款订单号 | transferId | 是 | String(30) | T202108161731281310004 | 返回付款订单号 |
| 商户付款单号 | mchOrderNo | 是 | String(30) | mho1624007315478 | 返回商户传入的付款单号 |
| 货币代码 | currency | 是 | String(3) | USD | 三位货币代码 |
| 付款金额 | amount | 是 | String(long) | 100 | 付款金额,单位分 |
| 到账金额 | arrivalAmount | 是 | String(long) | 100 | 到账金额,单位分 |
| 费用承担方 | feeBear | 是 | String(32) | merchant | 费用承担方 merchant-商户承担 beneficiary-收款人承担 |
| 付款状态 | state | 是 | int | 2 | 付款状态 0-订单生成 1-付款中 2-付款成功 3-付款失败 4-付款关闭 |
| 渠道错误码 | errCode | 否 | String | PAYMENT_AUTH_CODE_INVALID | 上游渠道返回的错误码 |
| 渠道错误描述 | errMsg | 否 | String | Business Failed | 失败 |
# 返回示例数据
{
"code": 0,
"data": {
"accountNo": "1",
"amount": "11",
"channelOrderNo": "20210816110070001506260000372216",
"mchOrderNo": "1629106288",
"state": 2,
"transferId": "T202108161731281310004"
},
"msg": "SUCCESS",
"sign": "195BF6F112386F7FC8EA2AA7EECA1D33"
}