Get Settlements by Order ID

Use this API to view all the settlements of a particular order.

GET /orders/{order_id}/settlements

Get Settlements by Order ID

cURL

curl --request GET \
  --url https://sandbox.cashfree.com/pg/orders/{order_id}/settlements \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'

200

{
  "cf_payment_id": "553338",
  "order_id": "order-12-127",
  "entity": "settlement",
  "order_amount": 100,
  "payment_time": "2021-07-13T13:13:59+05:30",
  "service_charge": 10,
  "service_tax": 1.8,
  "settlement_amount": 88.2,
  "cf_settlement_id": "6121238",
  "transfer_id": 238,
  "transfer_time": "2021-07-25T12:57:52+05:30",
  "transfer_utr": "N87912312",
  "order_currency": "INR",
  "settlement_currency": "INR",
  "forex_conversion_handling_charge": 11.12,
  "forex_conversion_handling_tax": 1.12,
  "forex_conversion_rate": 84.24,
  "charges_currency": "INR"
}

Authorizations

XClientID & XClientSecretXClientID & XPartnerAPIKeyXClientID & XClientSignatureHeaderXPartnerMerchantID & XPartnerAPIKey

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.

Headers

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

API version to be used.

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<UUID>

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.

Path Parameters

order_id · string · required

The ID which uniquely identifies your order.

Response

200

application/json

OK

Settlement entity object.

cf_payment_id · string

cf_settlement_id · string

settlement_currency · string

order_id · string

entity · string

order_amount · number

payment_time · string

service_charge · number

service_tax · number

settlement_amount · number

settlement_id · integer

transfer_id · integer

transfer_time · string

transfer_utr · string

forex_conversion_handling_charge · number

Cashfree forex conversion charges for refund processing.

forex_conversion_handling_tax · number

Cashfree forex conversion tax for refund processing.

forex_conversion_rate · number

Cashfree forex conversion rate for refund processing.

charges_currency · string

Cashfree refund charges currency for a refund.