POST
/
orders
/
settlements
curl --request POST \
  --url https://sandbox.cashfree.com/pg/orders/settlements \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "order_id": "order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H",
  "meta_data": {
    "cbriks_id": "CBRIKS_004",
    "settlement_date": "2024-04-12"
  }
}'
{}

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 in the merchant dashboard.

Headers

x-api-version
string
default:2025-01-01
required

API version to be used. Format is in YYYY-MM-DD

x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

x-idempotency-key
string

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Body

application/json
Create Order Settlement Request Body.

Create Order Settlement Object

order_id
string
required

OrderId of the order.

meta_data
object
required

Response

202
application/json
OK

The response is of type object.