• 简体中文
  • 发起退款

    请求路径

    /api/v2/payment/merchant/refund

    请求参数

    名称类型长度必填描述
    appIdString32是商户APPID
    orderIdString32是商户唯一订单号,可用于查询交易结果
    originOrderIdString32是商户原订单号,需要退款的订单号
    amountLong-是退款金额(最小单位计量),支持部分退款
    payeeNameString50否收款方姓名(如果不传,默认为值是unknow) 如需,请联系BD获取接口权限
    payeeBankCodeString50否收款方银行或MMO编码 如需,请联系BD获取接口权限
    payeeBankAccNoString50否收款方银行账户或MoMo账户 账号为纯数字,不能带空格或特殊符号 如需,请联系BD获取接口权限
    payeeNameString50否收款方邮箱。若为巴基斯坦,建议填写
    payeePhoneString50否收款方手机号。若为巴基斯坦,建议填写。此号码必须带上国家号,e.g. 023301234567890
    notifyUrlString200否接收退款结果通知url,如果不填,默认使用原订单的notifyUrl
    remarkString200否备注信息

    返回值

    名称类型长度必填描述
    orderNoString32是PalmPay内部订单号
    orderIdString32是商户唯一订单号,可用于查询交易结果
    orderStatusInteger20是退款订单状态(见退款订单状态)
    sessionIdString128否渠道响应参数,注:大部分非NIBSS通道不返回sessionId,此类订单若有问题需提供订单号找PalmPay和银行确认用户实际到账情况
    messageString500是状态描述信息
    currencyString10是货币代码(NGN、GHS、TZS、KES、ZAR)
    amountLong20是退款金额(最小单位计量)

    Postman示例

    request

    curl --location 'https://open-gw-sandbox.palmpay-inc.com/api/v2/payment/merchant/refund' \
    --header 'Accept: application/json, text/plain, */*' \
    --header 'CountryCode: NG' \
    --header 'Authorization: Bearer 10241024' \
    --header 'Signature: D11A3E8CB478C0B0F40276DDA5AFD898' \
    --header 'Content-Type: application/json' \
    --data '{
        "requestTime": 1662171389940,
        "version": "V1.1",
        "nonceStr": "IBJGAeTa4ZJQv4Z2qufomVo9eI1YnJ9Y",
        "appId":"Lxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "originOrderId":"e7c3784d5e2242fc00afe89ac1234",
        "orderId":"testc9ffae997fc1",
        "amount":1000,
        "notifyUrl":"https://xx.cn/callback/payment",
        "remark":"test"
    }'

    response

    {
        "respCode": "00000000",
        "respMsg": "success",
        "data": {
            "orderNo": "2424220903032435363613",
            "orderId": "testc9ffae997fc1",
            "orderStatus": 1,
            "message": "success",
            "currency": "NGN",
            "amount": 1000
        }
    }