This request uses AVS to verify a card's address.
Click here to learn more about this request
The Secure Payments API supports Address Verification System (AVS) requests. Note the following when using this request:
AVS is used by financial institutions as security measure against card fraud. This system verifies that a provided address matches the address on file at the issuing bank. Some payment processors may require AVS, while others may not.
To send an AVS request, you first need to have the AVS Address Verify event activated in Secure Payments.
This service incurs a cost per use, but no costs are incurred for activating the event.
The payload of this request can be formatted in two ways: one that includes the full card information, and one that includes only the card token. See our payload samples below for an example of each.
AVS requests return a code that corresponds to a a verification result. Here's a list of the possible AVS codes:
| AVS Code | Description |
|---|---|
A | Address matches, zipcode does not |
B | Address matches, zipcode is not verified |
C | Neither address or zipcode is verified |
D | Address and zipcode match |
F | Address and zipcode match |
G | Address is not verified |
I | Address is not verified |
M | Address and zipcode match |
N | Neither address or zipcode matches |
P | Zipcode matches, address is not verified |
Q | AVS not available |
R | System unavailable, retry |
S | AVS not supported |
T | Zipcode matches, address does not |
U | No address available to match |
W | Zipcode matches, address does not |
X | Address and zipcode match |
Y | Address and zipcode match |
Z | Zipcode matches, address does not |
{
"cardholder_name": "John Doe",
"card_number": "4111111111111111",
"expiration_date": "02/28",
"address": "900 South 1100 East",
"city": "SALT LAKE CITY",
"state": "UT",
"country": "usa",
"zipcode": "84105"
}
{
"token": "QVFJREFIZ0..."
}
Results
Returns a match and address data after a successfully verifying a credit card address. An error results in a message indicating the type of error (e.g. an address mismatch or invalid card number).