Skip to main content
PUT
/
merchants
/
{id}
/
avsMode
Update Merchant AVS Mode
curl --request PUT \
  --url https://api.example.com/merchants/{id}/avsMode \
  --header 'Content-Type: application/json' \
  --data '
{
  "data.type": "<string>",
  "data.attributes.group": "<string>",
  "data.attributes.AVS": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.digitzs.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

PUT https://api.digitzs.com/merchants/{id}

​
Overview

Use this endpoint to update the AVS (Address Verification System) verification mode for a merchant account. AVS helps prevent fraudulent card transactions by verifying the cardholder’s billing address.

​
Authentication

HeaderValueRequired
x-api-keyYour API keyYes
AuthorizationBearer {appToken}Yes
appIdYour application IDYes
Content-Typeapplication/jsonYes

​
Path Parameters

​
id
string
required
The merchant account ID

​
Request Body

​
data.type
string
required
Must be "merchants"
​
data.attributes.group
string
required
Must be "AVS"
​
data.attributes.AVS
string
required
AVS mode to set:
  • "Standard" - Requires ZIP code match
  • "Strict" - Requires full address match
  • "Disabled" - No AVS verification

​
Example Request

{
  "data": {
    "type": "merchants",
    "attributes": {
      "group": "AVS",
      "AVS": "Strict"
    }
  }
}

​
Response

​
Success Response (200 OK)

{
  "links": {
    "self": "https://api.digitzs.com/merchants/merchant_abc123"
  },
  "data": {
    "type": "merchants",
    "id": "merchant_abc123",
    "attributes": {
      "AVS": "Strict",
      "updatedAt": "2024-01-20T16:00:00Z"
    }
  }
}

​
Code Examples

curl -X PUT https://api.digitzs.com/merchants/merchant_abc123 \
  -H "x-api-key: your-api-key" \
  -H "Authorization: Bearer your-app-token" \
  -H "appId: your-app-id" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "type": "merchants",
      "attributes": {
        "group": "AVS",
        "AVS": "Strict"
      }
    }
  }'

​
AVS Mode Comparison

ModeVerification LevelFraud ProtectionCustomer FrictionBest For
DisabledNoneLowNoneLow-risk businesses, high trust environments
StandardZIP code matchMediumLowMost businesses, balanced approach
StrictFull address matchHighMediumHigh-risk categories, maximum security

​
Understanding AVS

Requirements: ZIP/postal code must match billing address on file with card issuerPros:
  • Good fraud prevention
  • Minimal customer friction
  • Industry standard
Cons:
  • Won’t catch address fraud if ZIP is correct
Recommended for: General e-commerce, most businesses
Requirements: Street address AND ZIP code must matchPros:
  • Maximum fraud prevention
  • Comprehensive address verification
  • Protects high-value transactions
Cons:
  • Higher false decline rate
  • More customer friction
  • Legitimate typos cause failures
Recommended for: High-value items, high-risk industries, luxury goods
Requirements: No address verificationPros:
  • No customer friction
  • Faster checkout
  • No legitimate decline from AVS
Cons:
  • Minimal fraud protection
  • Higher chargeback risk
  • May violate compliance requirements
Recommended for: Known customers, trusted environments, low-risk scenarios

​
Important Notes

Fraud Risk: Disabling AVS increases fraud risk. Only disable if you have alternative fraud prevention measures in place.
Immediate Effect: AVS mode changes apply immediately to all new transactions. In-flight transactions use the mode active at the time they were initiated.
Balance Security and Conversion: Standard mode provides good security while minimizing false declines. Start with Standard and adjust based on fraud patterns.

​
Best Practices

  1. Monitor Fraud Rates: Track chargeback rates after AVS changes
  2. Consider Your Industry: High-risk industries should use Strict mode
  3. Test Changes: Test AVS impact on legitimate transactions before switching modes
  4. Customer Communication: Inform customers about address verification requirements
  5. Gradual Changes: When increasing strictness, monitor conversion rates closely

​
When to Use Each Mode

Use Standard when:
  • Running general e-commerce
  • Balancing security and conversion
  • Processing medium-value transactions
Use Strict when:
  • Selling high-value items ($500+)
  • Operating in high-fraud industries
  • Experiencing elevated chargeback rates
  • Regulatory requirements demand it
Use Disabled when:
  • Processing known/trusted customers
  • Running internal testing
  • Accepting only low-value transactions
  • Having comprehensive alternative fraud tools

​
Next Steps

Get Merchant Details

Verify updated AVS settings

Create Payment

Process payments with your AVS configuration