Reconciliation

The Settlement and PG reconciliation APIs make reconciliation faster and simpler. You can get details about all types of settlements within minutes for a selected date range. A single API provides information about transactions, adjustments/refunds against transactions, settlement dates, settlement amounts, disputes, and more.

Settlement Reconciliation API

The Settlement Reconciliation API https://api.cashfree.com/pg/settlement/recon, fetches all individual events associated with settlements for a date range specified, a list of settlement IDs, or a list of settlement UTRs specified. In the response, you will see all events like Payments, Refunds, Refund Reversals, Disputes, Dispute Reversals, Chargebacks, and other adjustment details associated with the settlement. Since this API fetches all events associated with settlements at a time, it makes reconciliation faster and much simpler for you.

Detailed Response Parameters

Parameter

Description

cursor (string)

Specifies from where the next set of settlement details should be fetched.

limit (integer)

Number of settlements you want to fetch in the next iteration.

event_id (string)

Unique ID associated with the event.

event_type (string)

The event type can be PAYMENT, REFUND, REFUND_REVERSAL, DISPUTE, DISPUTE_REVERSAL, CHARGEBACK, CHARGEBACK_REVERSAL, OTHER_ADJUSTMENT.

event_settlement_amount (number)

Amount that is part of the settlement corresponding to the event.

event_amount (number)

Amount corresponding to the event. Example, refund amount, dispute amount, payment amount, etc.

sale_type (string)

Indicates if it is CREDIT/DEBIT sale.

event_status (string)

Status of the event. Example - SUCCESS, FAILED, PENDING, CANCELLED.

entity (string)

Recon

event_time (string)

Time associated with the event. Example, transaction time, dispute initiation time

event_currency (string)

Curreny type - INR.

order_id (string)

Unique order ID. Alphanumeric and only '-' and '_' allowed.

order_amount (number)

The amount which was passed at the order creation time.

customer_phone (string)

Customer phone number.

customer_email (string)

Customer email.

customer_name (string)

Customer name.

payment_amount (number)

Payment amount captured.

payment_utr (string)

Unique transaction reference number of the payment.

payment_time (string)

Date and time when the payment was initiated.

payment_service_charge (number)

Service charge applicable for the payment.

payment_service_tax (number)

Service tax applicable on the payment.

cf_payment_id (integer)

Cashfree Payments unique ID to identify a payment.

cf_settlement_id (integer)

Unique ID to identify the settlement.

settlement_date (string)

Date and time when the settlement was processed.

settlement_utr (string)

Unique transaction reference number of the settlement.

split_service_charge (number)

Service charge that is applicable for splitting the payment.

split_service_tax (number)

Service tax applicable for splitting the amount to vendors.

vendor_commission (number)

Vendor commission applicable for this transaction.

closed_in_favor_of (string)

Specifies whether the dispute was closed in favor of the merchant or customer. Possible values - Merchant, Customer.

dispute_resolved_on (string)

Date and time when the dispute was resolved.

dispute_category (string)

Category of the dispute - Dispute code and the reason for dispute is shown.

dispute_note (string)

Note regarding the dispute.

refund_processed_at (string)

Date and time when the refund was processed.

refund_arn (string)

The bank reference number for refund.

refund_note (string)

A refund note for your reference.

refund_id (string)

An unique ID associated with the refund.

adjustment_remarks (string)

Other adjustment remarks.


PG Reconciliation API

The PG Reconciliation API https://api.cashfree.com/pg/recon, fetches all individual events associated with your Payment Gateway account for a date range specified. In the response, you will see all events like Settlements, Payments, Refunds, Refund Reversals, Disputes, Dispute Reversals, Chargebacks, and other adjustment details and the associated details.

Detailed Response Parameters

Parameter

Description

cursor (string)

Specifies from where the next set of settlement details should be fetched.

limit (integer)

Number of settlements you want to fetch in the next iteration.

event_id (string)

Unique ID associated with the event.

event_type (string)

The event type can be SETTLEMENT, PAYMENT, REFUND, REFUND_REVERSAL, DISPUTE, DISPUTE_REVERSAL, CHARGEBACK, CHARGEBACK_REVERSAL, OTHER_ADJUSTMENT.

event_settlement_amount (number)

The amount that is part of the settlement corresponding to the event.

event_amount (number)

Amount corresponding to the event. Example, refund amount, dispute amount, payment amount, etc.

sale_type (string)

Indicates if it is CREDIT/DEBIT sale.

event_status (string)

Status of the event. Example - SUCCESS, FAILED, PENDING, CANCELLED.

entity (string)

Recon

event_time (string)

Time associated with the event. Example, transaction time, dispute initiation time

event_currency (string)

Curreny type - INR.

order_id (string)

Unique order ID. Alphanumeric and only '-' and '_' allowed.

order_amount (number)

The amount which was passed at the order creation time.

customer_phone (string)

Customer phone number.

customer_email (string)

Customer email.

customer_name (string)

Customer name.

payment_amount (number)

Payment amount captured.

payment_utr (string)

Unique transaction reference number of the payment.

payment_time (string)

Date and time when the payment was initiated.

payment_service_charge (number)

Service charge applicable for the payment.

payment_service_tax (number)

Service tax applicable on the payment.

cf_payment_id (integer)

Cashfree Payments unique ID to identify a payment.

cf_settlement_id (integer)

Unique ID to identify the settlement.

settlement_date (string)

Date and time when the settlement was processed.

settlement_utr (string)

Unique transaction reference number of the settlement.

split_service_charge (number)

Service charge that is applicable for splitting the payment.

split_service_tax (number)

Service tax applicable for splitting the amount to vendors.

vendor_commission (number)

Vendor commission applicable for this transaction.

closed_in_favor_of (string)

Specifies whether the dispute was closed in favor of the merchant or customer. Possible values - Merchant, Customer.

dispute_resolved_on (string)

Date and time when the dispute was resolved.

dispute_category (string)

Category of the dispute - Dispute code and the reason for dispute is shown.

dispute_note (string)

Note regarding the dispute.

refund_processed_at (string)

Date and time when the refund was processed.

refund_arn (string)

The bank reference number for refund.

refund_note (string)

A refund note for your reference.

refund_id (string)

An unique ID associated with the refund.

adjustment_remarks (string)

Other adjustment remarks.

adjustment (number)

Amount that is adjusted from the settlement amount because of any credit/debit event such as refund, refund_reverse etc.

service_tax (number)

Service tax applicable on the settlement amount.

service_charge (number)

Service charge applicable on the settlement amount.

amount_settled (number)

Net amount that is settled after considering the adjustments, settlement charge and tax.

payment_from (string)

The start time of the time range of the payments considered for the settlement.

payment_till (string)

The end time of time range of the payments considered for the settlement.

reason (string)

Reason for settlement failure.

settlement_initiated_on (string)

Date and time when the settlement was initiated.

settlement_type (string)

Type of settlement. Possible values - Standard, Instant, On demand.

settlement_charge (number)

Settlement charges applicable on the settlement.

settlement_tax (number)

Settlement tax applicable on the settlement.

remarks (string)

Remarks on the settlement.