• English
  • Create Order

    Request Path

    /api/v2/payment/merchant/createorder

    Parameter List

    NameTypeLengthRequiredDescription
    orderIdString32YesThe unique Order Number of the merchant, which can be used to query transaction results.
    titleString100NoOrder title
    descriptionString200NoOrder description
    amountLong-YesTransaction amount (Unit of measurement: cent; For example, "100" means 1 ZAR) Minimum amount: 100
    currencyString10YesCurrency Code(ZAR)
    notifyUrlString200YesNotification url to receive transaction result
    callBackUrlString200YesAfter the payment is completed, the H5 page returns the url specified by the merchant
    goodsDetailsString-Yes/NoJSONArray string format, see:Goods Detail;required for global merchants
    remarkString200NoRemarks
    productTypeString100YesFixed transfer instant_eft

    Return Value

    NameTypeLengthRequiredDescription
    orderNoString32YesPalmPay platform Order No.
    orderStatusInteger20YesOrder Status(seeOrder Status)
    messageString50YesStatus description
    checkoutUrlString200YesURL that pull up the H5 payment
    currencyString10YesCurrency (NGN)
    orderAmountLong-YesTransaction amount

    Error Code

    Error Code

    Postman Example

    request

    curl--location'https://open-gw-sandbox.palmpay-inc.com/api/v2/payment/merchant/createorder' \
            --header'Accept: application/json, text/plain, */*' \
            --header'CountryCode: ZA' \
            --header'Authorization: Bearer 10241024' \
            --header'Signature: D11A3E8CB478C0B0F40276DDA5AFD898' \
            --header'Content-Type: application/json' \
            --data'{
            "productType": "instant_eft",
            "requestTime": 1761209294351,
            "version": "V1.1",
            "nonceStr": "IBJGAeTa4ZJQv4Z2qufomVo9eI1YnJ9Y",
            "amount": 35000,
            "notifyUrl": "https://xx.cn/callback/payment",
            "orderId": "merchantOrderId",
            "currency": "ZAR",
            "callBackUrl": "http://callBackUrl.com",
            "goodsDetails": "[{\"goodsId\": \"goodsIdgoodsId\",\"goodsName\": \"goodsNamegoodsName\"}]",
            "customerInfo": "{\"userId\":\"userIduserId\",\"userName\":\"userNameuserName\",\"phone\":\"07011698742\",\"email\":\"test@test.com\"}"
            }'

    response

    {
      "respCode": "00000000",
      "respMsg": "success",
      "data": {
        "orderNo": "2420903032435363613",
        "orderStatus": 1,
        "checkoutUrl": "https://checkout.palmpay.com/h5-checkout/?countryCode=ZA&tntCode=PALMPAYHK&xxx",
        "payToken": "eyJvcmRlck5vIjoiMjQyNDIyMDkwMzAzMjQzNTM2MzYxMyIsInVzZXJJZCI6IjExMCIsInNpZ24iOiIxOEZDNjg5NjNCMDFFNUIyRUJFNzFBNTlGNUQ3MEFFNzBENjZENDc5OEYxMUIxNjMyQjA4QjRFQjA4NDk0OERDIiwia2V5IjoiNGNjYTIzM2Y0MGIxZGZiMWI0NjAwYzdkZmRhZjNlZTIifQ==",
        "orderAmount": 35000,
        "currency": "ZAR"
      }
    }