• English
  • Create Order

    Applicable Markets: NG Nigeria | ZA South Africa

    Request path

    /api/v2/payment/merchant/createorder

    Shared between NG and ZA. Parameters are organized as: General → NG-specific → ZA-specific, with the NG / ZA columns indicating required fields per market.

    Request Parameters

    ParameterTypeLengthNGZADescription
    orderIdstring32YesYesMerchant's unique order ID (idempotency key)
    amountlong—YesYesTransaction amount (in smallest unit: cents) NG minimum: 100 NGN
    currencystring10YesYesCurrency code
    notifyUrlstring200YesYesAsynchronous notification callback URL
    callBackUrlstring200YesNoBrowser redirect URL after payment completion
    nonceStrstring—YesYesRandom string (used for signature)
    requestTimeinteger—YesYesUnix timestamp in milliseconds
    versionstring—YesYesNG: V1.1 · ZA: 2.0.0.0
    productTypestring100YesYesFixed value: bank_card
          
          
          
          
    titlestring100NoNoOrder title
    descriptionstring200NoNoOrder description
    orderExpireTimeinteger—NoNoExpiration time (seconds), default 1800, range 1800–86400
    goodsDetailsstring (JSON)—NoNoGoods details JSONArray
    customerInfostring (JSON)—YesNoCustomer information JSONObject
    remarkstring200NoNoRemarks
          
          
          
          
    accessModestring——NoDefault redirect direct – direct payment · redirect – checkout page redirect
    captureModestring——NoDefault immediate immediate – immediate payment · manual – delayed capture
    cardPayerInfostring (JSON)——YesCard info or Token. See cardPayerInfo

    Yes = Required · No = Optional · — = Not applicable for this market

    Response Fields

    FieldTypeNGZADescription
    orderNostringYesYesPalmPay platform order number
    orderStatusintegerYesYesOrder status (see Order Status)
    currencystringYesYesCurrency code
    orderAmountlongYesYesTransaction amount (in cents)
         
         
         
         
    messagestringNoNoStatus description
    checkoutUrlstringNoNoH5 checkout page URL (returned when accessMode=redirect)
    payTokenstringNoNoSDK payment parameter (returned when accessMode=redirect)
    sdkSessionIdstringNoNoSDK session ID (returned when accessMode=redirect)
    sdkSignKeystringNoNoSDK signing key (returned when accessMode=redirect)
         
         
         
         
    cardTokenstring—NoCard token (returned when rememberCard=true)
    verifyUrlstring—No3DS authentication URL (cardholder must be redirected here for verification)

    Yes = Always returned · No = Conditionally returned · — = Not returned

    ZA Pre-authorization Note: When querying an auth order (original order created with captureMode=manual), cardBrand / cardLast4 / cardCountry / eci are not returned. Use the captureInfo to locate the capture order number, then query the capture order to obtain card information.

    Example

    ZA · Card Payment Order Creation

    Applicable to: initiating an immediate payment

    curl 'https://open-gw-daily.palmpay-inc.com/api/v2/payment/merchant/createorder' \
      -H 'CountryCode: ZA' -H 'Authorization: Bearer xxx' -H 'Content-Type: application/json' \
      -d '{
        "amount": 10,
        "currency": "ZAR",
        "notifyUrl": "/callback/payment",
        "orderId": "{{$randomAlphaNumeric:32}}",
        "callBackUrl": "http://baidu.com?query=tomorrew_will_be_better",
        "nonceStr": "",
        "cardPayerInfo": "{\"cardNo\":\"4000000000000002\",\"cvv\":\"123\",\"expiryYear\":\"26\",\"expiryMonth\":\"12\",\"holderName\":\"zhangg\",\"rememberCard\":true,\"forceThreeDs\":AUTO}",
        "requestTime": 1781247874841,
        "accessMode": "direct",
        "productType": "bank_card",
        "captureMode": "immediate",
        "version": "2.0.0.0"
    }'
    {
      "respCode": "00000000",
      "respMsg": "success",
      "data": {
        "orderNo": "24260612070441956333",
        "orderStatus": 1,
        "payerAccountId": "27d8db869c0a46dfabd6260ec8526ae9",
        "mockCheckoutUrl": "https://checkout-daily.palmpay.com/h5-checkout/mock_test?countryCode=ZA&payToken=BD705B2670481166A40322457790B009&orderNo=24260612070441956333&signKey=SyHWTYv5aa94OiK2DR--tFI3RnyR5os1GFHq1ThVuxc&signSession=24260612070441956333&appId=L251103101598045421481&productType=bank_card",
        "cardToken": "27d8db869c0a46dfabd6260ec8526ae9",
        "merchantName": "caojiangling",
        "sdkSignKey": "SyHWTYv5aa94OiK2DR--tFI3RnyR5os1GFHq1ThVuxc",
        "orderAmount": 10,
        "sdkSessionId": "24260612070441956333",
        "appId": "L251103101598045421481",
        "currency": "ZAR",
        "verifyUrl": "https://ng-apptest.transspay.net/api/finance-switch-adapter/order/3ds-auth-html?upstreamRequestId=20260612D01120304310000000264581717160101&checkSum=e27f242b647939694eb50a4fdaa301938ce471333d3c0e50bf458627bafd2849",
        "goodsName": "Order",
        "merchantNo": "124073009021701",
        "payToken": "BD705B2670481166A40322457790B009"
      }
    }