Card Vault API

Know how to integrate Cashfree’s card vault API to avail the saved card feature.
Save Card
You need to first save the customer card on checkout after a successful transaction. Saving the card for customers enables them to complete payments without having to enter the card details repeatedly for every transaction.
....
 name="paymentOption" value="card"/>
 name="card_number" value="4444333322221111"/>
 name="card_holder" value="John Doe"/>
 name="card_expiryMonth" value="09"/>
 name="card_expiryYear" value="2020"/>
 name="card_cvv" value="123"/>
 name="card_save" value="1"/>
Add additional parameter ‘card_save’ and set it to 1 to save the card in seamless pro flow.
Card gets saved against the phone number provided in the above request. To fetch the card token you have to call the getCards API.
Use Saved Card
Use the below form to submit a saved card.
....
 name="paymentOption" value="savedCard"/>
 name="card_id" value="A83091283HDKASHKJDH2132"/>
 name="card_cvv" value="123"/>
Please use the below endpoints to get Saved Cards.
Endpoints
URL
Environment
https://test.cashfree.com/
TEST
https://api.cashfree.com/
PRODUCTION
Cashfree uses API keys to allow access to the API. Once you have signed up at our merchant site, you will be able to retrieve 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 first.
Get Cards Associated with Customer
To display all cards associated with a customer, use the code below:
URL - POST /api/v1/vault/cards/getCards
Request and Response Parameters
Request Parameters
Response Parameters
Request Parameters
Parameter
Required
Description
appId
Yes
Your app id
secretKey
Yes
Your Secret Key
phone
Yes
String Phone number used to identify user
Response Parameters
Parameter
Required
Description
cardId
Yes
Your Card Id
maskedCard
Yes
Masked Card Number
cardScheme
Yes
Card scheme eg .Visa, Mastercard
Sample Request and Response
Request
Curl
PHP
Java
Go
Python
C#
Curl
curl -X POST \
https://test.cashfree.com/api/v1/vault/cards/getCards \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'appId=MTA2OTkyMDE1ODE0NDIyNTExNjYjI&secretKey=63ca0b83c8ca85d73fff9c3fd29a7c87e292fd63&phone=9999123123'
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://test.cashfree.com/api/v1/vault/cards/getCards',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "appId": "MTA2OTkyMDE1ODE0NDIyNTExNjYjI",
    "secretKey": "63ca0b83c8ca85d73fff9c3fd29a7c87e292fd63",
    "phone": "9999123123"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/x-www-form-urlencoded',
    'Cache-Control: no-cache'
  ),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
Java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
      .addFormDataPart("appId", "MTA2OTkyMDE1ODE0NDIyNTExNjYjIz")
      .addFormDataPart("secretKey", "63ca0b83c8ca85d73fff9c3fd29a7c87e292fd63")
      .addFormDataPart("phone", "9999123123")
      .build();
Request request = new Request.Builder()
  .url("https://test.cashfree.com/api/v1/vault/cards/getCards")
  .method("POST", body)
  .addHeader("Content-Type", "application/x-www-form-urlencoded")
  .addHeader("Cache-Control", "no-cache")
  .build();
Response response = client.newCall(request).execute();
Go
package main
import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)
func main() {
  url := "https://test.cashfree.com/api/v1/vault/cards/getCards"
  method := "POST"
​
  payload := strings.NewReader(`{
    "appId": "MTA2OTkyMDE1ODE0NDIyNTExNjYjI",
    "secretKey": "63ca0b83c8ca85d73fff9c3fd29a7c87e292fd63",
    "phone": "9999123123"
}`)
  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)
​
  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
  req.Header.Add("Cache-Control", "no-cache")
​
  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
