POST
/
settlement
/
recon
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"
  }
}'
{
  "cursor": "cursor",
  "limit": 7,
  "data": [
    {
      "event_id": "43594",
      "entity": "recon",
      "event_type": "REFUND",
      "sale_type": "DEBIT",
      "event_time": "2022-08-16T15:06:41+05:30",
      "event_settlement_amount": 200,
      "event_amount": 200,
      "event_status": "SUCCESS",
      "event_currency": "INR",
      "order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
      "customer_name": "Manideep",
      "customer_phone": "8281554863",
      "customer_email": "manideep.ellur@cashfree.com",
      "cf_payment_id": "885472862",
      "payment_amount": 3067.26,
      "order_amount": 3000,
      "payment_time": "2022-08-16T14:41:06+05:30",
      "payment_service_charge": 0,
      "payment_service_tax": 0,
      "payment_utr": "210396",
      "cf_settlement_id": "45406",
      "vendor_commission": 0,
      "split_service_charge": 0,
      "split_service_tax": 0,
      "settlement_utr": "PGI45406",
      "settlement_date": "2022-08-16T14:45:24+05:30",
      "refund_note": "nh",
      "refund_id": "REF_bb406ef0-886b-4f96-8fef-ba0a15d901e6",
      "refund_arn": "test",
      "refund_processed_at": "2022-08-16T15:06:41+05:30",
      "payment_group": "CREDIT_CARD"
    },
    {
      "event_id": "43594",
      "entity": "recon",
      "event_type": "REFUND_REVERSAL",
      "sale_type": "DEBIT",
      "event_time": "2022-08-16T15:06:41+05:30",
      "event_settlement_amount": 200,
      "event_amount": 200,
      "event_status": "SUCCESS",
      "event_currency": "INR",
      "order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
      "customer_name": "Manideep",
      "customer_phone": "8281554863",
      "customer_email": "manideep.ellur@cashfree.com",
      "cf_payment_id": "885472862",
      "payment_amount": 3067.26,
      "order_amount": 3000,
      "payment_time": "2022-08-16T14:41:06+05:30",
      "payment_service_charge": 0,
      "payment_service_tax": 0,
      "payment_utr": "210396",
      "cf_settlement_id": "45406",
      "vendor_commission": 0,
      "split_service_charge": 0,
      "split_service_tax": 0,
      "settlement_utr": "PGI45406",
      "settlement_date": "2022-08-16T14:45:24+05:30",
      "refund_note": "nh",
      "refund_id": "REF_bb406ef0-886b-4f96-8fef-ba0a15d901e6",
      "refund_arn": "test",
      "refund_processed_at": "2022-08-16T15:06:41+05:30",
      "payment_group": "CREDIT_CARD"
    },
    {
      "event_id": "272",
      "entity": "recon",
      "event_type": "DISPUTE",
      "sale_type": "DEBIT",
      "event_time": "2022-08-16T14:52:55+05:30",
      "event_settlement_amount": 3067.26,
      "event_amount": 3067.26,
      "event_status": "CLOSED",
      "event_currency": "INR",
      "order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
      "customer_name": "Manideep",
      "customer_phone": "8281554863",
      "customer_email": "manideep.ellur@cashfree.com",
      "cf_payment_id": "885472862",
      "payment_amount": 3067.26,
      "order_amount": 3000,
      "payment_time": "2022-08-16T14:41:06+05:30",
      "payment_service_charge": 0,
      "payment_service_tax": 0,
      "payment_utr": "210396",
      "cf_settlement_id": "45406",
      "vendor_commission": 0,
      "split_service_charge": 0,
      "split_service_tax": 0,
      "settlement_utr": "PGI45406",
      "settlement_date": "2022-08-16T14:45:24+05:30",
      "closed_in_favor_of": "MERCHANT",
      "dispute_category": "1402-Duplicate Processing",
      "dispute_note": "tesr",
      "dispute_resolved_on": "2022-08-16 14:53:15",
      "payment_group": "CREDIT_CARD"
    },
    {
      "event_id": "272",
      "entity": "recon",
      "event_type": "DISPUTE_REVERSAL",
      "sale_type": "CREDIT",
      "event_time": "2022-08-16T14:52:55+05:30",
      "event_settlement_amount": 3067.26,
      "event_amount": 3067.26,
      "event_status": "CLOSED",
      "event_currency": "INR",
      "order_id": "order_1527072DQpGNwTMBlnAc1GfxmWalriHBG",
      "customer_name": "Manideep",
      "customer_phone": "8281554863",
      "customer_email": "manideep.ellur@cashfree.com",
      "cf_payment_id": "885472862",
      "payment_amount": 3067.26,
      "order_amount": 3000,
      "payment_time": "2022-08-16T14:41:06+05:30",
      "payment_service_charge": 0,
      "payment_service_tax": 0,
      "payment_utr": "210396",
      "cf_settlement_id": "45406",
      "vendor_commission": 0,
      "split_service_charge": 0,
      "split_service_tax": 0,
      "settlement_utr": "PGI45406",
      "settlement_date": "2022-08-16T14:45:24+05:30",
      "closed_in_favor_of": "MERCHANT",
      "dispute_category": "1402-Duplicate Processing",
      "dispute_note": "tesr",
      "dispute_resolved_on": "2022-08-16 14:53:15",
      "payment_group": "CREDIT_CARD"
    },
    {
      "event_id": "885472982",
      "entity": "recon",
      "event_type": "PAYMENT",
      "sale_type": "CREDIT",
      "event_time": "2022-08-16T15:07:56+05:30",
      "event_settlement_amount": 3000,
      "event_amount": 3067.26,
      "event_status": "SUCCESS",
      "event_currency": "INR",
      "order_id": "order_1527072DQsWeQWtwlll6BhI3bt0Fluj81",
      "customer_name": "Manideep",
      "customer_phone": "8281554863",
      "customer_email": "manideep.ellur@cashfree.com",
      "order_amount": 3000,
      "payment_service_charge": 0,
      "payment_service_tax": 0,
      "payment_utr": "572910",
      "cf_settlement_id": "45406",
      "vendor_commission": 0,
      "split_service_charge": 0,
      "split_service_tax": 0,
      "settlement_utr": "PGI45406",
      "settlement_date": "2022-08-16T15:08:51+05:30",
      "payment_group": "CREDIT_CARD"
    },
    {
      "event_id": "45406",
      "entity": "recon",
      "event_type": "OTHER_ADJUSTMENT",
      "sale_type": "DEBIT",
      "event_time": "2022-08-16T15:08:48+05:30",
      "event_settlement_amount": 3,
      "event_amount": 3,
      "event_currency": "INR",
      "cf_settlement_id": "45406",
      "adjustment_remarks": "INSTANT_SETTLEMENT_CHARGE",
      "payment_group": "CREDIT_CARD"
    },
    {
      "event_id": "45406",
      "entity": "recon",
      "event_type": "OTHER_ADJUSTMENT",
      "sale_type": "DEBIT",
      "event_time": "2022-08-16T15:08:48+05:30",
      "event_settlement_amount": 0.54,
      "event_amount": 0.54,
      "event_currency": "INR",
      "cf_settlement_id": "45406",
      "adjustment_remarks": "INSTANT_SETTLEMENT_TAX",
      "payment_group": "CREDIT_CARD"
    }
  ]
}

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

​
Content-Type
string

application/json

​
x-api-version
string
default:2023-08-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.

​
Accept
string

application/json

Body

application/json

Request Body for the settlement reconciliation

Recon Request Object

Response

200
application/json

OK

Recon object for settlement