v2025-01-01
- Overview
- Orders
- Payments
- Payment Links
- Refunds
- Customers
- Payment Methods
- Offers
- Settlements
- Simulation
- Utilities
Settlements
Settlement Reconciliation
- Use this API to get settlement reconciliation details using Settlement ID, settlement UTR or date range.
- This API will return events for the settlement IDs you want
POST
/
settlement
/
recon
Copy
curl --request POST \
--url https://sandbox.cashfree.com/pg/settlement/recon \
--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 '{
"pagination": {
"limit": 10,
"cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=="
},
"filters": {
"cf_settlement_ids": [
"4234233"
],
"settlement_utrs": [
"utr1",
"utr2"
],
"start_date": "2022-07-20T00:00:00Z",
"end_date": "2022-07-21T23:59:59Z"
}
}'
Copy
{
"cursor": "cursor",
"limit": 7,
"data": [
{
"cutomer_details": {
"customer_bank_account_number": "1234567",
"customer_bank_code": "123",
"customer_bank_ifsc": "SBIN000123",
"customer_email": "manideep.ellur@cashfree.com",
"customer_id": "Manideep",
"customer_name": "Manideep",
"customer_phone": "8281554863"
},
"dispute_details": {
"closed_in_favor_of": null,
"dispute_category": null,
"dispute_note": null,
"dispute_resolved_on": null,
"resolved_on": null
},
"event_details": {
"entity": "recon",
"event_amount": 200,
"event_currency": "INR",
"event_id": "43594",
"event_remarks": "null,",
"event_service_charge": 2,
"event_service_tax": 0,
"event_settlement_amount": 200,
"event_status": "SUCCESS",
"event_time": "2025-01-16T15:06:41+05:30",
"event_type": "PAYMENT",
"sale_type": "CREDIT"
},
"order_details": {
"order_amount": 3000,
"order_currency": "INR",
"order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
"order_tags": {
"key1": "value1",
"key2": "value2"
}
},
"payment_details": {
"bank_reference": 210396,
"cf_payment_id": "1234881617186388204",
"charges_currency": "INR",
"forex_conversion_handling_charge": 0,
"forex_conversion_handling_tax": 0,
"payment_amount": null,
"payment_currency": "INR",
"payment_mode": "CREDIT_CARD",
"payment_service_charge": 2,
"payment_service_tax": 0,
"payment_time": null,
"status": null
},
"refund_details": {
"refund_arn": "null,",
"refund_id": "null,",
"refund_note": "null,",
"refund_processed_at": null
},
"settlement_details": {
"adjustment": null,
"amount_settled": null,
"cf_settlement_id": "1639775422",
"payment_from": null,
"payment_till": null,
"reason": null,
"remarks": null,
"service_charge": null,
"service_tax": null,
"settlement_charge": null,
"settlement_date": "2025-01-16T18:33:51+05:30",
"settlement_initiated_on": "2025-01-16T15:33:51+05:30",
"settlement_tax": null,
"settlement_type": null,
"split_service_charge": 0,
"split_service_tax": 0,
"utr": "PGI45406",
"vendor_commission": 0
}
},
{
"cutomer_details": {
"customer_bank_account_number": "1234567",
"customer_bank_code": "123",
"customer_bank_ifsc": "SBIN000123",
"customer_email": "manideep.ellur@cashfree.com",
"customer_id": "Manideep",
"customer_name": "Manideep",
"customer_phone": "8281554863"
},
"dispute_details": {
"closed_in_favor_of": "MERCHANT",
"dispute_category": "1402-Duplicate Processing",
"dispute_note": "test",
"dispute_resolved_on": "2025-01-16 10:15:10",
"resolved_on": "2025-01-16 10:15:10"
},
"event_details": {
"entity": "recon",
"event_amount": 200,
"event_currency": "INR",
"event_id": "43594",
"event_remarks": "null,",
"event_service_charge": 2,
"event_service_tax": 0,
"event_settlement_amount": 200,
"event_status": "SUCCESS",
"event_time": "2025-01-16T15:06:41+05:30",
"event_type": "DISPUTE",
"sale_type": "DEBIT"
},
"order_details": {
"order_amount": 3000,
"order_currency": "INR",
"order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
"order_tags": {
"key1": "value1",
"key2": "value2"
}
},
"payment_details": {
"bank_reference": 210396,
"cf_payment_id": "1234881617186388204",
"charges_currency": "INR",
"forex_conversion_handling_charge": 0,
"forex_conversion_handling_tax": 0,
"payment_amount": null,
"payment_currency": "INR",
"payment_mode": "CREDIT_CARD",
"payment_service_charge": 2,
"payment_service_tax": 0,
"payment_time": null,
"status": null
},
"refund_details": {
"refund_arn": "null,",
"refund_id": "null,",
"refund_note": "null,",
"refund_processed_at": null
},
"settlement_details": {
"adjustment": null,
"amount_settled": null,
"cf_settlement_id": "1639775422",
"payment_from": null,
"payment_till": null,
"reason": null,
"remarks": null,
"service_charge": null,
"service_tax": null,
"settlement_charge": null,
"settlement_date": "2025-01-16T18:33:51+05:30",
"settlement_initiated_on": "2025-01-16T15:33:51+05:30",
"settlement_tax": null,
"settlement_type": null,
"split_service_charge": 0,
"split_service_tax": 0,
"utr": "PGI45406",
"vendor_commission": 0
}
},
{
"cutomer_details": {
"customer_bank_account_number": "1234567",
"customer_bank_code": "123",
"customer_bank_ifsc": "SBIN000123",
"customer_email": "manideep.ellur@cashfree.com",
"customer_id": "Manideep",
"customer_name": "Manideep",
"customer_phone": "8281554863"
},
"dispute_details": {
"closed_in_favor_of": null,
"dispute_category": null,
"dispute_note": null,
"dispute_resolved_on": null,
"resolved_on": null
},
"event_details": {
"entity": "recon",
"event_amount": 200,
"event_currency": "INR",
"event_id": "43594",
"event_remarks": "FUND_SWEEP_REVERSAL",
"event_service_charge": null,
"event_service_tax": null,
"event_settlement_amount": 200,
"event_status": "SUCCESS",
"event_time": "2025-01-16T15:06:41+05:30",
"event_type": "FUND_SWEEP_REVERSAL",
"sale_type": "CREDIT"
},
"order_details": {
"order_amount": null,
"order_currency": null,
"order_id": null,
"order_tags": null
},
"payment_details": {
"bank_reference": null,
"cf_payment_id": null,
"charges_currency": null,
"forex_conversion_handling_charge": null,
"forex_conversion_handling_tax": null,
"payment_amount": null,
"payment_currency": null,
"payment_mode": null,
"payment_service_charge": null,
"payment_service_tax": null,
"payment_time": null,
"status": null
},
"refund_details": {
"refund_arn": "null,",
"refund_id": "null,",
"refund_note": "null,",
"refund_processed_at": null
},
"settlement_details": {
"adjustment": null,
"amount_settled": null,
"cf_settlement_id": "1639775422",
"payment_from": null,
"payment_till": null,
"reason": null,
"remarks": null,
"service_charge": null,
"service_tax": null,
"settlement_charge": null,
"settlement_date": "2025-01-16T18:33:51+05:30",
"settlement_initiated_on": "2025-01-16T15:33:51+05:30",
"settlement_tax": null,
"settlement_type": null,
"split_service_charge": 0,
"split_service_tax": 0,
"utr": "PGI45406",
"vendor_commission": 0
}
}
]
}
Authorizations
Client app ID. You can find your app id in the merchant dashboard.
Client secret key. You can find your secret in the merchant dashboard.
Headers
application/json
API version to be used. Format is in YYYY-MM-DD.
Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.
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.
application/json
Body
application/json
Request Body for the settlement reconciliation
Recon Request Object
Response
200
application/json
OK
Recon object for settlement
Copy
curl --request POST \
--url https://sandbox.cashfree.com/pg/settlement/recon \
--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 '{
"pagination": {
"limit": 10,
"cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ=="
},
"filters": {
"cf_settlement_ids": [
"4234233"
],
"settlement_utrs": [
"utr1",
"utr2"
],
"start_date": "2022-07-20T00:00:00Z",
"end_date": "2022-07-21T23:59:59Z"
}
}'
Copy
{
"cursor": "cursor",
"limit": 7,
"data": [
{
"cutomer_details": {
"customer_bank_account_number": "1234567",
"customer_bank_code": "123",
"customer_bank_ifsc": "SBIN000123",
"customer_email": "manideep.ellur@cashfree.com",
"customer_id": "Manideep",
"customer_name": "Manideep",
"customer_phone": "8281554863"
},
"dispute_details": {
"closed_in_favor_of": null,
"dispute_category": null,
"dispute_note": null,
"dispute_resolved_on": null,
"resolved_on": null
},
"event_details": {
"entity": "recon",
"event_amount": 200,
"event_currency": "INR",
"event_id": "43594",
"event_remarks": "null,",
"event_service_charge": 2,
"event_service_tax": 0,
"event_settlement_amount": 200,
"event_status": "SUCCESS",
"event_time": "2025-01-16T15:06:41+05:30",
"event_type": "PAYMENT",
"sale_type": "CREDIT"
},
"order_details": {
"order_amount": 3000,
"order_currency": "INR",
"order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
"order_tags": {
"key1": "value1",
"key2": "value2"
}
},
"payment_details": {
"bank_reference": 210396,
"cf_payment_id": "1234881617186388204",
"charges_currency": "INR",
"forex_conversion_handling_charge": 0,
"forex_conversion_handling_tax": 0,
"payment_amount": null,
"payment_currency": "INR",
"payment_mode": "CREDIT_CARD",
"payment_service_charge": 2,
"payment_service_tax": 0,
"payment_time": null,
"status": null
},
"refund_details": {
"refund_arn": "null,",
"refund_id": "null,",
"refund_note": "null,",
"refund_processed_at": null
},
"settlement_details": {
"adjustment": null,
"amount_settled": null,
"cf_settlement_id": "1639775422",
"payment_from": null,
"payment_till": null,
"reason": null,
"remarks": null,
"service_charge": null,
"service_tax": null,
"settlement_charge": null,
"settlement_date": "2025-01-16T18:33:51+05:30",
"settlement_initiated_on": "2025-01-16T15:33:51+05:30",
"settlement_tax": null,
"settlement_type": null,
"split_service_charge": 0,
"split_service_tax": 0,
"utr": "PGI45406",
"vendor_commission": 0
}
},
{
"cutomer_details": {
"customer_bank_account_number": "1234567",
"customer_bank_code": "123",
"customer_bank_ifsc": "SBIN000123",
"customer_email": "manideep.ellur@cashfree.com",
"customer_id": "Manideep",
"customer_name": "Manideep",
"customer_phone": "8281554863"
},
"dispute_details": {
"closed_in_favor_of": "MERCHANT",
"dispute_category": "1402-Duplicate Processing",
"dispute_note": "test",
"dispute_resolved_on": "2025-01-16 10:15:10",
"resolved_on": "2025-01-16 10:15:10"
},
"event_details": {
"entity": "recon",
"event_amount": 200,
"event_currency": "INR",
"event_id": "43594",
"event_remarks": "null,",
"event_service_charge": 2,
"event_service_tax": 0,
"event_settlement_amount": 200,
"event_status": "SUCCESS",
"event_time": "2025-01-16T15:06:41+05:30",
"event_type": "DISPUTE",
"sale_type": "DEBIT"
},
"order_details": {
"order_amount": 3000,
"order_currency": "INR",
"order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
"order_tags": {
"key1": "value1",
"key2": "value2"
}
},
"payment_details": {
"bank_reference": 210396,
"cf_payment_id": "1234881617186388204",
"charges_currency": "INR",
"forex_conversion_handling_charge": 0,
"forex_conversion_handling_tax": 0,
"payment_amount": null,
"payment_currency": "INR",
"payment_mode": "CREDIT_CARD",
"payment_service_charge": 2,
"payment_service_tax": 0,
"payment_time": null,
"status": null
},
"refund_details": {
"refund_arn": "null,",
"refund_id": "null,",
"refund_note": "null,",
"refund_processed_at": null
},
"settlement_details": {
"adjustment": null,
"amount_settled": null,
"cf_settlement_id": "1639775422",
"payment_from": null,
"payment_till": null,
"reason": null,
"remarks": null,
"service_charge": null,
"service_tax": null,
"settlement_charge": null,
"settlement_date": "2025-01-16T18:33:51+05:30",
"settlement_initiated_on": "2025-01-16T15:33:51+05:30",
"settlement_tax": null,
"settlement_type": null,
"split_service_charge": 0,
"split_service_tax": 0,
"utr": "PGI45406",
"vendor_commission": 0
}
},
{
"cutomer_details": {
"customer_bank_account_number": "1234567",
"customer_bank_code": "123",
"customer_bank_ifsc": "SBIN000123",
"customer_email": "manideep.ellur@cashfree.com",
"customer_id": "Manideep",
"customer_name": "Manideep",
"customer_phone": "8281554863"
},
"dispute_details": {
"closed_in_favor_of": null,
"dispute_category": null,
"dispute_note": null,
"dispute_resolved_on": null,
"resolved_on": null
},
"event_details": {
"entity": "recon",
"event_amount": 200,
"event_currency": "INR",
"event_id": "43594",
"event_remarks": "FUND_SWEEP_REVERSAL",
"event_service_charge": null,
"event_service_tax": null,
"event_settlement_amount": 200,
"event_status": "SUCCESS",
"event_time": "2025-01-16T15:06:41+05:30",
"event_type": "FUND_SWEEP_REVERSAL",
"sale_type": "CREDIT"
},
"order_details": {
"order_amount": null,
"order_currency": null,
"order_id": null,
"order_tags": null
},
"payment_details": {
"bank_reference": null,
"cf_payment_id": null,
"charges_currency": null,
"forex_conversion_handling_charge": null,
"forex_conversion_handling_tax": null,
"payment_amount": null,
"payment_currency": null,
"payment_mode": null,
"payment_service_charge": null,
"payment_service_tax": null,
"payment_time": null,
"status": null
},
"refund_details": {
"refund_arn": "null,",
"refund_id": "null,",
"refund_note": "null,",
"refund_processed_at": null
},
"settlement_details": {
"adjustment": null,
"amount_settled": null,
"cf_settlement_id": "1639775422",
"payment_from": null,
"payment_till": null,
"reason": null,
"remarks": null,
"service_charge": null,
"service_tax": null,
"settlement_charge": null,
"settlement_date": "2025-01-16T18:33:51+05:30",
"settlement_initiated_on": "2025-01-16T15:33:51+05:30",
"settlement_tax": null,
"settlement_type": null,
"split_service_charge": 0,
"split_service_tax": 0,
"utr": "PGI45406",
"vendor_commission": 0
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.