Create Order

POST

/api/v0/orders

📌

Use this API to create an order. The generated order acts as a prerequisite for initiating a transaction and collecting payments, enabling a seamless and secure payment flow within your application.

Request

Header Params

Body Params application/json

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": "[email protected]",
        "phoneNumber": "9889890909",
        "customerIpAddress": "1.204.130.102"
    },
    "customParameters": {
        "customParam1": "value",
        "customParam2": "value2"
    },
    "description": "Order description",
    "restrictedPaymentOptions": {
        "UPI": null,
        "NET_BANKING": [
            "NB001"
        ],
        "CREDIT_CARD": [
            "MASTERCARD"
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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": "[email protected]",
        "phoneNumber": "9889890909",
        "customerIpAddress": "1.204.130.102"
    },
    "customParameters": {
        "customParam1": "value",
        "customParam2": "value2"
    },
    "description": "Order description",
    "restrictedPaymentOptions": {
        "UPI": null,
        "NET_BANKING": [
            "NB001"
        ],
        "CREDIT_CARD": [
            "MASTERCARD"
        ]
    }
}'

Responses

🟢200OK

application/json

Body

Example

{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "redirectionUrl": "string",
        "orderId": "string"
    }
}

Modified at 2025-08-07 17:54:48

Order

Get Order Status