• 简体中文
  • 创建订单

    请求路径

    /api/v2/payment/merchant/createorder

    参数列表

    名称类型长度必填描述
    orderIdString32是商户唯一订单号,可用于查询交易结果
    titleString100否订单标题
    descriptionString200否订单描述
    userIdString50否用户在商户端的唯一Id
    userMobileNoString15否用户手机号码,在收银台页面会回填输入框 兼容多种格式 e.g. 07011698742 or 7011698742 or 023307011698742 or 02337011698742 区号格式
    customerInfoString-否JSON string格式,详见:客户信息(CustomerInfo);若为巴基斯坦收单,部分信息必填
    amountLong-是交易金额(精确到分,如“100”代表1 GHS) 最小金额:100
    currencyString10是货币代码(GHS、TZS、KES、PKR)
    accessModeString-否接入模式:若使用 PalmPay 收银台页面,传 redirect; 若不使用 PalmPay 收银台页面,传 direct; accessMode 如果传 direct,需要输入 payer 信息,且巴基斯坦需要进行主动拉端处理,见 拉端参数; 不传值默认 redirect
    allowedWalletString-否JSONArray string格式,收银台上显示的钱包,不传即全部展示。详见 钱包。
    payerString-否JSON string格式,付款人信息,详见:Payer(accountNo必填,bankCode部分国家必填,请与我们联系)
    notifyUrlString200是接收交易结果通知url
    callBackUrlString200是支付完成后H5页面返回商户指定url地址
    orderExpireTimeInteger-否订单有效期时长,单位:秒 即未付款订单的过期时间,默认值:1800(30mins) 区间:1800s≤orderExpireTime≤86400s (最长不为24小时,最短为30mins)
    goodsDetailsString-是/否JSONArray string格式,详见:商品详情列表;国际客户必填
    remarkString200否备注信息
    productTypeString100是固定传mmo
    splitDetailString-否JSON string格式,详见:分账详情,如果需要分账,则必填
    extraFieldListString-否扩展字段,JSON array格式,列表最大长度为5,会在订单详情页及订单导出中展示

    注意事项

    1. 对于巴基斯坦收银台,若您通过 web view 打开,请注意对钱包供应商进行白名单处理。

    返回值

    名称类型长度必填描述
    orderNoString32是PalmPay平台订单号
    orderStatusInteger20是订单状态(见订单状态)
    messageString50否状态描述信息
    checkoutUrlString200是拉起H5支付的url
    currencyString10是货币代码(GHS、TZS、KES、PKR)
    orderAmountLong-是交易金额(最小单位计量)

    错误码

    参见此文

    Postman请求示例

    request

    curl--location'https://open-gw-sandbox.palmpay-inc.com/api/v2/payment/merchant/createorder' \
            --header'Accept: application/json, text/plain, */*' \
            --header'CountryCode: GH' \
            --header'Authorization: Bearer 10241024' \
            --header'Signature: D11A3E8CB478C0B0F40276DDA5AFD898' \
            --header'Content-Type: application/json' \
            --data'{
            "requestTime":1662171389940,
            "version":"V1.1",
            "nonceStr":"IBJGAeTa4ZJQv4Z2qufomVo9eI1YnJ9Y",
            "amount":200,
            "notifyUrl":"https://xx.cn/callback/payment",
            "orderId":"testc9ffae997fc1",
            "accessMode":"redirect",
            "title":"pay",
            "description":"pay some thing",
            "userId":"110",
            "currency":"GHS",
            "callBackUrl":"http://returnurl",
            "goodsDetails":"[{\"goodsId\": \"1\"}]",
            "productType":"mmo",
            "splitDetail":"{\"isSplit\":true,\"splitAmountType\":1,\"splitFeeType\":1,\"splitMerchantList\":[{\"splitMerchantId\":\"A\",\"splitAmount\":100,\"remark\":\"A商户被分账1奈拉\"},{\"splitMerchantId\":\"B\",\"splitAmount\":100,\"remark\":\"B商户被分账1奈拉\"}]}",
            "extraFieldList":"[\"123\",\"456\"]"
            }'

    response

    {
      "respCode": "00000000",
      "respMsg": "success",
      "data": {
        "orderNo": "2424220903032435363613",
        "orderStatus": 0,
        "message": "success",
        "checkoutUrl": "https://openapi.transspay.net/open-api/api/v1/payment/h5/redirect?orderNo=2424220903032435363613&userId=110&sign=18FC68963B01E5B2EBE71A59F5D70AE70D66D4798F11B1632B08B4EB084948DC&key=4cca233f40b1dfb1b4600c7dfdaf3ee2",
        "orderAmount": 200,
        "currency": "GHS"
      }
    }