Request Consent
Use this API to request consent from the individual to fetch the financial information.
Authorizations
Client ID. You can find your ID in the Merchant Dashboard.
Client secret key. You can find your secret key in the Merchant Dashboard.
Body
Find the request body parameters to request consent for AA.
It is the expiry date and time of the consent request.
It is the unique ID you create to identify the consent request. The maximum character limit is 50. Only alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.
It should contain the information related to the individual.
It is the starting date and time of the financial information you require.
It is the ending date and time of the financial information you require.
It is the URL that you need to provide that takes the individual to after viewing the consent request.
It is the type of configuration for handling the financial information of the individual. Possible values are
VIEW
: It indicates that the information is for viewing purpose.STORE
: It indicates that the information is for storing purpose.QUERY
: It indicates that the information is for querying purposes, including performing searches, filtering results, or making data-driven decisions.STREAM
: It indicates that the information is for streaming purposes.
It is the start date and time of the consent validity for the individual's financial information.
It displays the type of information you require from the individual.
Possible values are
- PROFILE
: It contains the basic information of the individual.
- SUMMARY
: It contains the summary of the financial information of the individual.
- TRANSACTIONS
: It contains the transactional information of the individual.
It displays the expiry date of the information fetched.
It displays the type of financial information you require from the individual.
Possible values are
- DEPOSIT
It contains the filter options to sort the finanical information of the individual.
Response
It is the expiry date and time of the consent request.
It is the type of configuration for handling the financial information of the individual. Possible values are
VIEW
: It indicates that the information is for viewing purpose.STORE
: It indicates that the information is for storing purpose.QUERY
: It indicates that the information is for querying purposes, including performing searches, filtering results, or making data-driven decisions.STREAM
: It indicates that the information is for streaming purposes.
It displays the URL that redirects the individual to the consent request page.
It displays the unique ID created by Cashfree Payments for reference purpose.
It is the start date and time of the consent validity for the individual's financial information.
It displays the type of information you require from the individual.
Possible values are
- PROFILE
: It contains the basic information of the individual.
- SUMMARY
: It contains the summary of the financial information of the individual.
- TRANSACTIONS
: It contains the transactional information of the individual.
It displays the unique ID you created to identify the consent request.
It should contain the information related to the individual.
It displays the expiry date of the information fetched.
It is the starting date and time of the financial information you require.
It is the ending date and time of the financial information you require.
It displays the type of financial information you require from the individual.
Possible values are
- DEPOSIT
It contains the filter options to sort the finanical information of the individual.
It is the URL that you need to provide that takes the individual to after viewing the consent request.
It displays the status of the consent request. Possible values are
PENDING
PROCESSING
SUCCESS
PAUSED
EXPIRED
REVOKED
REJECTED
Was this page helpful?