#发起商户余额代付
#注意事项
- 若接口未正常返回信息,可能发生了网络或者系统异常。此时,商户不能直接当做Pay Out成功或失败处理。建议通过查询接口来查询交易结果的最终状态。
- 若使用相同单号多次调用创建订单接口,接口会返回报错MC100000。建议通过查询接口来查询交易结果的最终状态。
#请求路径
/api/v2/merchant/payment/payout#参数列表
| 名称 | 类型 | 长度 | 必填 | 描述 |
|---|---|---|---|---|
| orderId | String | 32 | 是 | 商户唯一订单号,可用于查询交易结果 |
| title | String | 100 | 否 | 订单标题 |
| description | String | 200 | 否 | 订单描述 |
| payeeName | String | 50 | 否 | 收款方姓名(如果不传,默认为值是unknow) 若为巴基斯坦,建议填写 |
| payeeBankCode | String | 50 | 坦桑:否 其他:是 | 收款方银行或MMO编码 |
| payeeBankAccNo | String | 50 | 是 | 收款方银行账户或MoMo账户 账号为纯数字,不能带空格或特殊符号 |
| payeePhoneNo | String | 50 | 否 | 收款方手机号,此号码必须带上国家号,e.g. 023301234567890 若出金到加纳,则传值加纳收款人接收转账短信通知,不传则不发; 若为巴基斯坦,建议填写 |
| payeeEmail | String | 50 | 否 | 收款方邮箱。若为巴基斯坦,建议填写。 |
| amount | Long | 20 | 是 | 交易金额(最小单位计量),例如"100"为1GHS\NGN\TZS |
| currency | String | 10 | 是 | 货币(NGN、GHS、TZS、KES、ZAR、PKR) |
| notifyUrl | String | 200 | 是 | 接收代付结果通知url |
| remark | String | 200 | 否 | 备注信息 |
#返回值
| 名称 | 类型 | 长度 | 必填 | 描述 |
|---|---|---|---|---|
| currency | String | 10 | 是 | 货币代码(NGN、GHS、TZS、KES、ZAR、PKR) |
| amount | Long | 20 | 否 | 订单金额(最小单位计量) 只有当 orderStatus=2 时才会有值 |
| fee | fee | 20 | 否 | 手续费总额(最小单位计量) 只有当 orderStatus=1 or 2 时才会有值 fee:{ fee: 0, vat: 0} |
| orderNo | String | 32 | 是 | PalmPay返回的订单号 |
| orderId | String | 32 | 是 | 商户原始订单号 |
| orderStatus | Integer | 20 | 是 | 订单状态(见订单状态) |
| sessionId | String | 128 | 否 | 渠道响应参数,注:大部分非NIBSS通道不返回sessionId,此类订单若有问题需提供订单号找PalmPay和银行确认用户实际到账情况 |
| message | String | 20 | 否 | 订单状态描述信息 |
| errorMsg | String | 200 | 否 | 错误信息 |
#错误码
#Postman请求示例
#request
curl --location 'https://open-gw-sandbox.palmpay-inc.com/api/v2/merchant/payment/payout' \
--header 'Accept: application/json, text/plain, */*' \
--header 'CountryCode: NG' \
--header 'Authorization: Bearer 10241024' \
--header 'Signature: D11A3E8CB478C0B0F40276DDA5AFD898' \
--header 'Content-Type: application/json' \
--data '{
"requestTime":1658568813705,
"version":"V1.1",
"nonceStr":"rNsxYX3R7H5tU5NG3IC4BwF8LGDvLugF",
"orderId":"e7c3784d5e2242fc00afe89ac1234",
"payeeName":"xuzheng",
"payeeBankCode":"100033",
"payeeBankAccNo":"8900000000",
"payeePhoneNo":"0591990607"
"amount":50000,
"currency":"NGN",
"notifyUrl":"https://palmpay.com/notify",
"remark":"",
}'#response
{
"respCode":"00000000",
"respMsg":"success",
"data":{
"currency":"NGN",
"amount":50000,
"fee": {
"fee": 402
},
"orderNo":"41220723093001",
"orderId":"e7c3784d5e2242fc00afe89ac1234",
"orderStatus":2,
"sessionId": "100033240509135230000500932911",
"message":"success"
}
}