Python
import http.client
conn = http.client.HTTPSConnection("test.cashfree.com")
payload = "{\n    \"appId\": \"MTA2OTkyMDE1ODE0NDIyNTExNjYjI\",\n    \"secretKey\": \"63ca0b83c8ca85d73fff9c3fd29a7c87e292fd63\",\n    \"phone\": \"9999123123\"\n}"
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Cache-Control': 'no-cache'
}
conn.request("POST", "/api/v1/vault/cards/getCards", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
C#
var client = new RestClient("https://test.cashfree.com/api/v1/vault/cards/getCards");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddHeader("Cache-Control", "no-cache");
request.AddParameter("application/x-www-form-urlencoded", "{\n    \"appId\": \"MTA2OTkyMDE1ODE0NDIyNTExNjYjI\",\n    \"secretKey\": \"63ca0b83c8ca85d73fff9c3fd29a7c87e292fd63\",\n    \"phone\": \"9999123123\"\n}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
Response
Response
Response
[
  {
    "cardId":"63E6E4B4208A11E8B6EFB84A4B991DC5",
    "maskedCard":"411111XXXXXX1132",
    "cardScheme":"visa"
  },
  {
    "cardId":"AC94D8B80D9011E8B6EFB84A4B991DC5",
    "maskedCard":"411111XXXXXX1133",
    "cardScheme":"visa"
  }
]
Delete Card Associated with Customer
To delete a card associated with a customer, use the code below:
URL - POST /api/v1/vault/cards/deleteCard
Request and Response Parameters
Request Parameters
Response Parameters
Request Parameters
Parameter
Required
Description
appId
Yes
Your app id
secretKey
Yes
Your Secret Key
phone
Yes
Phone number used to identify user
cardId
Yes
Your Card Id
Response Parameters
Parameter
Required
Description
status
Yes
API call status, values - OK and ERROR
Sample Request and Response
Request
Curl
PHP
Java
Go
Python
C#
Curl
curl -X POST \
https://test.cashfree.com/api/v1/vault/cards/deleteCard \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d
'appId=MTA2OTkyMDE1ODE0NDIyNTExNjYjI&secretKey=63ca0b83c8ca85d73fff9c3fd29a7c87e292fd63&phone=9999123123&cardId=B3BF498612E611E8A15B0AC95
3478514'
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://test.cashfree.com/api/v1/vault/cards/deleteCard',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "appId": "MTA2OTkyMDE1ODE0NDIyNTExNjYjI",
    "secretKey": "63ca0b83c8ca85d73fff9c3fd29a7c87e292fd63",
    "phone": "9895123649",
    "cardId": "B3BF498612E611E8A15B0AC953478514"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/x-www-form-urlencoded',
    'Cache-Control: no-cache'
  ),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
      .addFormDataPart("appId", "MTA2OTkyMDE1ODE0NDIyNTExNjYjIz")
      .addFormDataPart("secretKey", "63ca0b83c8ca85d73fff9c3fd29a7c87e292fd63")
      .addFormDataPart("phone", "9999123123")
      .addFormDataPart("cardId", "B3BF498612E611E8A15B0AC953478514")
      .build();
Request request = new Request.Builder()
  .url("https://test.cashfree.com/api/v1/vault/cards/deleteCard")
  .method("POST", body)
  .addHeader("Content-Type", "application/x-www-form-urlencoded")
  .addHeader("Cache-Control", "no-cache")
  .build();
Response response = client.newCall(request).execute();
Go
package main
import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)
func main() {
  url := "https://test.cashfree.com/api/v1/vault/cards/deleteCard"
  method := "POST"
  payload := strings.NewReader(`{
    "appId": "MTA2OTkyMDE1ODE0NDIyNTExNjYjI",
    "secretKey": "63ca0b83c8ca85d73fff9c3fd29a7c87e292fd63",
    "phone": "9895123649",
    "cardId": "B3BF498612E611E8A15B0AC953478514"
}`)
  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)
  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
  req.Header.Add("Cache-Control", "no-cache")
  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()
​
  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
Python
import http.client
conn = http.client.HTTPSConnection("test.cashfree.com")
payload = "{\n    \"appId\": \"MTA2OTkyMDE1ODE0NDIyNTExNjYjI\",\n    \"secretKey\": \"63ca0b83c8ca85d73fff9c3fd29a7c87e292fd63\",\n    \"phone\": \"9895123649\",\n    \"cardId\": \"B3BF498612E611E8A15B0AC953478514\"\n}"
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Cache-Control': 'no-cache'
}
conn.request("POST", "/api/v1/vault/cards/deleteCard", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
C#
var client = new RestClient("https://test.cashfree.com/api/v1/vault/cards/deleteCard");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddHeader("Cache-Control", "no-cache");
request.AddParameter("application/x-www-form-urlencoded", "{\n    \"appId\": \"MTA2OTkyMDE1ODE0NDIyNTExNjYjI\",\n    \"secretKey\": \"63ca0b83c8ca85d73fff9c3fd29a7c87e292fd63\",\n    \"phone\": \"9895123649\",\n    \"cardId\": \"B3BF498612E611E8A15B0AC953478514\"\n}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
Response
Reponse
Reponse
{
   “status”:”OK”
   “message”: “Deleted Successfully”
}
Preauth API
UPI API
Last updated 4 days ago
URL	Environment
`https://test.cashfree.com/`	TEST
`https://api.cashfree.com/`	PRODUCTION
Parameter	Required	Description
appId	Yes	Your app id
secretKey	Yes	Your Secret Key
phone	Yes	String Phone number used to identify user