• 简体中文
  • 发起商户余额代付

    注意事项

    1. 若接口未正常返回信息,可能发生了网络或者系统异常。此时,商户不能直接当做Pay Out成功或失败处理。建议通过查询接口来查询交易结果的最终状态。
    2. 若使用相同单号多次调用创建订单接口,接口会返回报错MC100000。建议通过查询接口来查询交易结果的最终状态。

    请求路径

    /api/v2/merchant/payment/payout

    参数列表

    名称类型长度必填描述
    orderIdString32是商户唯一订单号,可用于查询交易结果
    titleString100否订单标题
    descriptionString200否订单描述
    payeeNameString50否收款方姓名(如果不传,默认为值是unknow) 若为巴基斯坦,建议填写
    payeeBankCodeString50坦桑:否 其他:是收款方银行或MMO编码
    payeeBankAccNoString50是收款方银行账户或MoMo账户 账号为纯数字,不能带空格或特殊符号
    payeePhoneNoString50否收款方手机号,此号码必须带上国家号,e.g. 023301234567890 若出金到加纳,则传值加纳收款人接收转账短信通知,不传则不发; 若为巴基斯坦,建议填写
    payeeEmailString50否收款方邮箱。若为巴基斯坦,建议填写。
    amountLong20是交易金额(最小单位计量),例如"100"为1GHS\NGN\TZS
    currencyString10是货币(NGN、GHS、TZS、KES、ZAR、PKR)
    notifyUrlString200是接收代付结果通知url
    remarkString200否备注信息

    返回值

    名称类型长度必填描述
    currencyString10是货币代码(NGN、GHS、TZS、KES、ZAR、PKR)
    amountLong20否订单金额(最小单位计量) 只有当 orderStatus=2 时才会有值
    feefee20否手续费总额(最小单位计量) 只有当 orderStatus=1 or 2 时才会有值 fee:{ fee: 0, vat: 0}
    orderNoString32是PalmPay返回的订单号
    orderIdString32是商户原始订单号
    orderStatusInteger20是订单状态(见订单状态)
    sessionIdString128否渠道响应参数,注:大部分非NIBSS通道不返回sessionId,此类订单若有问题需提供订单号找PalmPay和银行确认用户实际到账情况
    messageString20否订单状态描述信息
    errorMsgString200否错误信息

    错误码

    参见此文

    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"
      }
    }