AVS Settings

Get AVS Settings

get

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

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

application/jsonapplication/xml

payload

payloadTypestringOptional

Indicates the type of payload returned in the response.

Example: hpp

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

get

/rest/v2/settings/terminal/avs

HTTPcURLJavaScriptPython

GET /rest/v2/settings/terminal/avs HTTP/1.1
api-key: text
Accept: */*

{
  "avs-settings": {
    "enabled": true,
    "response-filters": {
      "response-filter": [
        {
          "name": "avs",
          "allowed": true,
          "description": "No: Address and ZIP Do Not Match",
          "response-code": "N"
        }
      ]
    }
  },
  "payloadType": "hpp"
}

Update AVS Settings

put

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

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

AVS Settings details.

enabledboolean · enumOptional

Indicates whether AVS (Address Verification Service) settings are enabled (true) or disabled (false).

Example: truePossible values:

Responses

200

ok

application/jsonapplication/xml

payload

payloadTypestringOptional

Indicates the type of payload returned in the response.

Example: hpp

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

put

/rest/v2/settings/terminal/avs

HTTPcURLJavaScriptPython

PUT /rest/v2/settings/terminal/avs HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 156

{
  "enabled": true,
  "response-filters": {
    "response-filter": [
      {
        "name": "avs",
        "allowed": true,
        "description": "No: Address and ZIP Do Not Match",
        "response-code": "N"
      }
    ]
  }
}

{
  "avs-settings": {
    "enabled": true,
    "response-filters": {
      "response-filter": [
        {
          "name": "avs",
          "allowed": true,
          "description": "No: Address and ZIP Do Not Match",
          "response-code": "N"
        }
      ]
    }
  },
  "payloadType": "hpp"
}