#Create Order
#Request Path
/api/v2/payment/merchant/createorder#Parameter List
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| orderId | String | 32 | Yes | The unique Order Number of the merchant, which can be used to query transaction results. |
| title | String | 100 | No | Order title |
| description | String | 200 | No | Order description |
| amount | Long | - | Yes | Transaction amount (Unit of measurement: cent; For example, "100" means 1 ZAR) Minimum amount: 100 |
| currency | String | 10 | Yes | Currency Code(ZAR) |
| notifyUrl | String | 200 | Yes | Notification url to receive transaction result |
| callBackUrl | String | 200 | Yes | After the payment is completed, the H5 page returns the url specified by the merchant |
| goodsDetails | String | - | Yes/No | JSONArray string format, see:Goods Detail;required for global merchants |
| remark | String | 200 | No | Remarks |
| productType | String | 100 | Yes | Fixed transfer instant_eft |
#Return Value
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| orderNo | String | 32 | Yes | PalmPay platform Order No. |
| orderStatus | Integer | 20 | Yes | Order Status(seeOrder Status) |
| message | String | 50 | Yes | Status description |
| checkoutUrl | String | 200 | Yes | URL that pull up the H5 payment |
| currency | String | 10 | Yes | Currency (NGN) |
| orderAmount | Long | - | Yes | Transaction amount |
#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"
}
}