Token Vault

Store your card credentials with Cashfree in a secure manner.

With Token Vault, you can securely generate and store card tokens as part of the card-saving process. This enables them to retrieve and display saved card tokens to customers, allowing for convenient, quick transactions using stored cards. We generate network tokens which are interoperable, meaning that tokens saved with us can be used to process payments with any compatible payment provider.

Seamless Guide to save a card for a customer

Create order with customer id

To begin you need to send the customer information to cashfree as part of the create order api. You do this by sending customer_id parameter in the (create order api request)[/api/payments/latest/orders/create].

Here’s a sample request for creating an order using your desired backend language. Cashfree offers backend SDKs to simplify the integration process.

You can find the SDKs here.

javascript

import { Cashfree, CFEnvironment } from "cashfree-pg";

const cashfree = new Cashfree(
	CFEnvironment.PRODUCTION,
	"{Client ID}",
	"{Client Secret Key}"
);

function createOrder() {
	var request = {
		order_amount: "1",
		order_currency: "INR",
		customer_details: {
			customer_id: "node_sdk_test",
			customer_name: "",
			customer_email: "[e-mail]",
			customer_phone: "9999999999",
		},
		order_meta: {
			return_url:
				"https://test.cashfree.com/pgappsdemos/return.php?order_id=order_123",
		},
		order_note: "",
	};

	cashfree
		.PGCreateOrder(request)
		.then((response) => {
			var a = response.data;
			console.log(a);
		})
		.catch((error) => {
			console.error("Error setting up order request:", error.response.data);
		});
}

After successfully creating an order, you will receive a unique order_id and payment_session_id that you need for subsequent steps.

You can view all the complete api request and response for /orders here.

Render UI to the customer

In this step, you need to display the checkout interface to the customer. The UI should include a checkbox, allowing the customer to consent to card storage for future use.

Send card details to Cashfree

In the make payment api, you need to set save_instrument to true after obtaining the customer’s consent. Once consent is received, Cashfree will initiate a token generation request with the card networks. Cashfree will first process the payment, completing the 2FA (two-factor authentication) step before sending the token generation request. If 2FA is not successfully completed—meaning the payment fails—Cashfree will not send the token provisioning request to the card networks, and the card will not be tokenized.

javascript

const orderPayRequest = {
	payment_session_id:
		"session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC",
	payment_method: {
		card: {
			channel: "link",
			card_holder_name: "Test",
			card_number: "4111111111111111",
			card_expiry_mm: "12",
			card_expiry_yy: "30",
			card_cvv: "123",
		},
	},
	save_instrument: true,
};
cashfree
	.PGPayOrder(orderPayRequest)
	.then((response) => {
		console.log("Transaction Initiated successfully:", response.data);
	})
	.catch((error) => {
		console.error("Error creating transaction:", error);
	});

If the payment is successful the card will be tokenized and stored in Cashfree’s vault

Next learn how to use an exsting stored card for a customer.

Guide to get and use a saved Card

Get Saved Cards

You first need to get the saved cards for a customer using the customer_id. You can then display these cards to the customer.

Get all cards for a customer

curl --location --request GET 'https://sandbox.cashfree.com/pg/customers/customer001/instruments?instrument_type=card' \
--header 'Content-Type: application/json' \
--header 'X-client-id: <CLIENT_ID>' \
--header 'X-client-secret: <SECRET_KEY>' \
--header 'x-api-version: <<x-api-version>'

Payment for a saved card

Once you have the instrument_uid, you can pass that in the order pay api to intiate payment for a specific card.

Payment for saved card request

curl --location --request POST 'https://sandbox.cashfree.com/pg/orders/sessions' \
--header 'Content-Type: application/json' \
--header 'x-api-version: 2021-05-21' \
--data-raw '{
   "payment_session_id": "session_7NvteR73Fh11P3f3bNdcubIAJgBJJgGK9diC6U5jvr_jfWBS8o-Z2iPf20diqBMVfWDwvARGrISZRCPoDSWjw4Eb1GrKtoZZQT_BWyXW25fD",
   "payment_method": {
      "card": {
         "channel": "link",
         "instrument_id": "b43a75c1-bfda-4781-85a1-67915a19fcb6",
         "card_cvv": "900"
      }
   }
}
'