Cashfree Payments Settlements API
Collection of APIs to handle settlements.
Cashfree Payments Settlements API is one of 23 APIs that Cashfree Payments publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Settlements. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 1 operation across 1 path, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 2025-01-01.
Requests are made against 2 base URLs: https://sandbox.cashfree.com/pg, https://api.cashfree.com/pg.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 5
Cashfree Payments Settlements API declares
5 security schemes
for authenticating requests.
An API key is passed in the header as x-client-id (XClientID).
An API key is passed in the header as x-client-secret (XClientSecret).
An API key is passed in the header as x-client-signature (XClientSignatureHeader).
An API key is passed in the header as x-partner-apikey (XPartnerAPIKey).
An API key is passed in the header as x-partner-merchantid (XPartnerMerchantID).
XClientID— Client app ID. You can find your app id in the [merchant dashboard](https://merchant.cashfree.com/merchants/pg/developers/api-keys?env=prod").XClientSecret— Client secret key. You can find your secret in the [merchant dashboard](https://merchant.cashfree.com/merchants/pg/developers/api-keys?env=prod").XClientSignatureHeader— Use this if you do not want to pass the secret key and instead want to use the signature.XPartnerAPIKey— If you are partner and you are making an api call on behalf of a merchantXPartnerMerchantID— If you are partner use this to specify the merchant id if you don't have the merchant client app id
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Collection of APIs to handle settlements.
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SettlementEntity (18 properties), ApiError502 (4 properties), BadRequestError (4 properties), ApiError (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cashfree Payments 12
Other APIs Cashfree Payments publishes across the network.