Skip to main content
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"
}'
{
  "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

​
x-client-id
string
header
required

Client ID. You can find your ID in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Body

application/json

Find the request parameters to request FI for AA.

​
fi_verification_id
string
required

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:

""

​
consent_verification_id
string
required

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

Example:

""

​
fi_from
string<date-time>
required

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

Example:

"2023-01-01T00:00:00Z"

​
fi_to
string<date-time>
required

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

Example:

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

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[]