Cashfree Payments Developer Documentation

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.

string

application/json

Body

application/json

Recon object

filters

object

required

pagination

object

required

To fetch the next set of settlements, pass the cursor received in the response to the next API call. To receive the data for the first time, pass the cursor as null. Limit would be number of settlements that you want to receive.

Response

200 - application/json

Settlement detailed recon response

cursor

string

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

data

object[]

data.adjustment

number

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

data.adjustment_remarks

string

Other adjustment remarks.

data.amount_settled

number

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

data.cf_payment_id

string

Cashfree Payments unique ID to identify a payment.

data.cf_settlement_id

string

Unique ID to identify the settlement.

data.charges_currency

string

Cashfree charges currency for a event type

data.closed_in_favor_of

string

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

data.customer_email

string

Customer email.

data.customer_name

string

Customer name.

data.customer_phone

string

Customer phone number.

data.dispute_category

string

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

data.dispute_note

string

Note regarding the dispute.

data.dispute_resolved_on

string

Date and time when the dispute was resolved.

data.entity

string

Recon

data.event_amount

number

Amount of the event. Example, refund amount, dispute amount, payment amount, etc.

data.event_currency

string

Curreny type - INR.

data.event_id

string

Unique ID associated with the event.

data.event_settlement_amount

number

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

data.event_status

string

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

data.event_time

string

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

data.event_type

string

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

data.forex_conversion_handling_charge

number

Cashfree forex conversion charges for processing transaction

data.forex_conversion_handling_tax

number

Cashfree forex conversion tax for processing transaction

data.order_amount

number

The amount which was passed at the order creation time.

data.order_id

string

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

data.payment_amount

number

Payment amount captured.

data.payment_from

string

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

data.payment_service_charge

number

Service charge applicable for the payment.

data.payment_service_tax

number

Service tax applicable on the payment.

data.payment_till

string

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

data.payment_time

string

Date and time when the payment was initiated.

data.payment_utr

string

Unique transaction reference number of the payment.

data.reason

string

Reason for settlement failure.

data.refund_arn

string

The bank reference number for the refund.

data.refund_id

string

An unique ID to associate the refund with.

data.refund_note

string

A refund note for your reference.

data.refund_processed_at

string

Date and time when the refund was processed.

data.remarks

string

Remarks on the settlement.

data.sale_type

string

Indicates if it is CREDIT/DEBIT sale.

data.service_charge

number

Service charge applicable on the settlement amount.

data.service_tax

number

Service tax applicable on the settlement amount.

data.settlement_charge

number

Settlement charges applicable on the settlement.

data.settlement_date

string

Date and time when the settlement was processed.

data.settlement_initiated_on

string

Date and time when the settlement was initiated.

data.settlement_tax

number

Settlement tax applicable on the settlement.

data.settlement_type

string

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

data.settlement_utr

string

Unique transaction reference number of the settlement.

data.split_service_charge

number

Service charge that is applicable for splitting the payment.

data.split_service_tax

number

Service tax applicable for splitting the amount to vendors.

data.vendor_commission

number

Vendor commission applicable for this transaction.

limit

integer

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

Payments API

v2023-08-01

Other Versions

Upcoming Versions

PG Reconciliation

Authorizations

Headers

Body

Response