Skip to main content
POST
/
aa
/
consent
Request Consent
curl --request POST \
  --url https://sandbox.cashfree.com/verification/aa/consent \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "consent_verification_id": "abc12345",
  "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"
    }
  ],
  "fetch_type": "ONETIME"
}'
{
  "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

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 consent for AA.

ā€‹
consent_verification_id
string
required

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.

Example:

""

ā€‹
customer_identifiers
object[]
required

It should contain the information related to the individual.

ā€‹
consent_expiry
string<date-time>
required

It is the expiry date and time of the consent request.

Example:

"dateTime"

ā€‹
fi_from
string<date-time>
required

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

Example:

"dateTime"

ā€‹
fi_to
string<date-time>
required

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

Example:

"dateTime"

ā€‹
redirect_url
string
required

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

Example:

"string"

ā€‹
consent_mode
string

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

"STORE"

ā€‹
consent_type
string[]

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.

ā€‹
fi_types
string[]

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

Possible values are - DEPOSIT

ā€‹
consent_start
string<date-time>

It is the start date and time of the consent validity for the individual's financial information.

Example:

"dateTime"

ā€‹
data_life_expiry
string<date>

It displays the expiry date of the information fetched.

Example:

"date"

ā€‹
filter
object[]

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

Response

Consent created successfully

ā€‹
consent_verification_id
string

It displays the unique ID you created to identify the consent request.

Example:

""

ā€‹
consent_ref_id
number

It displays the unique ID created by Cashfree Payments for reference purpose.

Example:

10

ā€‹
consent_redirect_url
string

It displays the URL that redirects the individual to the consent request page.

Example:

"string"

ā€‹
status
string

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

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

"SUCCESS"

ā€‹
customer_identifiers
object[]

It should contain the information related to the individual.

ā€‹
consent_expiry
string<date-time>

It is the expiry date and time of the consent request.

Example:

"dateTime"

ā€‹
fi_from
string<date-time>

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

Example:

"dateTime"

ā€‹
fi_to
string<date-time>

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

Example:

"dateTime"

ā€‹
redirect_url
string

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

Example:

"string"

ā€‹
consent_mode
string

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

"STORE"

ā€‹
consent_type
string[]

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.

ā€‹
fi_types
string[]

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

Possible values are - DEPOSIT

ā€‹
consent_start
string<date-time>

It is the start date and time of the consent validity for the individual's financial information.

Example:

"dateTime"

ā€‹
data_life_expiry
string<date>

It displays the expiry date of the information fetched.

Example:

"date"

ā€‹
filter
object[]

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