---
title: "List 3DS Challenge Methods"
method: POST
path: "/pws/pws_list_challenge_methods_3ds/"
tags: ["Apata"]
---

# List 3DS Challenge Methods

`POST /pws/pws_list_challenge_methods_3ds/`

This web service lists all the challenge methods.   Pass a count, product id and client id  to retrieve the list of challenge methods.

## Request body

- GetChallengeMethodModel — -- This web service retrieves list of challenge methods for 3ds provider APATA. -- Pass a count, product id and client id to retrieve list of challenge methods.
  - `api_call_unique_identifier` string, required — Unique number that must be passed at each API request. Identifier to make each API request unique
  - `client_id` integer, required — Unique identifier for the client which Paymentology will provide at outset
  - `count` integer, required — no. of limit of the list.
  - `prodId` integer, required — product id
  - `user_id` string — User Id of the Customer who triggered the API request.
  - `remarks` string — Remarks for API request
  - `nextToken` string — next token in pagination

## Response `200`

Successful Response

- ListChallengeMethodResponseModel
  - `header` Header
    - `error_desc` string, required — Error Description
    - `error_id` integer, required — Error Id
  - `body` ListChallengeMethodResponse
    - `challengeMethods` ChallengeMethods[], required
      - `challengeInterfaceId` string, required — Unique identifier for the challenge method.
      - `created` string, required
      - `id` string, required — Unique identifier for the challenge method.
      - `name` string, required — Display name for the Challenge Method
      - `properties` Properties, required
        - `delegateSend` boolean, required — If set to true, Apata will make a webhook call to a configured URL to send the OTP via SMS.
        - `delegateVerify` boolean, required — If set to true, Apata will make a webhook call to a configured URL to verify the OTP.
        - `sendFormat` string — Value: "V1" The format that should be sent via webhook.
        - `sendWebhookId` string — The ID of the webhook call that will be made to send the SMS if "delegateSend" is set to true.
        - `delegateFormat` string — Value: "V1" The format that should be sent via webhook.
        - `verifyWebhookId` string — The ID of the webhook call that will be made to verify the OTP if "delegateVerify" is set to true.
        - `cancelWebhookId` string — The ID of the webhook call that will be made in the event that the cardholder cancels the challenge.
        - `cancelWebhookFormat` string — Value: "V1" The format that should be sent via webhook.
      - `type` string, required — Value: "SMS_OTP"
      - `updated` string, required
      - `alias` string — A unique, human-readable reference for a challenge method.
      - `description` string — Optional description for the Challenge Method.
      - `retries` integer — The number of times that a cardholder can perform a retry (e.g. resend SMS/Email etc)
      - `attempts` integer — The number of times that a cardholder can input the wrong value and still continue the process.
      - `authMethodSettings` AuthMethodSettings
        - `defaultValue` string, required — The default auth method to return if no matchers match the input.
        - `matchers` Matchers[]
          - `value` string, required — Auth method to use when other properties match.
          - `scheme` string — Enum: "VISA" "MASTERCARD" Allows the auth method to be override for a particular scheme.
          - `protocolVersion` string — Enum: "1.0.2" "2.1.0" "2.2.0" Allows the auth method to be override for a particular protocol version e.g. 2.1.0
    - `nexttoken` string — Token used for pagination.

## Other responses

- `404` — Webservices does not exist
- `500` — Internal Server error

---

[API](https://skmtc.dev/paymentology/apis/payapi-docs.md) · [All operations](https://skmtc.dev/paymentology/apis/payapi-docs/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/paymentology/payapi-docs/revisions/a675891b0365/schema)