Skip to main content
POST
Vendor Reconciliation API
Vendor Recon API usageWhen you use the Vendor Recon API, follow these guidelines:
  • Don’t call the API with a failed settlement_id. If a settlement has failed and the amount remains unsettled, the API returns no data.
  • If the amount is later settled under a new (successful) settlement_id, the API returns data for the successful settlement instead.
  • To retrieve records older than six months, include a date range in your request. Searches using settlement_id return data from the last six months only.

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 key in the Merchant Dashboard.

Headers

x-api-version
string
default:2026-01-01
required

API version to be used.

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<UUID>

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.

Content-Type
string

application/json.

Body

application/json

Vendor Recon Request body.

Vendor Recon Request body.

pagination
object
required

The merchant can set pagination limits based on their use case. The minimum limit is 10. Pagination will fetch a set of records, and the next set of records can be generated using the cursor provided in response to the first request for all reconciliation APIs.

filters
object
required

Specify the filters for the desired use case.

Response

Terminal created.

Fetch Vendor Recon details success response.

cursor
string
data
object[]
limit
integer