v2025-01-01
- Overview
- Orders
- Payments
- Payment Links
- Refunds
- Customers
- Easy-Split
- Payment Methods
- Offers
- Token Vault
- Disputes
- Settlements
- softPOS
- Simulation
- Subscription
- VBA
- Cross Border
- Utilities
Other Versions
- v2023-08-01
- End Points
- Release Notes
- Orders
- Payments
- Payment Links
- Refunds
- Customers
- Easy-Split
- Eligibility
- Offers
- Dispute
- Settlements
- Partners
- Token Vault
- softPOS
- Simulation
- Subscription
- VBA
- Cross Border
- v2022-01-01
Get Import Settlement details
This API is used to get ICA settlement details using PG Order ID
curl --request GET \
--url https://sandbox.cashfree.com/import/transactions/{order_id}/settlement \
--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": null,
"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
client id generated from the merchant dashboard
client secret generated from the merchant dashboard
API version to be used. Format is in YYYY-MM-DD
Path Parameters
Your order id
Response
Contains information about the order related to the settlement
Unique payment ID associated with the order
5114911054376
Total order amount in numeric value
8455
Currency of the order
"INR"
Unique order identifier
"6cafd7aa-6568-4cc4-ba71-5e528272a3d3"
Time when payment for the order was processed
"2024-08-28T15:37:49"
Contains information about the settlement transaction
Unique ID of the settlement
10
Current status of the settlement
"SETTLED"
Total collected amount in INR
86176
Service charge in INR, if applicable
Service tax in INR
294.73
Adjustment amount in INR
-18743.89
Charges related to the settlement in INR
0
Tax on settlement in INR
0
Total settlement amount in INR
65500.04
Currency of the settlement amount
"USD"
Exchange rate used for conversion to settlement currency
83.8788
Amount in the foreign currency after conversion
780.8891
Start time of the payment period
"2024-08-28T15:36:33"
End time of the payment period
"2024-08-28T15:37:49"
Unique transaction reference (UTR) for the settlement
"123412"
Date and time when the settlement was initiated
"2024-08-28T17:24:55"
Date and time when the settlement was completed
"2024-08-29T16:30:46"
Was this page helpful?
curl --request GET \
--url https://sandbox.cashfree.com/import/transactions/{order_id}/settlement \
--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": null,
"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"
}
}