Request Financial Information
curl --request POST \
--url https://sandbox.cashfree.com/verification/aa/fi \
--header 'Content-Type: application/json' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"fi_verification_id": "Fi_12345",
"consent_verification_id": "abc12345",
"fi_from": "2023-01-01T00:00:00Z",
"fi_to": "2023-12-31T23:59:59Z"
}
'import requests
url = "https://sandbox.cashfree.com/verification/aa/fi"
payload = {
"fi_verification_id": "Fi_12345",
"consent_verification_id": "abc12345",
"fi_from": "2023-01-01T00:00:00Z",
"fi_to": "2023-12-31T23:59:59Z"
}
headers = {
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
fi_verification_id: 'Fi_12345',
consent_verification_id: 'abc12345',
fi_from: '2023-01-01T00:00:00Z',
fi_to: '2023-12-31T23:59:59Z'
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fi_verification_id' => 'Fi_12345',
'consent_verification_id' => 'abc12345',
'fi_from' => '2023-01-01T00:00:00Z',
'fi_to' => '2023-12-31T23:59:59Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.cashfree.com/verification/aa/fi"
payload := strings.NewReader("{\n \"fi_verification_id\": \"Fi_12345\",\n \"consent_verification_id\": \"abc12345\",\n \"fi_from\": \"2023-01-01T00:00:00Z\",\n \"fi_to\": \"2023-12-31T23:59:59Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/verification/aa/fi")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fi_verification_id\": \"Fi_12345\",\n \"consent_verification_id\": \"abc12345\",\n \"fi_from\": \"2023-01-01T00:00:00Z\",\n \"fi_to\": \"2023-12-31T23:59:59Z\"\n}")
.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::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fi_verification_id\": \"Fi_12345\",\n \"consent_verification_id\": \"abc12345\",\n \"fi_from\": \"2023-01-01T00:00:00Z\",\n \"fi_to\": \"2023-12-31T23:59:59Z\"\n}"
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": "PENDING",
"fi_data": []
}Request Financial Information
Use this API to initiate a secure request for a userās financial information after obtaining valid consent by passing the consent ID and required data scopes. The request triggers a data-collection workflow and returns a request ID. Financial data is delivered via webhook or secure report once available.
POST
/
aa
/
fi
Request Financial Information
curl --request POST \
--url https://sandbox.cashfree.com/verification/aa/fi \
--header 'Content-Type: application/json' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"fi_verification_id": "Fi_12345",
"consent_verification_id": "abc12345",
"fi_from": "2023-01-01T00:00:00Z",
"fi_to": "2023-12-31T23:59:59Z"
}
'import requests
url = "https://sandbox.cashfree.com/verification/aa/fi"
payload = {
"fi_verification_id": "Fi_12345",
"consent_verification_id": "abc12345",
"fi_from": "2023-01-01T00:00:00Z",
"fi_to": "2023-12-31T23:59:59Z"
}
headers = {
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
fi_verification_id: 'Fi_12345',
consent_verification_id: 'abc12345',
fi_from: '2023-01-01T00:00:00Z',
fi_to: '2023-12-31T23:59:59Z'
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fi_verification_id' => 'Fi_12345',
'consent_verification_id' => 'abc12345',
'fi_from' => '2023-01-01T00:00:00Z',
'fi_to' => '2023-12-31T23:59:59Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.cashfree.com/verification/aa/fi"
payload := strings.NewReader("{\n \"fi_verification_id\": \"Fi_12345\",\n \"consent_verification_id\": \"abc12345\",\n \"fi_from\": \"2023-01-01T00:00:00Z\",\n \"fi_to\": \"2023-12-31T23:59:59Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/verification/aa/fi")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fi_verification_id\": \"Fi_12345\",\n \"consent_verification_id\": \"abc12345\",\n \"fi_from\": \"2023-01-01T00:00:00Z\",\n \"fi_to\": \"2023-12-31T23:59:59Z\"\n}")
.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::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fi_verification_id\": \"Fi_12345\",\n \"consent_verification_id\": \"abc12345\",\n \"fi_from\": \"2023-01-01T00:00:00Z\",\n \"fi_to\": \"2023-12-31T23:59:59Z\"\n}"
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": "PENDING",
"fi_data": []
}Authorizations
Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.
The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.
Body
application/json
Find the request parameters to request FI for AA.
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:
""
It is the unique ID you created in the Request Consent API to identify the consent request.
Example:
""
It is the beginning date and time of the financial information you require.
Example:
"2023-01-01T00:00:00Z"
It is the ending date and time of the financial information you require.
Example:
"2023-12-31T23:59:59Z"
Response
Consent created successfully.
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"
It is the unique ID you created in the Request Consent API to identify the consent request.
Example:
"def456"
It displays the unique ID created by Cashfree Payments for reference purpose.
Example:
123456
It displays the status of the financial information request. Possible values are
- `SUCCESS`
- `ACTIVE`
- `FAILED`
- `EXPIRED`
- `PENDING`
Example:
"ACTIVE"
It is the beginning date and time of the financial information you require.
Example:
"2024-01-01T00:00:00Z"
It is the ending date and time of the financial information you require.
Example:
"2024-12-31T23:59:59Z"
Show child attributes
Show child attributes
Was this page helpful?
āI