# Create Order
Use this API to create an Order.
## Environment
Use our UAT environment endpoint for testing and for integration utilize our production endpoint.
| Environment | Endpoints |
| :----------------------------- | :------------------------------------------------- |
| User Acceptance Testing \[UAT] | `https://pluraluat.v2.pinepg.in/api/pay/v1/orders` |
| Production \[PROD] | `https://api.pluralpay.in/api/pay/v1/orders` |
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "order",
"version": "3.0"
},
"servers": [
{
"url": "https://pluraluat.v2.pinepg.in/api"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"x-bearer-format": "bearer",
"x-default": ""
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/pay/v1/orders": {
"post": {
"summary": "Create Order",
"description": "Use this API to create an Order.",
"operationId": "orders-create",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "The type of content included in the HTTP message body.
Possible value: `application/json`.",
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "Authorization",
"in": "header",
"description": "The HTTP header where you can include your secret token for authentication.
Example: `Bearer `
**Note**: Use the access token generated using our Generate Token API.",
"required": true,
"schema": {
"type": "string",
"default": "Bearer"
}
},
{
"name": "Request-Timestamp",
"in": "header",
"description": "Use ISO 8601 UTC Timestamp, to create a timestamp when the generate token is requested.
Example: `2024-07-09T07:57:08.022Z`",
"schema": {
"type": "string"
}
},
{
"name": "Request-ID",
"in": "header",
"description": "Use a global unique identifier [GUID] for the request.- Minimum: 1 characters.
- Maximum: 50 characters
Example: `c17ce30f-f88e-4f81-ada1-c3b4909ed235`",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"merchant_order_reference",
"order_amount"
],
"properties": {
"merchant_order_reference": {
"type": "string",
"description": "Enter a unique identifier for the order request.- Minimum: 1 characters.
- Maximum: 50 characters
Example: `1234567890`
Supported characters:"
},
"order_amount": {
"type": "object",
"description": "An object that contains the transaction amount details.",
"required": [
"value",
"currency"
],
"properties": {
"value": {
"type": "string",
"description": "The transaction amount should be provided in the lowest denomination.
The following validations apply to INR transactions:- Minimum value: `100` (₹1)
- Maximum value: `100000000` (₹10,00,000)
Example: `1100` (₹11)"
},
"currency": {
"type": "string",
"description": "Type of currency.
Example: `INR`"
}
}
},
"pre_auth": {
"type": "boolean",
"description": "The pre-authorization type.
Possible values:
`false` (default): When pre-authorization is not required.
`true`: When pre-authorization is needed."
},
"allowed_payment_methods": {
"type": "array",
"description": "The type of payment methods you want to offer your customers to accept payments.
Accepted values:- `CARD`
- `UPI`
- `POINTS`
- `NETBANKING`
- `WALLET`
- `CREDIT_EMI`
- `DEBIT_EMI`
Example: `CARD`
**Note**: Before selecting a payment method, ensure it is configured for you.",
"items": {
"type": "string"
}
},
"notes": {
"type": "string",
"description": "The note you want to show against an order.
Example: `Order1`"
},
"callback_url": {
"type": "string",
"description": "The URL to which your customers are redirected based on the order or product details, leading them to either a success or failure page.
Example: `https://sample-callback-url`"
},
"purchase_details": {
"type": "object",
"description": "Object that contains the details of customer information, shipping address, and billing address.",
"properties": {
"account_details": {
"type": "object",
"description": "An object that contains the customers bank account details.",
"properties": {
"bank_details": {
"type": "object",
"description": "An object that contains the bank account details.",
"required": [
"account_number"
],
"properties": {
"account_number": {
"type": "string",
"description": "Customer's bank account number.
Example: `500000004545`"
},
"ifsc_code": {
"type": "string",
"description": "Customer's bank IFSC.
Example: `BANK0000123`"
},
"bank_name": {
"type": "string",
"description": "Customer's account holding bank name.
Example: `Example Bank`"
}
}
}
}
},
"customer": {
"type": "object",
"description": "An object that contains the customer details.",
"properties": {
"email_id": {
"type": "string",
"description": "Customer's email address.
- Minimum length: 1 character.
- Maximum length: 50 characters.
Example: `kevin.bob@example.com`
Supported characters:- `A-Z`
- `a-z`
- `0-9`
- `+`
- `_`
- `.`
- `-`
- `@`
"
},
"first_name": {
"type": "string",
"description": "Customer's first name.
- Minimum length: 1 character.
- Maximum length: 50 characters.
Example: `Kevin`
Supported characters:- `A-Z`
- `a-z`
- `0-9`
- `space`
- `_`
- `.`
- `-`
"
},
"last_name": {
"type": "string",
"description": "Customer's last name.
- Minimum length: 1 character.
- Maximum length: 50 characters.
Example: `Bob`
Supported characters:- `A-Z`
- `a-z`
- `0-9`
- `space`
- `_`
- `.`
- `-`
"
},
"customer_id": {
"type": "string",
"description": "Unique identifier of the customer in the Pine Labs Online database.
- Minimum length: 1 character.
- Maximum length: 19 characters.
Example: `123456`"
},
"mobile_number": {
"type": "string",
"description": "Customer's mobile number.
- Minimum length: `10` character.
- Maximum length: `20` characters.
Example: `9876543210`
Supported characters:\n\n**Note**: You can use your valid foreign mobile numbers, ensuring that the `country_code` is valid."
},
"country_code": {
"type": "string",
"description": "Country code of the registered mobile number.- Maximum length: `5` characters.
- No spaces, hyphens, or special characters are allowed.
Example: `+91`
**Note**: If the country code is not provided, it defaults to `+91`.\n\n**Note**: Ensure you use a valid country code while passing the foreign mobile number."
},
"billing_address": {
"type": "object",
"description": "An object that contains the details of the billing address.",
"properties": {
"address1": {
"type": "string",
"description": "Customer's billing address1.
- Maximum length: 100 characters.
Example: `10 Downing Street Westminster London`"
},
"address2": {
"type": "string",
"description": "Customer's billing address2.
- Maximum length: 100 characters.
Example: `Oxford Street Westminster London`"
},
"address3": {
"type": "string",
"description": "Customer's billing address3.
- Maximum length: 100 characters.
Example: `Baker Street Westminster London`"
},
"pincode": {
"type": "string",
"description": "Pincode of the billing address.- Minimum length: `3` characters.
- Maximum length: `11` characters.
- The first and last character must be a letter (`A–Z`, `a–z`) or a digit (`0–9`).
Example: `A2-1524036A`
Supported characters: "
},
"city": {
"type": "string",
"description": "City of the billing address.
- Maximum length: 50 characters.
Example: `Westminster`
Supported characters: - `A-Z`
- `a-z`
- `0-9`
- `-`
- ` `
- `&`
- `(`
- `)`
"
},
"state": {
"type": "string",
"description": "State of the billing address.
- Maximum length: 50 characters.
Example: `Westminster`
Supported characters: "
},
"country": {
"type": "string",
"description": "Country of the billing address.
- Maximum length: 50 characters.
Example: `London`
Supported characters: "
},
"full_name": {
"type": "string",
"description": "Customer's full name.
- Maximum length: 100 characters.
Example: `Kevin Bob`
Supported characters: "
},
"address_type": {
"type": "string",
"description": "Type of the shipping address.
- Maximum length: `20` characters.
Example: `Home`
Accepted values: "
},
"address_category": {
"type": "string",
"description": "Address category.
- Maximum length: `20` characters.
Example: `Shipping`"
}
}
},
"shipping_address": {
"type": "object",
"description": "An object that contains the shipping address details.",
"properties": {
"address1": {
"type": "string",
"description": "Customer's shipping address1.
- Maximum length: 100 characters.
Example: `10 Downing Street Westminster London`"
},
"address2": {
"type": "string",
"description": "Customer's shipping address2.
- Maximum length: 100 characters.
Example: `Oxford Street Westminster London`"
},
"address3": {
"type": "string",
"description": "Customer's shipping address3.
- Maximum length: 100 characters.
Example: `Baker Street Westminster London`"
},
"pincode": {
"type": "string",
"description": "Pincode of the shipping address.- Minimum length: `3` characters.
- Maximum length: `11` characters.
- The first and last character must be a letter (`A–Z`, `a–z`) or a digit (`0–9`).
Example: `A2-1524036A`
Supported characters: "
},
"city": {
"type": "string",
"description": "City of the shipping address.
- Maximum length: 50 characters.
Example: `Westminster`
Supported characters: - `A-Z`
- `a-z`
- `0-9`
- `-`
- ` `
- `&`
- `(`
- `)`
"
},
"state": {
"type": "string",
"description": "State of the shipping address.
- Maximum length: 50 characters.
Example: `Westminster`
Supported characters: "
},
"country": {
"type": "string",
"description": "Country of the shipping address.
- Maximum length: 50 characters.
Example: `London`
Supported characters: "
},
"full_name": {
"type": "string",
"description": "Customer's full name.
- Maximum length: 100 characters.
Example: `Kevin Bob`
Supported characters: "
},
"address_type": {
"type": "string",
"description": "Type of the shipping address.
- Maximum length: `20` characters.
Example: `Home`
Accepted values: "
},
"address_category": {
"type": "string",
"description": "Address category.
- Maximum length: `20` characters.
Example: `Shipping`"
}
}
}
}
},
"merchant_metadata": {
"type": "object",
"description": "An object of key value pair that can be used to store additional information.- Each pair cannot exceed 256 characters.
- Maximum 10 key-value pairs.
Example: `\"key1\": \"DD\"`",
"properties": {
"key1": {
"type": "string"
},
"key2": {
"type": "string"
}
}
},
"split_info": {
"type": "object",
"description": "**Mandatory for a Split Settlement**
An object that contains the split settlement details.",
"required": [
"split_type"
],
"properties": {
"split_type": {
"type": "string",
"description": "Type of Split.
Example: `Amount`"
},
"split_details": {
"type": "array",
"description": "**Mandatory object**
An array of split settlement details.",
"items": {
"properties": {
"split_merchant_id": {
"type": "string",
"description": "Unique identifier of your partner merchant in the Pine Labs Online database.
Example: `123456`"
},
"merchant_settlement_reference": {
"type": "string",
"description": "Unique identifier entered while creating a order in split.- Minimum length: `1` characters.
- Maximum length: `50` characters.
Example: `asdf-1234-qwer-5678`"
},
"amount": {
"type": "object",
"description": "**Mandatory object**
An object that contains the split amount details.",
"required": [
"value",
"currency"
],
"properties": {
"value": {
"type": "integer",
"description": "The transaction amount you want to accept from your customers.- Amount in Paisa.
- Minimum value: `100` (₹1).
- Maximum value: `100000000` (₹10 lakh).
Example: `100`",
"format": "int32"
},
"currency": {
"type": "string",
"description": "Type of currency.
Has to be 3 digits.
Example: `INR`"
}
}
},
"on_hold": {
"type": "string",
"description": "Indicate whether the settlement is on hold for future release.
Accepted values: - `true`: The settlement is placed on hold.
- `false`: The settlement is processed in the next settlement cycle.
"
}
},
"required": [
"split_merchant_id",
"merchant_settlement_reference"
],
"type": "object"
}
}
}
}
}
},
"failure_callback_url": {
"type": "string",
"description": "The URL specifically used to redirect customers to a failure page based on the order or product details.
**Note**:- If the `failure_callback_url` is not provided, customers will be redirected to the `callback_url` for both successful and failed transactions.
- If the `failure_callback_url` is provided, the `callback_url` will be used exclusively for successful transactions, while the `failure_callback_url` will be used for failed transactions.
- If neither URL is provided, the default URL configured during merchant onboarding will be used.
"
},
"split_info": {
"type": "object",
"description": "**Mandatory for Split Settlements**
An object that contains the split settlement information.
**Note**: Kindly ensure split settlements are enabled for your account in the Pine Labs Online database.",
"required": [
"split_type"
],
"properties": {
"split_type": {
"type": "string",
"description": "Type of Split.
Example: `Amount`"
},
"split_details": {
"type": "array",
"description": "**Mandatory object**
An array of split settlement details.",
"items": {
"properties": {
"split_merchant_id": {
"type": "string",
"description": "Unique identifier of your partner merchant in the Pine Labs Online database.
Example: `123456`"
},
"merchant_settlement_reference": {
"type": "string",
"description": "Unique identifier entered while creating a order in split.- Minimum length: `1` characters.
- Maximum length: `50` characters.
Example: `asdf-1234-qwer-5678`"
},
"amount": {
"type": "object",
"description": "**Mandatory object**
An object that contains the split amount details.",
"required": [
"value",
"currency"
],
"properties": {
"value": {
"type": "integer",
"description": "The transaction amount you want to accept from your customers.- Amount in Paisa.
- Minimum value: `100` (₹1).
- Maximum value: `100000000` (₹10 lakh).
Example: `100`",
"format": "int32"
},
"currency": {
"type": "string",
"description": "Type of currency.
Has to be 3 digits.
Example: `INR`"
}
}
},
"on_hold": {
"type": "string",
"description": "Indicate whether the settlement is on hold for future release.
Accepted values: - `true`: The settlement is placed on hold.
- `false`: The settlement is processed in the next settlement cycle.
"
}
},
"required": [
"split_merchant_id",
"merchant_settlement_reference"
],
"type": "object"
}
}
}
},
"is_mcc_transaction": {
"type": "string",
"description": "Identifies the order type.
Possible values: - `true`: The order is processed for a MCC transaction.
- `false` (default): The order is processed for a regular transaction.
**Note**: It is Mandatory to set this parameter to `true` for MCC transactions to ensure smooth payment processing and avoid transaction failures."
},
"base_amount": {
"type": "object",
"description": "An object that contains the transaction amount details.
**Note**: The base amount must always be specified in `INR`.",
"required": [
"value",
"currency"
],
"properties": {
"value": {
"type": "integer",
"description": "The transaction amount in Paisa.
- Minimum value: `100` (₹1)
- Maximum value: `100000000` (₹10 lakh)
Example: `1100`",
"format": "int32"
},
"currency": {
"type": "string",
"description": "Type of currency.
Example: `INR`"
}
}
},
"cross_border_details": {
"type": "object",
"properties": {
"settlement_currency": {
"type": "string",
"description": "Settlement currency.
**Note**: If `settlement_currency` is not provided, the settlement currency configured during merchant onboarding will be used as default."
},
"hs_code": {
"type": "string",
"description": "**Mandatory when `commodity_type` is GOODS**
Harmonized System (HS) code for the goods/services being traded."
},
"hs_description": {
"type": "string",
"description": "**Mandatory when `commodity_type` is GOODS**
Description of the goods/services corresponding to the HS code."
},
"iec_code": {
"type": "string",
"description": "Importer-Exporter Code (IEC) issued by DGFT, India. Must be a 1-to-10 digit numeric code.
Example: `0512345678`"
}
},
"description": "An object that contains the cross border details."
}
}
},
"examples": {
"Create Order": {
"value": {
"merchant_order_reference": 112345,
"order_amount": {
"value": 1100,
"currency": "INR"
},
"pre_auth": false,
"allowed_payment_methods": [
"CARD",
"UPI",
"NETBANKING",
"POINTS",
"WALLET"
],
"notes": "order1",
"callback_url": "https://sample-callback-url",
"failure_callback_url": "https://sample-failure-callback-url",
"purchase_details": {
"customer": {
"email_id": "kevin.bob@example.com",
"first_name": "Kevin",
"last_name": "Bob",
"customer_id": "123456",
"mobile_number": "9876543210",
"country_code": "91",
"billing_address": {
"address1": "10 Downing Street Westminster London",
"address2": "Oxford Street Westminster London",
"address3": "Baker Street Westminster London",
"pincode": "51524036",
"city": "Westminster",
"state": "Westminster",
"country": "London",
"full_name": "Kevin Bob",
"adddress_type": "Home",
"address_category": "billing"
},
"shipping_address": {
"address1": "10 Downing Street Westminster London",
"address2": "Oxford Street Westminster London",
"address3": "Baker Street Westminster London",
"pincode": "51524036",
"city": "Westminster",
"state": "Westminster",
"country": "London",
"full_name": "Kevin Bob",
"adddress_type": "Home",
"address_category": "shipping"
}
},
"merchant_metadata": {
"key1": "DD",
"key2": "XOF"
}
}
}
},
"Split Settlement Order": {
"value": {
"merchant_order_reference": "1578609owyihy",
"order_amount": {
"value": 50000,
"currency": "INR"
},
"pre_auth": false,
"purchase_details": {
"customer": {
"email_id": "kevin.bob@example.com",
"first_name": "Kevin",
"last_name": "Bob",
"customer_id": "192212",
"mobile_number": "9876543210",
"country_code": "91",
"billing_address": {},
"shipping_address": {
"address1": "H.No 15, Sector 17",
"address2": "",
"address3": "",
"pincode": "144001123",
"city": "CHANDIGARH",
"state": "PUNJAB",
"country": "INDIA",
"full_name": "Kevin Bob",
"adddress_type": "Home",
"address_category": "billing"
}
},
"merchant_metadata": {
"key1": "DD",
"key2": "XOF"
},
"split_info": {
"split_type": "AMOUNT",
"split_details": [
{
"split_merchant_id": "1324",
"merchant_settlement_reference": "kshjhfk",
"amount": {
"value": 30000,
"currency": "INR"
},
"on_hold": true
},
{
"split_merchant_id": "1233",
"amount": {
"value": 20000,
"currency": "INR"
},
"on_hold": false
}
]
}
}
}
},
"Create MCC Order": {
"value": {
"merchant_order_reference": "fc493db3-e497-48a3-8ad5-dea883b6a0a0",
"order_amount": {
"value": 10000,
"currency": "USD"
},
"notes": null,
"purchase_details": {
"customer": {
"email_id": "kevin.bob@example.com",
"first_name": "Kevin",
"last_name": "Bob",
"customer_id": 192212,
"mobile_number": "9876543210",
"country_code": 91,
"billing_address": {
"address1": "10 Downing Street Westminster London",
"address2": "Oxford Street Westminster London",
"address3": "Baker Street Westminster London",
"pincode": "51524036",
"city": "Westminster",
"state": "Westminster",
"country": "London",
"full_name": "Kevin Bob",
"adddress_type": "Home",
"address_category": "billing"
},
"shipping_address": {
"address1": "10 Downing Street Westminster London",
"address2": "Oxford Street Westminster London",
"address3": "Baker Street Westminster London",
"pincode": "51524036",
"city": "Westminster",
"state": "Westminster",
"country": "London",
"full_name": "Kevin Bob",
"adddress_type": "Home",
"address_category": "shipping"
},
"merchant_metadata": {
"customerCreationDate": "2025-06-20",
"customerCreationDays": "10",
"customerType": "NEW"
}
},
"allowed_payment_methods": null,
"integration_mode": "REDIRECT",
"callback_url": null,
"failure_callback_url": null,
"is_mcc_transaction": true,
"base_amount": {
"value": 1000,
"currency": "INR"
}
}
}
},
"PA-CB Order": {
"summary": "PA-CB Order",
"value": {
"merchant_order_reference": 112345,
"order_amount": {
"value": 1100,
"currency": "INR"
},
"pre_auth": false,
"allowed_payment_methods": [
"CARD",
"UPI",
"NETBANKING",
"POINTS",
"WALLET"
],
"notes": "order1",
"callback_url": "https://sample-callback-url",
"failure_callback_url": "https://sample-failure-callback-url",
"purchase_details": {
"customer": {
"email_id": "kevin.bob@example.com",
"first_name": "Kevin",
"last_name": "Bob",
"customer_id": "123456",
"mobile_number": "9876543210",
"country_code": "91",
"billing_address": {
"address1": "10 Downing Street Westminster London",
"address2": "Oxford Street Westminster London",
"address3": "Baker Street Westminster London",
"pincode": "51524036",
"city": "Westminster",
"state": "Westminster",
"country": "London",
"full_name": "Kevin Bob",
"adddress_type": "Home",
"address_category": "billing"
},
"shipping_address": {
"address1": "10 Downing Street Westminster London",
"address2": "Oxford Street Westminster London",
"address3": "Baker Street Westminster London",
"pincode": "51524036",
"city": "Westminster",
"state": "Westminster",
"country": "London",
"full_name": "Kevin Bob",
"adddress_type": "Home",
"address_category": "shipping"
}
},
"merchant_metadata": {
"key1": "DD",
"key2": "XOF"
}
},
"cross_border_details": {
"settlement_currency": "USD",
"hs_code": "8471300000",
"hs_description": "Portable digital automatic data processing machines",
"iec_code": "0512345678"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"data\": {\n \"order_id\": \"v1-4405071524-aa-qlAtAf\",\n \"merchant_order_reference\": \"112345\",\n \"type\": \"CHARGE\",\n \"status\": \"CREATED\",\n \"merchant_id\": \"104359\",\n \"order_amount\": {\n \"value\": 1100,\n \"currency\": \"INR\"\n },\n \"pre_auth\": false,\n \"allowed_payment_methods\": [\n \"CARD\",\n \"UPI\",\n \"NETBANKING\",\n \"POINTS\",\n \"WALLET\"\n ],\n \"notes\": \"order1\",\n \"callback_url\": \"https://sample-callback-url\",\n \"failure_callback_url\": \"https://sample-failure-callback-url\",\n \"purchase_details\": {\n \"customer\": {\n \"email_id\": \"kevin.bob@example.com\",\n \"first_name\": \"Kevin\",\n \"last_name\": \"Bob\",\n \"customer_id\": \"123456\",\n \"mobile_number\": \"9876543210\",\n\t\t\t\t\"country_code\": \"91\",\n \"billing_address\": {\n \"address1\": \"10 Downing Street Westminster London\",\n \"address2\": \"Oxford Street Westminster London\",\n \"address3\": \"Baker Street Westminster London\",\n \"pincode\": \"51524036\",\n \"city\": \"Westminster\",\n \"state\": \"Westminster\",\n \"country\": \"London\",\n\t\t\t\t\"full_name\": \"Kevin Bob\",\n\t\t\t\t\"adddress_type\": \"Home\",\n\t\t\t\t\"address_category\": \"billing\"\n },\n \"shipping_address\": {\n \"address1\": \"10 Downing Street Westminster London\",\n \"address2\": \"Oxford Street Westminster London\",\n \"address3\": \"Baker Street Westminster London\",\n \"pincode\": \"51524036\",\n \"city\": \"Westminster\",\n \"state\": \"Westminster\",\n \"country\": \"London\",\n\t\t\t\t\"full_name\": \"Kevin Bob\",\n\t\t\t\t\"adddress_type\": \"Home\",\n\t\t\t\t\"address_category\": \"shipping\"\n }\n },\n \"merchant_metadata\": {\n \"key1\": \"DD\",\n \"key2\": \"XOF\"\n }\n },\n \"payments\": [],\n \"created_at\": \"2024-07-15T05:44:51.174Z\",\n \"updated_at\": \"2024-07-15T05:44:51.174Z\"\n }\n}"
},
"Split Settlement Order Response": {
"value": "{\n \"data\": {\n \"order_id\": \"v1-241118074845-aa-wduUQF\",\n \"merchant_order_reference\": \"3595f435-b1c5-4a60-a98c-9cf39ee3dc07\",\n \"type\": \"CHARGE\",\n \"status\": \"CREATED\",\n \"merchant_id\": \"108272\",\n \"order_amount\": {\n \"value\": 50000,\n \"currency\": \"INR\"\n },\n \"pre_auth\": false,\n \"purchase_details\": {\n \"customer\": {\n \"email_id\": \"kevin.bob@example.com\",\n \"first_name\": \"Kevin\",\n \"last_name\": \"Bob\",\n \"customer_id\": \"192212\",\n \"mobile_number\": \"9876543210\",\n\t\t\t\t\"country_code\": \"91\",\n \"billing_address\": {\n \"address1\": \"10 Downing Street Westminster London\",\n \"address2\": \"Oxford Street Westminster London\",\n \"address3\": \"Baker Street Westminster London\",\n \"pincode\": \"51524036\",\n \"city\": \"Westminster\",\n \"state\": \"Westminster\",\n \"country\": \"London\",\n\t\t\t\t\"full_name\": \"Kevin Bob\",\n\t\t\t\t\"adddress_type\": \"Home\",\n\t\t\t\t\"address_category\": \"billing\"\n },\n \"shipping_address\": {\n \"address1\": \"10 Downing Street Westminster London\",\n \"address2\": \"Oxford Street Westminster London\",\n \"address3\": \"Baker Street Westminster London\",\n \"pincode\": \"51524036\",\n \"city\": \"Westminster\",\n \"state\": \"Westminster\",\n \"country\": \"London\",\n\t\t\t\t\"full_name\": \"Kevin Bob\",\n\t\t\t\t\"adddress_type\": \"Home\",\n\t\t\t\t\"address_category\": \"shipping\"\n }\n },\n \"merchant_metadata\": {\n \"key1\": \"DD\",\n \"key2\": \"XOF\"\n },\n \"split_info\": {\n \"split_type\": \"AMOUNT\",\n \"split_details\": [\n {\n \"split_merchant_id\": \"1324\",\n \"split_settlement_id\": \"v1-241118074845-aa-wduUQF-ss-b\",\n \"merchant_settlement_reference\": \"kshjhfk\",\n \"amount\": {\n \"value\": 30000,\n \"currency\": \"INR\"\n },\n \"on_hold\": true,\n \"status\": \"HOLD\",\n \"updated_at\": \"2024-11-18T07:48:45.324Z\"\n },\n {\n \"split_merchant_id\": \"1233\",\n \"split_settlement_id\": \"v1-241118074845-aa-wduUQF-ss-r\",\n \"amount\": {\n \"value\": 20000,\n \"currency\": \"INR\"\n },\n \"on_hold\": false,\n \"status\": \"RELEASED\",\n \"updated_at\": \"2024-11-18T07:48:45.324Z\"\n }\n ]\n }\n },\n \"created_at\": \"2024-11-18T07:48:45.324336Z\",\n \"updated_at\": \"2024-11-18T07:48:45.324348Z\",\n \"integration_mode\": \"SEAMLESS\"\n }\n}"
},
"MCC Order": {
"value": "{\n \"data\": {\n \"order_id\": \"v1-251121102252-aa-6lsZkL\",\n \"merchant_order_reference\": \"e707474f-59f7-4549-bad8-0d5f85b031d0\",\n \"type\": \"CHARGE\",\n \"status\": \"CREATED\",\n \"merchant_id\": \"115129\",\n \"order_amount\": {\n \"value\": 10000,\n \"currency\": \"USD\"\n },\n \"pre_auth\": false,\n \"part_payment\": false,\n \"allowed_payment_methods\": [\n \"CARD\"\n ],\n \"purchase_details\": {\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"customer_id\": \"192212\",\n \"country_code\": \"91\",\n \"billing_address\": {\n \"address1\": \"H.No 15, Sector 17\",\n \"pincode\": \"160036\",\n \"city\": \"CHANDIGARH\",\n \"state\": \"PUNJAB\",\n \"country\": \"INDIA\",\n \"full_name\": \"vikas\",\n \"address_type\": \"HOME\",\n \"address_category\": \"BILLING\"\n },\n \"shipping_address\": {\n \"address1\": \"H.No 15, Sector 17\",\n \"pincode\": \"160036\",\n \"city\": \"CHANDIGARH\",\n \"state\": \"PUNJAB\",\n \"country\": \"INDIA\",\n \"full_name\": \"vikas\",\n \"address_type\": \"HOME\",\n \"address_category\": \"SHIPPING\"\n },\n \"is_edit_customer_details_allowed\": false,\n \"merchant_metadata\": {\n \"customerCreationDate\": \"2025-06-20\",\n \"customerCreationDays\": \"10\",\n \"customerType\": \"NEW\"\n }\n },\n \"merchant_metadata\": {\n \"customerCreationDate\": \"2025-06-20\",\n \"customerCreationDays\": \"10\",\n \"customerType\": \"NEW\"\n },\n \"cart_details\": {\n \"cart_items\": [\n {\n \"item_id\": \"9876\",\n \"item_name\": \"T Shirt\",\n \"item_description\": \"Test Description\",\n \"item_details_url\": \"https://chriscross.in/cdn/shop/files/95_800x.jpg\",\n \"item_image_url\": \"https://chriscross.in/cdn/shop/files/95_800x.jpg\",\n \"item_original_unit_price\": 2,\n \"item_discounted_unit_price\": 2,\n \"item_quantity\": 7,\n \"item_currency\": \"USD\"\n }\n ]\n }\n },\n \"created_at\": \"2025-11-21T10:22:52.896Z\",\n \"updated_at\": \"2025-11-21T10:22:52.896Z\",\n \"integration_mode\": \"SEAMLESS\",\n \"payment_retries_remaining\": 10,\n \"is_mcc_transaction\": true,\n \"is_domestic_txn_for_risk_enabled\": false,\n \"order_token\": \"mzohdLMNCzZ2SN3k1Ppglkz4mmk9edyahe34BM%2Fu9gA%3D\"\n }\n}"
},
"PA-CB Response": {
"summary": "PA-CB Response",
"value": {
"data": {
"order_id": "v1-260522080410-aa-SrAzoh",
"merchant_order_reference": "112345",
"type": "CHARGE",
"status": "CREATED",
"callback_url": "https://sample-callback-url",
"failure_callback_url": "https://sample-failure-callback-url",
"merchant_id": "111260",
"order_amount": {
"value": 1100,
"currency": "INR"
},
"notes": "order1",
"pre_auth": false,
"part_payment": false,
"allowed_payment_methods": [
"CARD",
"UPI",
"NETBANKING"
],
"purchase_details": {
"customer": {
"email_id": "kevin.bob@example.com",
"first_name": "Kevin",
"last_name": "Bob",
"customer_id": "cust-v1-260522080222-aa-AkwlFw",
"mobile_number": "9876543210",
"country_code": "91",
"billing_address": {
"address1": "10 Downing Street Westminster London",
"address2": "Oxford Street Westminster London",
"address3": "Baker Street Westminster London",
"pincode": "51524036",
"city": "Westminster",
"state": "Westminster",
"country": "London",
"full_name": "Kevin Bob",
"address_category": "billing"
},
"shipping_address": {
"address1": "10 Downing Street Westminster London",
"address2": "Oxford Street Westminster London",
"address3": "Baker Street Westminster London",
"pincode": "51524036",
"city": "Westminster",
"state": "Westminster",
"country": "London",
"full_name": "Kevin Bob",
"address_category": "shipping"
},
"is_edit_customer_details_allowed": false,
"status": "ACTIVE",
"created_at": "2026-05-22T08:02:22.425465Z",
"updated_at": "2026-05-22T08:02:22.432671Z"
},
"merchant_metadata": {
"key1": "DD",
"key2": "XOF"
}
},
"created_at": "2026-05-22T08:04:10.662Z",
"updated_at": "2026-05-22T08:04:10.662Z",
"integration_mode": "SEAMLESS",
"payment_retries_remaining": 10,
"is_mcc_transaction": false,
"is_domestic_txn_for_risk_enabled": false,
"order_token": "RR%2Bv%2FjamqGXzGvSxk3X3SpxvIXQVmRDCFf%2FcXWg%2FY2g%3D",
"is_v2_emi_transaction": false,
"cross_border_details": {
"flow_type": "NON_LRS",
"purpose_code": "S0101",
"commodity_type": "SERVICES",
"requires_pan": true
}
}
}
}
},
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"example": "v1-4405071524-aa-qlAtAf"
},
"merchant_order_reference": {
"type": "string",
"example": "112345"
},
"type": {
"type": "string",
"example": "CHARGE"
},
"status": {
"type": "string",
"example": "CREATED"
},
"merchant_id": {
"type": "string",
"example": "104359"
},
"order_amount": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"example": 1100,
"default": 0
},
"currency": {
"type": "string",
"example": "INR"
}
}
},
"pre_auth": {
"type": "boolean",
"example": false,
"default": true
},
"allowed_payment_methods": {
"type": "array",
"items": {
"type": "string",
"example": "CARD"
}
},
"notes": {
"type": "string",
"example": "order1"
},
"callback_url": {
"type": "string",
"example": "https://sample-callback-url"
},
"failure_callback_url": {
"type": "string",
"example": "https://sample-failure-callback-url"
},
"purchase_details": {
"type": "object",
"properties": {
"customer": {
"type": "object",
"properties": {
"email_id": {
"type": "string",
"example": "kevin.bob@example.com"
},
"first_name": {
"type": "string",
"example": "Kevin"
},
"last_name": {
"type": "string",
"example": "Bob"
},
"customer_id": {
"type": "string",
"example": "123456"
},
"mobile_number": {
"type": "string",
"example": "9876543210"
},
"country_code": {
"type": "string",
"example": "91"
},
"billing_address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "10 Downing Street Westminster London"
},
"address2": {
"type": "string",
"example": "Oxford Street Westminster London"
},
"address3": {
"type": "string",
"example": "Baker Street Westminster London"
},
"pincode": {
"type": "string",
"example": "51524036"
},
"city": {
"type": "string",
"example": "Westminster"
},
"state": {
"type": "string",
"example": "Westminster"
},
"country": {
"type": "string",
"example": "London"
},
"full_name": {
"type": "string",
"example": "Kevin Bob"
},
"adddress_type": {
"type": "string",
"example": "Home"
},
"address_category": {
"type": "string",
"example": "billing"
}
}
},
"shipping_address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "10 Downing Street Westminster London"
},
"address2": {
"type": "string",
"example": "Oxford Street Westminster London"
},
"address3": {
"type": "string",
"example": "Baker Street Westminster London"
},
"pincode": {
"type": "string",
"example": "51524036"
},
"city": {
"type": "string",
"example": "Westminster"
},
"state": {
"type": "string",
"example": "Westminster"
},
"country": {
"type": "string",
"example": "London"
},
"full_name": {
"type": "string",
"example": "Kevin Bob"
},
"adddress_type": {
"type": "string",
"example": "Home"
},
"address_category": {
"type": "string",
"example": "shipping"
}
}
}
}
},
"merchant_metadata": {
"type": "object",
"properties": {
"key1": {
"type": "string",
"example": "DD"
},
"key2": {
"type": "string",
"example": "XOF"
}
}
}
}
},
"payments": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"created_at": {
"type": "string",
"example": "2024-07-15T05:44:51.174Z"
},
"updated_at": {
"type": "string",
"example": "2024-07-15T05:44:51.174Z"
}
}
}
}
},
{
"title": "Split Settlement Order Response",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"example": "v1-241118074845-aa-wduUQF"
},
"merchant_order_reference": {
"type": "string",
"example": "3595f435-b1c5-4a60-a98c-9cf39ee3dc07"
},
"type": {
"type": "string",
"example": "CHARGE"
},
"status": {
"type": "string",
"example": "CREATED"
},
"merchant_id": {
"type": "string",
"example": "108272"
},
"order_amount": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"example": 50000,
"default": 0
},
"currency": {
"type": "string",
"example": "INR"
}
}
},
"pre_auth": {
"type": "boolean",
"example": false,
"default": true
},
"purchase_details": {
"type": "object",
"properties": {
"customer": {
"type": "object",
"properties": {
"email_id": {
"type": "string",
"example": "kevin.bob@example.com"
},
"first_name": {
"type": "string",
"example": "Kevin"
},
"last_name": {
"type": "string",
"example": "Bob"
},
"customer_id": {
"type": "string",
"example": "192212"
},
"mobile_number": {
"type": "string",
"example": "9876543210"
},
"country_code": {
"type": "string",
"example": "91"
},
"billing_address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "10 Downing Street Westminster London"
},
"address2": {
"type": "string",
"example": "Oxford Street Westminster London"
},
"address3": {
"type": "string",
"example": "Baker Street Westminster London"
},
"pincode": {
"type": "string",
"example": "51524036"
},
"city": {
"type": "string",
"example": "Westminster"
},
"state": {
"type": "string",
"example": "Westminster"
},
"country": {
"type": "string",
"example": "London"
},
"full_name": {
"type": "string",
"example": "Kevin Bob"
},
"adddress_type": {
"type": "string",
"example": "Home"
},
"address_category": {
"type": "string",
"example": "billing"
}
}
},
"shipping_address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "10 Downing Street Westminster London"
},
"address2": {
"type": "string",
"example": "Oxford Street Westminster London"
},
"address3": {
"type": "string",
"example": "Baker Street Westminster London"
},
"pincode": {
"type": "string",
"example": "51524036"
},
"city": {
"type": "string",
"example": "Westminster"
},
"state": {
"type": "string",
"example": "Westminster"
},
"country": {
"type": "string",
"example": "London"
},
"full_name": {
"type": "string",
"example": "Kevin Bob"
},
"adddress_type": {
"type": "string",
"example": "Home"
},
"address_category": {
"type": "string",
"example": "shipping"
}
}
}
}
},
"merchant_metadata": {
"type": "object",
"properties": {
"key1": {
"type": "string",
"example": "DD"
},
"key2": {
"type": "string",
"example": "XOF"
}
}
},
"split_info": {
"type": "object",
"properties": {
"split_type": {
"type": "string",
"example": "AMOUNT"
},
"split_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"split_merchant_id": {
"type": "string",
"example": "1324"
},
"split_settlement_id": {
"type": "string",
"example": "v1-241118074845-aa-wduUQF-ss-b"
},
"merchant_settlement_reference": {
"type": "string",
"example": "kshjhfk"
},
"amount": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"example": 30000,
"default": 0
},
"currency": {
"type": "string",
"example": "INR"
}
}
},
"on_hold": {
"type": "boolean",
"example": true,
"default": true
},
"status": {
"type": "string",
"example": "HOLD"
},
"updated_at": {
"type": "string",
"example": "2024-11-18T07:48:45.324Z"
}
}
}
}
}
}
}
},
"created_at": {
"type": "string",
"example": "2024-11-18T07:48:45.324336Z"
},
"updated_at": {
"type": "string",
"example": "2024-11-18T07:48:45.324348Z"
},
"integration_mode": {
"type": "string",
"example": "SEAMLESS"
}
}
}
}
},
{
"title": "MCC Order",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"example": "v1-251121102252-aa-6lsZkL"
},
"merchant_order_reference": {
"type": "string",
"example": "e707474f-59f7-4549-bad8-0d5f85b031d0"
},
"type": {
"type": "string",
"example": "CHARGE"
},
"status": {
"type": "string",
"example": "CREATED"
},
"merchant_id": {
"type": "string",
"example": "115129"
},
"order_amount": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"example": 10000,
"default": 0
},
"currency": {
"type": "string",
"example": "USD"
}
}
},
"pre_auth": {
"type": "boolean",
"example": false,
"default": true
},
"part_payment": {
"type": "boolean",
"example": false,
"default": true
},
"allowed_payment_methods": {
"type": "array",
"items": {
"type": "string",
"example": "CARD"
}
},
"purchase_details": {
"type": "object",
"properties": {
"customer": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "John"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"customer_id": {
"type": "string",
"example": "192212"
},
"country_code": {
"type": "string",
"example": "91"
},
"billing_address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "H.No 15, Sector 17"
},
"pincode": {
"type": "string",
"example": "160036"
},
"city": {
"type": "string",
"example": "CHANDIGARH"
},
"state": {
"type": "string",
"example": "PUNJAB"
},
"country": {
"type": "string",
"example": "INDIA"
},
"full_name": {
"type": "string",
"example": "vikas"
},
"address_type": {
"type": "string",
"example": "HOME"
},
"address_category": {
"type": "string",
"example": "BILLING"
}
}
},
"shipping_address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "H.No 15, Sector 17"
},
"pincode": {
"type": "string",
"example": "160036"
},
"city": {
"type": "string",
"example": "CHANDIGARH"
},
"state": {
"type": "string",
"example": "PUNJAB"
},
"country": {
"type": "string",
"example": "INDIA"
},
"full_name": {
"type": "string",
"example": "vikas"
},
"address_type": {
"type": "string",
"example": "HOME"
},
"address_category": {
"type": "string",
"example": "SHIPPING"
}
}
},
"is_edit_customer_details_allowed": {
"type": "boolean",
"example": false,
"default": true
},
"merchant_metadata": {
"type": "object",
"properties": {
"customerCreationDate": {
"type": "string",
"example": "2025-06-20"
},
"customerCreationDays": {
"type": "string",
"example": "10"
},
"customerType": {
"type": "string",
"example": "NEW"
}
}
}
}
},
"merchant_metadata": {
"type": "object",
"properties": {
"customerCreationDate": {
"type": "string",
"example": "2025-06-20"
},
"customerCreationDays": {
"type": "string",
"example": "10"
},
"customerType": {
"type": "string",
"example": "NEW"
}
}
},
"cart_details": {
"type": "object",
"properties": {
"cart_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "string",
"example": "9876"
},
"item_name": {
"type": "string",
"example": "T Shirt"
},
"item_description": {
"type": "string",
"example": "Test Description"
},
"item_details_url": {
"type": "string",
"example": "https://chriscross.in/cdn/shop/files/95_800x.jpg"
},
"item_image_url": {
"type": "string",
"example": "https://chriscross.in/cdn/shop/files/95_800x.jpg"
},
"item_original_unit_price": {
"type": "integer",
"example": 2,
"default": 0
},
"item_discounted_unit_price": {
"type": "integer",
"example": 2,
"default": 0
},
"item_quantity": {
"type": "integer",
"example": 7,
"default": 0
},
"item_currency": {
"type": "string",
"example": "USD"
}
}
}
}
}
}
}
},
"created_at": {
"type": "string",
"example": "2025-11-21T10:22:52.896Z"
},
"updated_at": {
"type": "string",
"example": "2025-11-21T10:22:52.896Z"
},
"integration_mode": {
"type": "string",
"example": "SEAMLESS"
},
"payment_retries_remaining": {
"type": "integer",
"example": 10,
"default": 0
},
"is_mcc_transaction": {
"type": "boolean",
"example": true,
"default": true
},
"is_domestic_txn_for_risk_enabled": {
"type": "boolean",
"example": false,
"default": true
},
"order_token": {
"type": "string",
"example": "mzohdLMNCzZ2SN3k1Ppglkz4mmk9edyahe34BM%2Fu9gA%3D"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"code\": \"INVALID_REQUEST\",\n \"message\": \"Amount must be an Integer value greater than or equal to 1\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "INVALID_REQUEST"
},
"message": {
"type": "string",
"example": "Amount must be an Integer value greater than or equal to 1"
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"code\":\"UNAUTHORIZED\",\n \"message\":\"Unauthorized\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "UNAUTHORIZED"
},
"message": {
"type": "string",
"example": "Unauthorized"
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"code\": \"DUPLICATE_REQUEST\",\n \"message\": \"Duplicate Merchant Reference ID received\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "DUPLICATE_REQUEST"
},
"message": {
"type": "string",
"example": "Duplicate Merchant Reference ID received"
}
}
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"code\": \"INTERNAL_ERROR\",\n \"message\": \"Internal Server Error\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "INTERNAL_ERROR"
},
"message": {
"type": "string",
"example": "Internal Server Error"
}
}
}
}
}
}
},
"deprecated": false
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```