EnKash API Document
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Orders
  • Payment Gateway Overview
  • Payment Gateway Sign Up
  • Payment Methods
  • Supported Integrations
  • Payment APIs
  • Test Card Details
  • Authorization
    • About Authorization
    • Get Authorization Token
      POST
  • Orders
    • Order Overview
    • About Order
    • Create Order
      POST
    • Get Order Status
      GET
    • Get BNPL Payment Modes
      GET
  • Payments
    • Payment Overview
    • About Payment
    • Get Transaction Status
      GET
    • Submit Payment Detail
      POST
  • Refunds
    • About Refund
    • Refund
      POST
  • Payment Links
    • Upi Intent Link Detail
      GET
  • Settlements
    • About Settlement
    • Get Settlement Payout By Id
      GET
    • Search Settlement Payouts
      POST
  • QR Generation API
    • Get Dynamic QR Code
  • Payment Button
  • Qr Code
    • Create QR
    • Create QR Customer
    • Search QR Code
    • Get QR Code
    • Cancel QR Code
  1. Orders

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 
optional
>= 1<= 1000000000
currency
string 
optional
returnUrl
string 
optional
The URL to which the customer will be redirected after completing the payment.
notifyUrl
string 
optional
The URL where notifications regarding the order will be sent.
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.
email
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) 
required
Payment related informatoon
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}$
Example
{
    "orderId": "string",
    "amount": {
        "value": 1,
        "currency": "string"
    },
    "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"
    }
}

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": "string",
    "amount": {
        "value": 1,
        "currency": "string"
    },
    "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"
    }
}'

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"
    }
}
Previous
About Order
Next
Get Order Status
Built with