Skip to main content
POST
/
orders
Create Order
curl --request POST \
  --url https://sandbox.flowwise.com/router/orders \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "order_id": "order_summer_fashion_001",
  "order_amount": 2299.5,
  "order_currency": "INR",
  "customer_details": {
    "customer_email": "priya.sharma@example.com",
    "customer_phone": "+919876543210",
    "customer_address": "123 Connaught Place, New Delhi, Delhi 110001, India",
    "customer_id": "cust_priya_sharma_2024"
  },
  "payment_methods": "cc,dc,upi,nb,wallet",
  "expiry_time_in_minutes": 120,
  "order_note": "Summer collection dress - Medium size, Blue color",
  "order_tags": {
    "source": "mobile_app",
    "campaign": "summer_sale_2024",
    "customer_segment": "premium"
  },
  "return_base_url": "https://mystore.com/payment-success"
}
'
{
  "order_id": "order_summer_fashion_001",
  "project_id": "proj_fashion_store_2024",
  "customer_email": "priya.sharma@example.com",
  "customer_id": "cust_priya_sharma_2024",
  "order_status": "ACTIVE",
  "order_currency": "INR",
  "payment_methods": "cc,dc,upi,nb,wallet",
  "order_note": "Summer collection dress - Medium size, Blue color",
  "checkout_url": "https://payments.flowwise.com/checkout/order_summer_fashion_001",
  "order_hash": "a7f8e3d2c1b9f4e6d8a2c5b7f9e3d1a8",
  "order_expiry_time": "2024-12-03T16:30:00Z",
  "added_on": "2024-12-03T14:30:00Z"
}

Authorizations

​
x-client-id
string
header
required

Client app ID. You can find your app ID in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Body

application/json

Request parameters to create a new order.

​
order_id
string
required

Unique identifier for the order.

Example:

"order_summer_fashion_001"

​
order_amount
number<float>
required

Total amount for the order.

Example:

2299.5

​
order_currency
string
required

Currency code for the order amount.

Example:

"INR"

​
customer_details
object
required

Customer information for the order.

​
payment_methods
string

Allowed payment methods for the order.

Example:

"cc,dc,upi,nb,wallet"

​
expiry_time_in_minutes
integer

Time in minutes after which the order expires.

Example:

120

​
order_note
string

Additional notes or description for the order.

Example:

"Summer collection dress - Medium size, Blue color"

​
order_tags
object

Additional metadata tags for the order.

Example:
{
  "source": "mobile_app",
  "campaign": "summer_sale_2024",
  "customer_segment": "premium"
}
​
return_base_url
string<uri>

Base URL where the customer will be redirected after payment completion.

Example:

"https://mystore.com/payment-success"

Response

Success response for order creation.

​
order_id
string

Unique identifier for the order.

Example:

"order_summer_fashion_001"

​
project_id
string

Identifier for the project associated with the order.

Example:

"proj_fashion_store_2024"

​
customer_email
string

Email address of the customer.

Example:

"priya.sharma@example.com"

​
customer_id
string

Unique identifier for the customer.

Example:

"cust_priya_sharma_2024"

​
order_status
string

Current status of the order.

Example:

"ACTIVE"

​
order_currency
string

Currency code for the order amount.

Example:

"INR"

​
payment_methods
string

Available payment methods for the order.

Example:

"cc,dc,upi,nb,wallet"

​
order_note
string

Additional notes or description for the order.

Example:

"Summer collection dress - Medium size, Blue color"

​
checkout_url
string<uri>

URL for the customer to complete the payment.

Example:

"https://payments.flowwise.com/checkout/order_summer_fashion_001"

​
order_hash
string

Hash value for the order used for payment processing.

Example:

"a7f8e3d2c1b9f4e6d8a2c5b7f9e3d1a8"

​
order_expiry_time
string<date-time>

Date and time when the order expires.

Example:

"2024-12-03T16:30:00Z"

​
added_on
string<date-time>

Date and time when the order was created.

Example:

"2024-12-03T14:30:00Z"