Skip to main content
POST
/
payout
/
v1
/
authorize
Authorize
curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1/authorize \
  --header 'X-Client-Id: <x-client-id>' \
  --header 'X-Client-Secret: <x-client-secret>'
{
  "status": "SUCCESS",
  "message": "Token is valid",
  "subCode": "200"
}

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.

URLs
If you do not have a static IP, you can generate a public key and pass it with the API request. To generate a public key,
  1. Go Payouts Dashboard > Developers section on the left-side navigation > Payouts > Two-Factor Authentication > Public Key.
  2. Click Generate Public Key. The public key will be downloaded to your computer and the password to access it will be your email ID registered with Cashfree Payments. Only one Public Key can be generated at a time.
Below are the steps to generate your signature:
  1. Retrieve your clientId (one which you are passing through the header X-Client-Id )
  2. Append this with CURRENT UNIX timestamp separated by a period (.)
  3. Encrypt this data using RSA encrypt with Public key you received - this is the signature.
  4. Pass this signature through the header X-Cf-Signature. In the case of using our library, go through the libraries section. During the initialization process, you need to pass the key as a parameter.
<?php
public static function getSignature() {
    $clientId = "<your clientId here>";
    $publicKey =
openssl_pkey_get_public(file_get_contents("/path/to/certificate/public
_key.pem"));
    $encodedData = $clientId.".".strtotime("now");
    return static::encrypt_RSA($encodedData, $publicKey);
}
private static function encrypt_RSA($plainData, $publicKey) { if (openssl_public_encrypt($plainData, $encrypted, $publicKey,
OPENSSL_PKCS1_OAEP_PADDING))
    $encryptedData = base64_encode($encrypted);
    else return NULL;
    return $encryptedData;
}
?>

Headers

​
X-Cf-Signature
string

Signature to be sent if IP is not whitelisted.

​
X-Client-Secret
string
required

Client Secret key

​
X-Client-Id
string
required

Client ID

Response

200

​
status
string
Example:

"SUCCESS"

​
message
string
Example:

"Token is valid"

​
subCode
string
Example:

"200"