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 Name Match API

Operation related to Name Match verification.

Cashfree Payments Name Match 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 Name Match. 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 3 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.

1 operations 1 paths 3 schemas 1 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 Name Match 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Name Match 1

Operation related to Name Match verification.

POST
/name-match
Verify Name Match
VrsNameMatchVerification 1 param body → 200400401403409422429500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are NameMatchResponseSchema (7 properties), ErrorResponseSchema (4 properties), NameMatchRequestSchema (3 properties). Each schema is shown below with its type and property counts.

NameMatchResponseSchema
object
Success response for Name Match API
7 properties
ErrorResponseSchema
object
Response in case of error.
4 properties
NameMatchRequestSchema
object
Find the request parameters for the Name Match API
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cashfree-name-match-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