POST
/
aa
/
consent
{
  "consent_verification_id": "abc12345",
  "consent_ref_id": 67890,
  "consent_redirect_url": "https://example.com/redirect",
  "status": "PENDING",
  "customer_identifiers": [
    {
      "type": "MOBILE",
      "value": "9876543210"
    }
  ],
  "consent_start": "2024-01-01T00:00:00Z",
  "consent_expiry": "2024-12-31T23:59:59Z",
  "fi_from": "2024-01-01T00:00:00Z",
  "fi_to": "2024-12-31T23:59:59Z",
  "redirect_url": "https://example.com/redirect",
  "consent_mode": "STORE",
  "consent_type": [
    "PROFILE",
    "SUMMARY",
    "TRANSACTION"
  ],
  "fi_types": [
    "DEPOSIT"
  ],
  "data_life_expiry": "2024-01-07",
  "filter": [
    {
      "type": "TRANSACTION_AMOUNT",
      "operator": "LESS_THAN",
      "value": "20000"
    }
  ]
}

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 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.

customer_identifiers
object[]
required

It should contain the information related to the individual.

fi_from
string
required

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

fi_to
string
required

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

redirect_url
string
required

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.

data_life_expiry
string

It displays the expiry date of the information fetched.

fi_types
string[]

It displays the type of financial information you require from the individual.

Possible values are - DEPOSIT

filter
object[]

It contains the filter options to sort the finanical information of the individual.

Response

200 - application/json

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.

customer_identifiers
object[]

It should contain the information related to the individual.

data_life_expiry
string

It displays the expiry date of the information fetched.

fi_from
string

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

fi_to
string

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

fi_types
string[]

It displays the type of financial information you require from the individual.

Possible values are - DEPOSIT

filter
object[]

It contains the filter options to sort the finanical information of the individual.

redirect_url
string

It is the URL that you need to provide that takes the individual to after viewing the consent request.

status
string

It displays the status of the consent request. Possible values are

  • PENDING
  • PROCESSING
  • SUCCESS
  • PAUSED
  • EXPIRED
  • REVOKED
  • REJECTED