• 简体中文
  • 创建订单

    请求路径

    /api/v2/payment/merchant/createorder

    参数列表

    名称类型长度必填描述
    orderIdstring32是商户唯一订单号,可用于查询交易结果
    titlestring100否订单标题
    descriptionstring200否订单描述
    userIdstring50否用户在商户端的唯一id
    userMobileNoString15否用户手机号码,在收银台页面会回填输入框 兼容多种格式 e.g. 07011698742 or 7011698742 or 023407011698742 or 02347011698742 区号格式
    amountLong-是交易金额(最小单位为分) 最小金额:100NGN
    currencyString10是货币(NGN)
    notifyUrlstring200是接收交易结果通知url
    callBackUrlstring200是支付完成后H5页面返回商户指定url地址
    orderExpireTimeInteger-否订单有效期时长,单位:秒 即未付款订单的过期时间,默认值:1800(30分钟) 区间:1800s≤orderExpireTime≤86400s (最长不为24小时,最短为30mins)
    remarkstring200否备注信息
    goodsDetailsString-是/否JSONArray string格式,详见:商品详情列表(GoodsDetail);国际客户必填
    customerInfoString-是JSON string格式,详见:客户信息(CustomerInfo)
    productTypestring100是固定传bank_transfer
    splitDetailString-否JSON string格式,详见:分账详情,如果需要分账,则必填
    extraFieldListString-否扩展字段,JSON array格式,列表最大长度为5,会在订单详情页及订单导出中展示

    返回值

    名称类型长度必填描述
    orderNostring32是PalmPay平台订单号
    orderStatusInteger20是订单状态(见订单状态)
    messagestring50否状态描述信息
    checkoutUrlstring200否拉起H5支付的url
    payerAccountTypeInteger20否账户类型(pay with bank transfer使用-1)
    payerAccountIdstring200否账户唯一id(当-1时返回)
    payerBankNamestring200否虚拟账户的银行(当-1时返回)
    payerAccountNamestring200否虚拟账户的名字(当-1时返回)
    payerVirtualAccNostring200否虚拟账户号(当-1时返回)
    payTokenString200是拉起SDK支付需要的参数
    sdkSessionIdString32是安全动态秘钥拉起SDK所需参数
    sdkSignKeyString32是安全动态秘钥拉起SDK所需参数
    currencyString10是货币代码(NGN、GHS、TZS、KES、ZAR)
    orderAmountLong-是交易金额(最小单位计量)

    Remark:

    如需自定义页面,可以使用📄查询订单结果该接口获取订单页面参数(包含订单状态,虚拟号,有效期等信息)

    错误码

    参见此文

    Postman请求示例

    request

    curl --location 'https://open-gw-sandbox.palmpay-inc.com/api/v2/payment/merchant/createorder' \
    --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",
        "amount":200,
        "notifyUrl":"https://xx.cn/callback/payment",
        "orderId":"testc9ffae997fc1",
        "title":"pay",
        "description": "pay some thing",
        "userId":"110",
        "userMobileNo":"07011698742",
        "currency": "NGN",
        "callBackUrl": "http://returnurl",
        "goodsDetails": "[{\"goodsId\": \"1\"}]",
        "productType":"bank_transfer",
        "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": 1,
        	"message": "success",
        	"checkoutUrl": "https://openapi.transspay.net/open-api/api/v1/payment/h5/redirect?orderNo=2424220903032435363613&userId=110&sign=18FC68963B01E5B2EBE71A59F5D70AE70D66D4798F11B1632B08B4EB084948DC&key=4cca233f40b1dfb1b4600c7dfdaf3ee2",
        	"payMethod": "bank_transfer",
            "orderAmount": 200,
            "currency": "NGN",
            "payerBankName": "PalmPay",
            "payerVirtualAccNo": "8754982724",
            "payerAccountName": "testMerchantName(Pay NGN 2.00)"
      }
    }