Skip to main content
POST
/
payout
/
v1.2
/
validatePayout
Validate Payout V1.2
curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1.2/validatePayout \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "transferId": "JUNOB2018142",
  "vpa": "success@upi",
  "phone": "9999999999"
}
'
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "vpa details retrieved successfully",
  "data": {
    "transferToken": "91328624-74e1-4f27-85cc-0c4166827cf7",
    "vpa": "success@upi",
    "accountStatus": "VALID",
    "nameAtBank": "JOHN SNOW"
  }
}

Documentation Index

Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

Authorization
string
required

Bearer token returned by the Authorize API (POST /payout/v1/authorize).

Example:

"Bearer eyJhbGciOiJIUzM4NCIsInR5cCI6IkpXVCJ9..."

Content-Type
string
required

MIME type of the request or response content.

Example:

"application/json"

X-Request-Id
string

Optional. Identifier for request tracing between your systems and Cashfree Support.

Body

application/json

Identifies this validation attempt and the beneficiary to resolve on UPI. Send transferId plus exactly one of vpa or phone.

transferId
string
required

Merchant-defined identifier for this payout attempt. Use only letters, numbers, hyphens, and underscores. Maximum 40 characters.

Example:

"JUNOB2018142"

vpa
string

Virtual Payment Address (VPA) on UPI to validate. In the request body, pass the value for exactly one of vpa or phone, not both.

Example:

"success@upi"

phone
string

Phone number used to resolve the beneficiary VPA on UPI. In the request body, pass the value for exactly one of phone or vpa, not both.

Example:

"9999999999"

Response

200 - application/json

Always returns HTTP 200. Use status, subCode, and message to see whether validation succeeded. When status is SUCCESS, data includes the transfer token and beneficiary-facing VPA fields.

Cashfree status envelope. When status is SUCCESS, data carries the single-use token and the validated VPA payload.

status
enum<string>

Top-level outcome of the validation request (SUCCESS or ERROR).

Available options:
SUCCESS,
ERROR
subCode
string

200 on success, 400 or 422 on error.

message
string
data
object

Present on SUCCESS responses only.