Authentication - GET Eligibility Check

Retrieve eligibility check data for an existing Authentication.

Endpoint

GET /authentication/{authentication_id}/eligibility-check

cURL

cURL

curl --request GET \
  --url https://sandbox.hyperswitch.io/authentication/{authentication_id}/eligibility-check \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{}'

Authorization

Header: api-key (string, required)

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Do not expose this key on a website or embed it in a mobile application.

Request

Content-Type: application/json Body: object (the endpoint does not require any specific fields)

Response

200 — application/json Retrieved eligibility check data for the Authentication.

Example:

Response (200)

{
  "eligibility_check_data": {
    "click_to_pay_enrollment_status": {
      "visa": true,
      "mastercard": true
    }
  }
}

Related

• Authentication - POST Eligibility Check: https://api-reference.hyperswitch.io/v1/authentication/authentication--post-eligibility-check

• Payouts - Create: https://api-reference.hyperswitch.io/v1/payouts/payouts--create

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/authentication/authentication--get-eligibility-check.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/authentication/authentication--get-eligibility-check