Address Verification


Address Verification Service is one way to confirm customer identity and remove fraud, while decreasing interchange rates. By providing the customer’s full address, you add another layer of security and consequently fetch more data from the processors, while protecting you from fraud. Our address verification service returns five different statuses to identify the outcome of an AVS request attempt: exact_match, partial_match, no_match, error and unavailable.

  • exact_match is returned whenever the address matches the records. That usually means the address, city, state, country and postal code match;
  • partial_match is returned whenever the processor is able to match parts of the information provided;
  • no_match is returned whenever there aren’t records matching the data provided;
  • error means the processor or issuer systems returned an error with the provided data;
  • unavailable means that AVS is not available for the provided card.

AVS should be done either during a auth or sale event. Besides passing all fields for these event types, you will also need to pass the fields described below.

Parameter Type Length Presence Description Example
avs_enabled number 0-1 Required (for AVS) Flag to enable AVS capabilities (1 for enabled / 0 for not enabled) 1
street_address_1 string 1-255 Required (for AVS) Billing address first line (street address) 59 N Santa Cruz Avenue
street_address_2 string 1-255 Required (for AVS) Billing address second line (suite, apt, etc) Suite M
city string 1-255 Required (for AVS) Billing address city Los Gatos
state string 2 Required (for AVS) Billing address state abbreviation, ISO 3166-2 format. CA
country string 2 Required (for AVS) Billing address country abbreviation, ISO 3166-1 alpha-2 format. US
zip string 2-225 Required (for AVS) Billing address postal code 95030
Parameter Type Length Description Example uuid 36 This transaction’s ID 41f00869-d7b3-413e-9476-9ef1a8bc2f28
transaction.merchant_id uuid 36 The user’s merchant ID 41f00869-d7b3-413e-9476-9ef1a8bc2f28
transaction.user_id uuid 36 The user’s ID 41f00869-d7b3-413e-9476-9ef1a8bc2f28
transaction.processor_id uuid 36 The processor’s ID 41f00869-d7b3-413e-9476-9ef1a8bc2f28
transaction.merchant_transaction_id string 1-255 The merchant assigned identifier my-order-id-0001
transaction.updated_at datetime - Last time this transaction was updated, on ISO 8601 UTC 2018-02-16T16:33:40+00:00
transaction.created_at datetime - Time that transaction was created, on ISO 8601 UTC 2018-02-16T16:33:40+00:00*.id uuid 36 This event’s ID 41f00869-d7b3-413e-9476-9ef1a8bc2f28*.success boolean - If the event was a successful event or not true*.event_type string 4-10 The type of event being performed auth, capture, sale, void, refund*.amount number 0.01-9999999 Total event amount 3.56*.processor_code string 2-10 The processor response code 00*.processor_message string 1-255 A human readable message from the processor APPROVAL V12341*.processor_transaction_id string 1-255 A processor assigned identifier 00000000143242*.updated_at datetime - Last time this event was updated, on ISO 8601 UTC 2018-02-16T16:33:40+00:00*.created_at datetime - Time that event was created, on ISO 8601 UTC 2018-02-16T16:33:40+00:00
curl --request POST \
  --url{transaction_id}/void \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --form 'amount=1.00' \
  --form 'card_number=4111111111111111' \
  --form 'card_expiry_month=01' \
  --form 'card_expiry_year=2021' \
  --form 'card_cvv=999' \
  --form 'first_name=John' \
  --form 'last_name=Doe' \
  --form 'street_address_1=59 N Santa Cruz Avenue' \
  --form 'street_address_2=Suite M' \
  --form 'city=Los Gatos' \
  --form 'state=CA' \
  --form 'country=US' \
  --form 'ip_address=' \
  --form 'dynamic_descripton=MY-DESCRIPTOR' \
  --form 'mobile_phone=+11231231234' \
  --form '[email protected]' \
  --form 'merchant_transaction_id=my-order-id-0001' \
  --form 'zip=95030'
  --form 'avs_enabled=1'

Responds with:

  "transaction": {
    "id": "3410596f-d596-42d4-9811-41d43868e984",
    "merchant_id": "455a1c64-385b-41b2-a56f-34bf6c5c5335",
    "user_id": "6e064bf5-0e18-466b-811b-f967e8d73b9f",
    "processor_id": "30ff7682-6ec7-48f3-8d7a-62319a9c3c59",
    "merchant_transaction_id": "my-order-id-0001",
    "card_number": "411111******1111",
    "card_brand": "visa",
    "card_expiry_month": "01",
    "card_expiry_year": "2021",
    "first_name": "John",
    "last_name": "Doe",
    "street_address_1": "59 N Santa Cruz Avenue",
    "street_address_2": "Suite M",
    "city": "Los Gatos",
    "state": "CA",
    "country": "US",
    "zip": "95030",
    "email": "[email protected]",
    "mobile_phone": "+11231231234",
    "updated_at": "2018-02-16T16:33:40+00:00",
    "created_at": "2018-02-16T16:33:39+00:00",
    "events": [
            "id": "84a8ab86-ee0e-47d4-8686-4e42fa58355e",
            "success": true,
            "threeds_response": null,
            "avs_response": "exact_match",
            "event_type": "auth",
            "amount": "1.00",
            "ip_address": "",
            "processor_code": "00",
            "processor_message": "EXACT MATCH  ",
            "processor_transaction_id": "000000000252616",
            "processor_threeds_response": null,
            "processor_avs_response": "Z",
            "updated_at": "2018-02-16T16:33:40+00:00",
            "created_at": "2018-02-16T16:33:39+00:00"