Skip to main content
GET
/
aa
/
fi
Fetch Financial Information
curl --request GET \
  --url https://sandbox.cashfree.com/verification/aa/fi \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
import requests

url = "https://sandbox.cashfree.com/verification/aa/fi"

headers = {
    "x-client-id": "<api-key>",
    "x-client-secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
  method: 'GET',
  headers: {'x-client-id': '<api-key>', 'x-client-secret': '<api-key>'}
};

fetch('https://sandbox.cashfree.com/verification/aa/fi', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.cashfree.com/verification/aa/fi",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-client-id: <api-key>",
    "x-client-secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.cashfree.com/verification/aa/fi"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-client-secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://sandbox.cashfree.com/verification/aa/fi")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/verification/aa/fi")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'

response = http.request(request)
puts response.read_body
{ "fi_verification_id": "Fi_12345", "consent_verification_id": "abc12345", "fi_ref_id": 12462, "fi_from": "2023-01-01T00:00:00Z", "fi_to": "2023-12-31T23:59:59Z", "status": "ACTIVE", "fi_data": [ { "fip_id": "FIP_1", "accounts": [ { "link_ref_number": "b2328fa7-0dcd-2314-asb5-9ef7b4c1cz6b", "masked_acc_number": "XXXXXX4363", "status": "DELIVERED", "data": { "account": { "type": "DEPOSIT", "profile": { "holders": { "type": "SINGLE", "holder": { "address": "729, 2nd main 2nd Cross, 8th Block, Kormangala, Bangalore - 560095", "ckyc_compliance": "true", "dob": "1960-08-15", "email": "dummymail@mail.com", "landline": "", "mobile": "9876543219", "name": "Vinay Kumar", "nominee": "REGISTERED", "pan": "DUMPY0000A" } } }, "summary": { "current_balance": "666.33", "currency": "INR", "branch": "Kormangala 8th Block", "balance_date_time": "2020-06-22T07:50:00+00:00", "current_od_limit": "0", "drawing_limit": "0", "exchange_rate": " ", "facility": "OD", "ifsc_code": "ICIC0004444", "micr_code": "5898240246", "opening_date": "2002-07-06", "status": "ACTIVE", "type": "SAVINGS", "pending": { "transaction_type": "DEBIT", "amount": "0" } }, "transactions": { "start_date": "2022-04-01", "end_date": "2022-08-30", "transaction": [ { "amount": "129", "current_balance": "567.25", "mode": "UPI", "narration": "UPI/9876543219/getsimpl/simpl@axisbank/Axis Bank", "reference": "RFN00076583", "transaction_timestamp": "2021-04-01T13:20:14+05:30", "txn_id": "M3256752", "type": "DEBIT", "value_date": "2022-04-01" } ] } } } } ] }, { "fip_id": "FIP_2", "accounts": [ { "link_ref_number": "b2329f47-0dcd-2314-asb5-9ef7b4c1cz6b", "masked_acc_number": "XXXXXX4372", "status": "PENDING", "data": null } ] } ] }

Authorizations

ā€‹
x-client-id
string
header
required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

ā€‹
x-client-secret
string
header
required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

ā€‹
x-cf-signature
string

Send the signature if two-factor authentication is selected as Public Key. More details.

Query Parameters

ā€‹
fi_ref_id
string
default:1358

It is the unique ID created by Cashfree Payments that you receive in the response of Consent Request API.

ā€‹
fi_verification_id
string
default:ABC00123

It is the unique ID you created to identify the verification request.

Response

Consent created successfully.

ā€‹
fi_verification_id
string

It is the unique ID you create to identify the financial information request. The maximum character limit is 50. Only alphaumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

Example:

"abc123"

ā€‹
consent_verification_id
string

It is the unique ID you created in the Request Consent API to identify the consent request.

Example:

"def456"

ā€‹
fi_ref_id
number

It displays the unique ID created by Cashfree Payments for reference purpose.

Example:

123456

ā€‹
status
string

It displays the status of the financial information request. Possible values are

- `SUCCESS`
- `ACTIVE`
- `FAILED`
- `EXPIRED`
- `PENDING`
Example:

"ACTIVE"

ā€‹
fi_from
string<date-time>

It is the beginning date and time of the financial information you require.

Example:

"2024-01-01T00:00:00Z"

ā€‹
fi_to
string<date-time>

It is the ending date and time of the financial information you require.

Example:

"2024-12-31T23:59:59Z"

ā€‹
fi_data
object[]