Getting Started

• View End Points
• Generate API Keys
• Whitelist IP Address
• 2FA API Signature Generation
• Any Queries: Contact Us

​

View End Points

Cashfree Payments uses API keys to allow access to the API. Once you have signed up at our merchant site, you will be able to see your AppId and SecretKey.

Cashfree expects API key to be included in all API requests to the server. Use the endpoint /api/v1/credentials/verify to verify your credentials.

​

Generate API Keys

Follow the instructions below to generate API keys:

1. From the Secure ID dashboard, click Developers on the navigation panel.
2. Click API Keys.
3. Click Generate API Keys from the API Keys screen.
   

   Generate API Keys
4. The New API Keys popup displays with the client ID and client secret information.
5. Click Download API Keys to download the information and save them in your local system folder. Do not share the keys with anyone because they are confidential. You can generate a maximum of 10 API keys.

​

Whitelist Your IP Address

Whitelisting the IP address or generating a public key provides a layer of authentication. These cybersecurity techniques prevent anonymous or unknown disbursement requests and allow only verified requests. Your IP address needs to be whitelisted in the Cashfree Payments production server or it rejects all incoming requests.

Follow the instructions below to whitelist your IP:

1. From the Secure ID dashboard, click Developers from the navigation pane > Two-Factor Authentication from the Secure ID card.
2. Choose IP Whitelist from the Select 2FA Method drop-down.
3. Click Add IP Address.
4. Enter the IP address you want to whitelist in the respective field and click Add IP Address to save the details. Note that the IPv4 has to be whitelisted, and not IPv6. The whitelisted IPs are displayed in the grid as shown below. You can whitelist a maximum of 10 IPs.

​

2FA API Signature Generation

To generate a signature, you need to generate the public key. You then use the generated public key to generate the signature.

​

Generate Public Key

1. From the Secure ID dashboard, click Developers from the navigation pane > Two-Factor Authentication from the Secure ID card.
2. Select Public Key from the Select 2FA Method drop-down.
3. Click Generate Public Key.
4. The public key is downloaded to your computer. Use your registered email ID to access the key.

​

Generate Signature

Follow the steps below 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;
  }
?>

​

Any Queries: Contact Us

For identifying, diagnosing, and resolving problems related to API requests, ensure the information below is communicated while contacting us:

• Share the API request and response details along with referenceId or verificationId.
• Mention the registered email ID and environment in the email.
• Use your registered email address (with Cashfree Payments) to send the email or mention the registered email address.
• Include your account manager in the CC of the email request.