Cashfree Payments Developer Documentation

Get Import Settlement Details

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

{
  "cf_order_details": {
    "cf_payment_id": 5114911054376,
    "order_amount": 8455,
    "order_currency": "INR",
    "order_id": "6cafd7aa-6568-4cc4-ba71-5e528272a3d3",
    "payment_time": "2024-08-28T15:37:49"
  },
  "cf_ica_settlement_details": {
    "cf_ica_settlement_id": 10,
    "status": "SETTLED",
    "collection_amount_inr": 86176,
    "service_charge_inr": 1637.38,
    "service_tax_inr": 294.73,
    "adjustment_amount_inr": -18743.89,
    "settlement_charges_inr": 0,
    "settlement_tax_inr": 0,
    "settlement_amount_inr": 65500.04,
    "settlement_foreign_currency_details": {
      "settlement_currency": "USD",
      "settlement_forex_rate": 83.8788,
      "settlement_amount": 780.8891
    },
    "payment_from": "2024-08-28T15:36:33",
    "payment_till": "2024-08-28T15:37:49",
    "settlement_utr": "123412",
    "initiated_on": "2024-08-28T17:24:55",
    "settled_on": "2024-08-29T16:30:46"
  }
}

GET

import

orders

{order_id}

settlements

Get Import Settlement Details

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

{
  "cf_order_details": {
    "cf_payment_id": 5114911054376,
    "order_amount": 8455,
    "order_currency": "INR",
    "order_id": "6cafd7aa-6568-4cc4-ba71-5e528272a3d3",
    "payment_time": "2024-08-28T15:37:49"
  },
  "cf_ica_settlement_details": {
    "cf_ica_settlement_id": 10,
    "status": "SETTLED",
    "collection_amount_inr": 86176,
    "service_charge_inr": 1637.38,
    "service_tax_inr": 294.73,
    "adjustment_amount_inr": -18743.89,
    "settlement_charges_inr": 0,
    "settlement_tax_inr": 0,
    "settlement_amount_inr": 65500.04,
    "settlement_foreign_currency_details": {
      "settlement_currency": "USD",
      "settlement_forex_rate": 83.8788,
      "settlement_amount": 780.8891
    },
    "payment_from": "2024-08-28T15:36:33",
    "payment_till": "2024-08-28T15:37:49",
    "settlement_utr": "123412",
    "initiated_on": "2024-08-28T17:24:55",
    "settled_on": "2024-08-29T16:30:46"
  }
}

Headers

x-client-id

string

required

Client ID generated from the merchant dashboard.

x-client-secret

string

required

Client secret generated from the merchant dashboard.

x-api-version

string

default:2023-08-01

required

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

Path Parameters

order_id

string

required

Your order ID

Response

Success response for getting the import settlement details.

cf_order_details

object

Contains information about the order related to the settlement

Show child attributes

cf_order_details.cf_payment_id

number

Unique payment ID associated with the order

Example:

5114911054376

cf_order_details.order_amount

number

Total order amount in numeric value

Example:

8455

cf_order_details.order_currency

string

Currency of the order

Example:

"INR"

cf_order_details.order_id

string

Unique order identifier

Example:

"6cafd7aa-6568-4cc4-ba71-5e528272a3d3"

cf_order_details.payment_time

string

Time when payment for the order was processed

Example:

"2024-08-28T15:37:49"

cf_ica_settlement_details

object

Contains information about the settlement transaction

Show child attributes

cf_ica_settlement_details.settlement_id

number

Unique ID of the settlement

Example:

10

cf_ica_settlement_details.status

string

Current status of the settlement

Example:

"SETTLED"

cf_ica_settlement_details.collection_amount_inr

number

Total collected amount in INR

Example:

86176

cf_ica_settlement_details.service_charge_inr

number

Service charge in INR, if applicable

Example:

1637.38

cf_ica_settlement_details.service_tax_inr

number

Service tax in INR

Example:

294.73

cf_ica_settlement_details.adjustment_amount_inr

number

Adjustment amount in INR

Example:

-18743.89

cf_ica_settlement_details.settlement_charges_inr

number

Charges related to the settlement in INR

Example:

0

cf_ica_settlement_details.settlement_tax_inr

number

Tax on settlement in INR

Example:

0

cf_ica_settlement_details.settlement_amount_inr

number

Total settlement amount in INR

Example:

65500.04

cf_ica_settlement_details.settlement_foreign_currency_details

object

Show child attributes

cf_ica_settlement_details.settlement_foreign_currency_details.settlement_currency

string

Currency of the settlement amount

Example:

"USD"

cf_ica_settlement_details.settlement_foreign_currency_details.settlement_forex_rate

number

Exchange rate used for conversion to settlement currency

Example:

83.8788

cf_ica_settlement_details.settlement_foreign_currency_details.settlement_amount

number

Amount in the foreign currency after conversion

Example:

780.8891

cf_ica_settlement_details.payment_from

string

Start time of the payment period

Example:

"2024-08-28T15:36:33"

cf_ica_settlement_details.payment_till

string

End time of the payment period

Example:

"2024-08-28T15:37:49"

cf_ica_settlement_details.settlement_utr

string

Unique transaction reference (UTR) for the settlement

Example:

"123412"

cf_ica_settlement_details.initiated_on

string

Date and time when the settlement was initiated

Example:

"2024-08-28T17:24:55"

cf_ica_settlement_details.settled_on

string

Date and time when the settlement was completed

Example:

"2024-08-29T16:30:46"

Get payment verification details Get Import Settlement recon details

⌘I

Payments API

v2025-01-01

Other Versions

Get Import Settlement Details

Headers

Path Parameters

Response