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
Utilize this API to generate orders with Olympus from your backend. This allows you to initiate transactions and collect payments seamlessly

Request

Header Params

Body Params application/json

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

Example
{
    "response_code": 0,
    "response_message": "string",
    "payload": {
        "redirectionUrl": "string",
        "orderId": "string"
    }
}
Modified at 2024-07-30 10:44:09
Previous
About Order
Next
Get Order Status
Built with