Place Order API

For orders placed with realtime products, the maximum response time is 120 seconds

A unique reference ID needs to be sent for every unique order in the "poNumber" parameter

We strongly recommend storing the request and response of every "PlaceOrderAPI" call

Place Order API Schema

Parameter	Type	Description
productId	Int	Unique ID of the product to be ordered.
quantity	Int	Number of units to be ordered.
denomination	Float	Value/amount of the voucher or reward.
email	String	Recipient’s email address.
contact	String	Recipient’s contact number.
poNumber	String	Purchase Order number to avoid duplicate orders.
tag	String	Custom tag to identify or categorize the order.
notifyAdminEmail	Int (0/1)	Flag to notify admin via email (1 = Yes, 0 = No).
notifyReceiverEmail	Int (0/1)	Flag to notify recipient via email (1 = Yes, 0 = No).

Implementation Notes

To avoid facing an error while placing an order, please pass the valid productID and denomination
The maximum order quantity allowed for the majority of the products is 10 unless mentioned otherwise in the "orderQuantityLimit" parameter in the GetVouchersAPI
Certain brands require a phone number to process the order. You can refer to the "isPhoneNumberMandatory" parameter in the GetVouchersAPI to identify the products with this mandate
Should you wish to notify the recipient via email, please pass "1" in the "notifyReceiverEmail" parameter
We recommend you store the "poNumber" that you pass in the request and the "orderID" you receive in the response
The "type" parameter indicates the type in which the voucher is delivered. The 4 types are as follows:
1. code
2. codePin
3. url
4. urlPin
Should you get a 5xx error from the PlaceOrderAPI, please call GetOrderDetails and confirm if an order exists using the poNumber. If there's no order against the poNumber, you can go ahead and place another order

Learn how to manage webhooks to receive order status updates for delayed product types.