Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cashfree Payments Transfers v2 API

The Transfers v2 API from Cashfree Payments — 2 operation(s) for transfers v2.

Cashfree Payments Transfers v2 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 Transfers v2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 4 operations across 2 paths, and defines 6 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.

4 operations 2 paths 6 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2025-01-01
Base URL
https://api.cashfree.com
Authentication
API Key, API Key, API Key, API Key, API Key
License
Resource Areas
1

Authentication & Security 5

Cashfree Payments Transfers v2 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 merchant
  • XPartnerMerchantID — If you are partner use this to specify the merchant id if you don't have the merchant client app id

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Transfers v2 4
POST
/transfers
Standard Transfer V2
PayoutInitiateTransfer 2 params body → 200400403404500
GET
/transfers
Get Transfer Status V2
PayoutFetchTransfer 4 params → 200403404500
POST
/transfers/batch
Batch Transfer V2
PayoutInitiateBatchTransfer 2 params body → 200400409500
GET
/transfers/batch
Get Batch Transfer Status V2
PayoutFetchBatchTransfer 4 params → 200404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CreateTransferResponse (12 properties), CreateTransferRequest (7 properties), FetchBatchTransferResponse (4 properties), ErrorV2 (3 properties). Each schema is shown below with its type and property counts.

CreateBatchTransferResponse
object
Batch Transfer V2 Response
3 properties
CreateTransferResponse
object
Standard Transfer V2 Response
12 properties
FetchBatchTransferResponse
object
Batch Transfer Status V2 Response
4 properties
ErrorV2
object
Error Response for non-2XX cases
3 properties
CreateBatchTransferRequest
object
Batch Transfer V2
2 properties 1 required
CreateTransferRequest
object
Standard Transfer V2
7 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cashfree-transfers-v2-api-openapi.yml Raw ↑

Other APIs Cashfree Payments publishes across the network.

Cashfree Subscriptions API
Cashfree Platforms API
Cashfree Payments Authorize API
Cashfree Payments Beneficiary v2 API
Cashfree Payments CreateCashgram API
Cashfree Payments Deactivate Static KYC Link API
Cashfree Payments DeactivateCashgram API
Cashfree Payments Disputes API
Cashfree Payments Easy-Split API
Cashfree Payments Eligibility API
Cashfree Payments Generate KYC Link API
Cashfree Payments Generate Static KYC Link API