Skip to main content
POST
/
authentication
/
{authentication_id}
/
eligibility-check
Authentication - POST Eligibility Check
curl --request POST \
  --url https://sandbox.hyperswitch.io/authentication/{authentication_id}/eligibility-check \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "client_secret": "<string>",
  "eligibility_check_data": {
    "click_to_pay": {
      "visa": {
        "consumerPresent": true,
        "consumerStatus": "<string>",
        "customData": {
          "color_depth": 1,
          "java_enabled": true,
          "java_script_enabled": true,
          "language": "<string>",
          "screen_height": 1,
          "screen_width": 1,
          "time_zone": 123,
          "ip_address": "<string>",
          "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
          "user_agent": "<string>",
          "os_type": "<string>",
          "os_version": "<string>",
          "device_model": "<string>",
          "accept_language": "<string>",
          "referer": "<string>"
        }
      },
      "mastercard": {
        "consumerPresent": true,
        "idLookupSessionId": "<string>",
        "lastUsedCardTimestamp": "<string>"
      }
    }
  }
}'
{
  "authentication_id": "auth_mbabizu24mvu3mela5njyhpit4",
  "sdk_next_action": "await_merchant_callback"
}

Authorizations

​
api-key
string
header
required

Publishable keys are a type of keys that can be public and have limited scope of usage.

Body

application/json
​
eligibility_check_data
object
required
​
client_secret
string | null

Optional secret value used to identify and authorize the client making the request. This can help ensure that the payment session is secure and valid.

Response

Eligibility Performed for the Authentication

​
authentication_id
string
required

The unique identifier for this authentication.

Example:

"auth_mbabizu24mvu3mela5njyhpit4"

​
sdk_next_action
required

The next action is to await for a merchant callback

Available options:
await_merchant_callback