---
title: "Get AVS terminal settings"
method: GET
path: "/rest/v2/settings/terminal/avs"
tags: ["AVS Settings"]
---

# Get AVS terminal settings

`GET /rest/v2/settings/terminal/avs`

## Request

- The document declares no server URL.
- Auth: none declared. Required headers: `api-key`
- TypeScript: <https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/docs/rest/v2/settings/terminal/avs/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve the Address Verification Service (AVS) settings configured for a terminal.

## Headers

- `api-key` string, required

## Response `200`

ok

- AvsSettingsPayload: payload
  - `avs-settings` AvsSettings: AVS Settings details.
    - `enabled` true | false: Indicates whether AVS (Address Verification Service) settings are enabled (true) or disabled (false).
    - `response-filters` ResponseFilters: Container for AVS response filter configurations.
      - `response-filter` ResponseFilterDto[]: List of response filter rules. Each Object defines behavior for a specific response code.
        - `name` 'AVS' | 'CSC': Name of the filter type.
        - `allowed` boolean: Specifies whether transactions with this response code are allowed.
        - `description` string: Description of the response code.
        - `response-code` string: Response code to match. For example, "N" for no match.
  - `payloadType` string: Indicates the type of payload returned in the response.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow.md) - [All operations](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/llms.txt) - [OpenAPI document](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/revisions/f37077c24b66?raw)