Skip to main content
POST
/
order
/
pay
/
{order_hash}
Create Payment
curl --request POST \
  --url https://sandbox.flowwise.com/router/order/pay/{order_hash} \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "payment_method": "upi",
  "payment_method_details": {
    "upi_id": "priya.sharma@paytm",
    "app_name": "PhonePe"
  },
  "return_base_url": "https://mystore.com/payment-success"
}
'
{
  "payment_id": "pay_summer_fashion_001_upi",
  "order_id": "order_summer_fashion_001",
  "payment_method": "upi",
  "payment_amount": 2299.5,
  "payment_status": "SUCCESS",
  "capture_status": "SUCCESS",
  "capture_amount": 2299.5,
  "processor_ref": "UPI434512345678901234",
  "redirect_url": "https://payments.flowwise.com/redirect/pay_summer_fashion_001_upi",
  "return_url": "https://mystore.com/payment-success?order_id=order_summer_fashion_001",
  "payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "payment_time": "2024-12-03T14:32:15Z",
  "order_expiry_time": "2024-12-03T16: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.

Path Parameters

​
order_hash
string
required

Hash value for the order used for payment processing.

Example:

"a7f8e3d2c1b9f4e6d8a2c5b7f9e3d1a8"

Body

application/json

Request parameters to create a new payment.

​
payment_method
enum<string>
required

Payment method to be used for the transaction.

Available options:
upi,
card,
netbanking,
wallet
Example:

"upi"

​
payment_method_details
object
required

Details specific to the payment method. For structure information, see the documentation.

Example:
{
  "upi_id": "priya.sharma@paytm",
  "app_name": "PhonePe"
}
​
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 payment creation.

​
payment_id
string

Unique identifier for the payment transaction.

Example:

"pay_summer_fashion_001_upi"

​
order_id
string

Unique identifier for the associated order.

Example:

"order_summer_fashion_001"

​
payment_method
string

Payment method used for the transaction.

Example:

"upi"

​
payment_amount
number

Amount processed for the payment.

Example:

2299.5

​
payment_status
string

Current status of the payment transaction.

Example:

"SUCCESS"

​
capture_status
string

Status of the payment capture process.

Example:

"SUCCESS"

​
capture_amount
number

Amount that has been captured from the payment.

Example:

2299.5

​
processor_ref
string

Reference identifier from the payment processor.

Example:

"UPI434512345678901234"

​
redirect_url
string<uri>

URL to redirect the customer for payment completion.

Example:

"https://payments.flowwise.com/redirect/pay_summer_fashion_001_upi"

​
return_url
string<uri>

URL where the customer will be redirected after payment completion.

Example:

"https://mystore.com/payment-success?order_id=order_summer_fashion_001"

​
payload
string

Additional payload data for the payment.

Example:

"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."

​
payment_time
string<date-time>

Date and time when the payment was initiated.

Example:

"2024-12-03T14:32:15Z"

​
order_expiry_time
string<date-time>

Date and time when the order expires.

Example:

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