Create Order
POST
/api/v0/orders
order-controller
Request
Header Params
merchantAccessKey
stringÂ
required
Authorization
stringÂ
required
Body Params application/json
orderId
stringÂ
required
amount
object (Amount)Â
required
value
numberÂ
required
>= 0.01
currency
enum<string>Â
required
Allowed value:
INR
returnUrl
stringÂ
optional
notifyUrl
stringÂ
optional
customerInfo
object (CustomerDetail)Â
optional
firstName
stringÂ
optional
lastName
stringÂ
optional
address
object (Address)Â
optional
email
stringÂ
optional
phoneNumber
stringÂ
optional
customParameters
objectÂ
optional
Additional properties
stringÂ
optional
description
stringÂ
optional
paymentDetail
object (OrderPaymentDetail)Â
optional
accountNumber
stringÂ
optional
>= 9 characters<= 36 characters
ifsc
stringÂ
optional
>= 11 characters<= 11 characters
Example:
KKBK0000432
Match pattern:
^[A-Z]{4}0[A-Z0-9]{6}$
restrictedPaymentOptions
objectÂ
optional
restrictedPaymentOptions is to restrict payment options on check for this order, this field a map containg paymentMode as key and List as value.
NETBANKING: List of Netbanking codes
CREDIT_CARD: List of card scheme, ex: ["MASTERCARD","VISA","RUPAY","DINERS","AMEX"]
DEBIT_CARD: List of card scheme, ex: ["MASTERCARD","VISA","RUPAY","DINERS","AMEX"]
PREPAID_CARD: List of card scheme, ex: ["MASTERCARD","VISA","RUPAY","DINERS","AMEX"]
CORPORATE_CARD: List of card scheme, ex: ["MASTERCARD","VISA","RUPAY","DINERS","AMEX"]
UPI: null
WALLET: List of wallet codes
Example
{
"orderId": "RANDOMID123",
"amount": {
"value": 100.00,
"currency": "INR"
},
"returnUrl": "https://glaring-version.net/",
"notifyUrl": "https://inconsequential-annual.biz/",
"customerInfo": {
"firstName": "Merlin",
"lastName": "Collins",
"address": {
"streetName": "Jill Zemlak",
"city": "Darioside",
"state": "Minnesota",
"country": "Angola",
"zipcode": "06422"
},
"email": "Emmitt37@yahoo.com",
"phoneNumber": "9889890909"
},
"customParameters": {
"customParam1": "value",
"customParam2": "value2"
},
"description": "Order description",
"restrictedPaymentOptions": {
"UPI": null,
"NET_BANKING" : ["NB001"],
"CREDIT_CARD" : ["MASTERCARD"]
}
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v0/orders' \
--header 'merchantAccessKey;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
"orderId": "RANDOMID123",
"amount": {
"value": 100.00,
"currency": "INR"
},
"returnUrl": "https://glaring-version.net/",
"notifyUrl": "https://inconsequential-annual.biz/",
"customerInfo": {
"firstName": "Merlin",
"lastName": "Collins",
"address": {
"streetName": "Jill Zemlak",
"city": "Darioside",
"state": "Minnesota",
"country": "Angola",
"zipcode": "06422"
},
"email": "Emmitt37@yahoo.com",
"phoneNumber": "9889890909"
},
"customParameters": {
"customParam1": "value",
"customParam2": "value2"
},
"description": "Order description",
"restrictedPaymentOptions": {
"UPI": null,
"NET_BANKING" : ["NB001"],
"CREDIT_CARD" : ["MASTERCARD"]
}
}'
Responses
🟢200OK
application/json
Body
response_code
integer <int32>
optional
response_message
stringÂ
optional
payload
object (OrderCreateResponse)Â
optional
redirectionUrl
stringÂ
optional
orderId
stringÂ
optional
Example
{
"response_code": 0,
"response_message": "string",
"payload": {
"redirectionUrl": "string",
"orderId": "string"
}
}
Modified at 2025-06-26 13:37:10