Cashfree Payments Developer Documentation home page

Create Account
Help Center
Discord
Create Account

Import Settlement APIs

Get Import Settlement recon details

Payments

Payouts

Secure ID

Partners and Platforms

Cross Border Imports

Overview
Webhooks
Import Verification APIs
Import Settlement APIs

Global Collections

Overview
End Points
Purpose Codes
Merchant APIs and Webhook
Partner APIs and Webhook

BBPS

Overview
APIs to Implement
Next Steps for Biller
GET
Check Transaction Status
NPCI Onboarding Configurations

One Escrow

Overview
POST
Create Virtual Account
POST
Transfer Funds Between VAs
GET
Get Account Statement
POST
Allocate Funds to Virtual Account
Fund Source

Import Settlement APIs

Get Import Settlement recon details

This API is used to fetch all events happened for provided Settlement IDs

POST

import

settlements

recon

x-client-id

string

x-client-id

Required

string

client id generated from the merchant dashboard

x-client-secret

string

x-client-secret

Required

string

client secret generated from the merchant dashboard

x-api-version

string

x-api-version

string

API version to be used. Format is in YYYY-MM-DD

start_date

string

start_date

Required

string

Start date for fetching settlement recon details

end_date

string

end_date

Required

string

End date for fetching settlement recon details

object

filter

object

filter

Required

object

start_date

string

start_date

string

Start date for fetching settlement recon details

end_date

string

end_date

string

End date for fetching settlement recon details

cf_ica_settlement_ids

array

cf_ica_settlement_ids

array

List of ICA Settlement IDs for fetching related recon events

settlement_utrs

array

settlement_utrs

array

List of ICA Settlement UTRs for fetching corresponding recon events

pagination

object

pagination

Required

object

limit

integer

limit

integer

Limit on number of entries to fetch

cursor

string

cursor

string

Cursor from which entries to be fetched

Headers

x-client-id

string

required

client id generated from the merchant dashboard

x-client-secret

string

required

client secret generated from the merchant dashboard

x-api-version

string

default: 2024-08-01

API version to be used. Format is in YYYY-MM-DD

Query Parameters

start_date

string

default: 2024-08-13required

Start date for fetching settlement recon details

end_date

string

default: 2024-08-15required

End date for fetching settlement recon details

Body

application/json

filter

object

required

filter.start_date

string

Start date for fetching settlement recon details

filter.end_date

string

End date for fetching settlement recon details

filter.cf_ica_settlement_ids

integer[]

List of ICA Settlement IDs for fetching related recon events

filter.settlement_utrs

string[]

List of ICA Settlement UTRs for fetching corresponding recon events

pagination

object

required

pagination.limit

integer

Limit on number of entries to fetch

pagination.cursor

string

Cursor from which entries to be fetched

Response

200 - application/json

cursor

any

limit

integer

default: 0

data

object[]

data.event_id

string

data.entity

string

data.event_type

string

data.sale_type

string

data.event_time

string

data.event_settlement_amount

any

data.event_amount

integer

default: 0

data.event_status

string

data.event_currency

string

data.order_id

string

data.customer_name

string

data.customer_phone

string

data.customer_email

string

data.cf_payment_id

any

data.payment_amount

any

data.order_amount

integer

default: 0

data.payment_time

any

data.payment_service_charge

any

data.payment_service_tax

any

data.payment_utr

string

data.cf_ica_settlement_id

any

data.vendor_commission

any

data.split_service_charge

any

data.split_service_tax

any

data.settlement_utr

any

data.refund_note

any

data.refund_id

any

data.refund_arn

any

data.refund_processed_at

any

data.closed_in_favor_of

any

data.resolved_on

any

data.dispute_category

any

data.dispute_note

any

data.dispute_resolved_on

any

data.adjustment_remarks

any

data.adjustment

any

data.service_tax

any

data.service_charge

any

data.amount_settled

any

data.payment_from

any

data.payment_till

any

data.reason

any

data.settlement_initiated_on

any

data.settlement_settled_on

any

data.settlement_type

any

data.settlement_charge

any

data.settlement_tax

any

data.payment_group

string

data.remarks

any

Was this page helpful?

Get Import Settlement details Overview

github youtube website