Create Order

POST

/api/v0/orders

order-controller

Utilize this API to generate orders with Olympus from your backend. This allows you to initiate transactions and collect payments seamlessly

Request

Header Params

merchantAccessKey

string

required

Authorization

string

required

Body Params application/json

orderId

string

required

A unique identifier for the order in your system. Accepts alphanumeric characters only.

amount

object (Amount)

required

This specifies the amount for the order, allowing up to two decimal places. For example, 20.15 would represent Rs 20 and 15 paisa.

value

number

required

>= 0.01

currency

enum<string>

required

Allowed value:

INR

returnUrl

string

optional

The URL to which the customer will be redirected after completing the payment. returnUrl is required if not configured at merchant level

notifyUrl

string

optional

The URL where notifications regarding the order will be sent. notifyUrl is required if not configured at merchant level

customerInfo

object (CustomerDetail)

optional

Information about the customer associated with the order. It typically includes details such as first name, last name, address, email, and phone number.

firstName

string

optional

The first name of the customer. Accepts alphabetic characters.

lastName

string

optional

The last name of the customer. Accepts alphabetic characters.

address

object (Address)

optional

The address of the customer. Accepts alphanumeric characters and special symbols.

string

optional

The email address of the customer. Must be in a valid email format.

phoneNumber

string

optional

The phone number of the customer. Please exclude +91 ISD code.

customParameters

object

optional

Additional custom parameters or metadata associated with the order, if any. These will be key value pairs.

Additional properties

string

optional

description

string

optional

paymentDetail

object (OrderPaymentDetail)

optional

Payment related information for UPI TPV flow

accountNumber

string

optional

Required for UPI TPV flow for non seamless integration

>= 9 characters<= 36 characters

ifsc

string

optional

Required for UPI TPV flow for non seamless integration

>= 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: null
DEBIT_CARD: null
UPI: null
WALLET: List of wallet codes

Example

{
  "orderId": "string",
  "amount": {
    "value": 0.01,
    "currency": "INR"
  },
  "returnUrl": "string",
  "notifyUrl": "string",
  "customerInfo": {
    "firstName": "string",
    "lastName": "string",
    "address": {
      "streetName": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "zipcode": "string"
    },
    "email": "string",
    "phoneNumber": "string"
  },
  "customParameters": {
    "property1": "string",
    "property2": "string"
  },
  "description": "string",
  "paymentDetail": {
    "accountNumber": "stringstr",
    "ifsc": "KKBK0000432"
  },
  "restrictedPaymentOptions": {}
}

Request 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": "string",
    "amount": {
        "value": 0.01,
        "currency": "INR"
    },
    "returnUrl": "string",
    "notifyUrl": "string",
    "customerInfo": {
        "firstName": "string",
        "lastName": "string",
        "address": {
            "streetName": "string",
            "city": "string",
            "state": "string",
            "country": "string",
            "zipcode": "string"
        },
        "email": "string",
        "phoneNumber": "string"
    },
    "customParameters": {
        "property1": "string",
        "property2": "string"
    },
    "description": "string",
    "paymentDetail": {
        "accountNumber": "stringstr",
        "ifsc": "KKBK0000432"
    },
    "restrictedPaymentOptions": {}
}'

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-03-28 04:10:13

About Order

Get Order Status