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

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"
}
'

200

Example

{
  "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

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.

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

200

application/json

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

Show child attributes