AddressVerificationResult

The result of verifying the address fields provided in the request.

All fields are required because we want an explicit result for each field rather than relying on the absence of a field as an implied result.

JSON representation
{

  // Union field address_verification_result_type can be only one of the
  // following:
  "notSent": {
    object (AddressVerificationNotSent)
  },
  "sentUnsupported": {
    object (AddressVerificationSentUnsupported)
  },
  "result": {
    object (AddressVerificationSentResult)
  }
  // End of list of possible types for union field
  // address_verification_result_type.
}
Fields

Union field address_verification_result_type.

address_verification_result_type can be only one of the following:

notSent

object (AddressVerificationNotSent)

Google did not send addressVerificationData so nothing could be done.

sentUnsupported

object (AddressVerificationSentUnsupported)

Google sent addressVerificationData but AVS is unsupported.

result

object (AddressVerificationSentResult)

Google sent addressVerificationData and this is the result.

AddressVerificationNotSent

JSON representation
{
  "support": enum (NotSentAvsSupport)
}
Fields
support

enum (NotSentAvsSupport)

REQUIRED: If addressVerificationData had been sent, the following support would have been available.

NotSentAvsSupport

Enums
NOT_SENT_AVS_SUPPORT_UNSPECIFIED Do not ever set this default value!
UNSUPPORTED_BY_INTEGRATOR If addressVerificationData had been sent, the integrator would not have been able to support it.
UNSUPPORTED_BY_NETWORK If addressVerificationData had been sent, the network would not have been able to support it.
UNSUPPORTED_BY_ISSUER If addressVerificationData had been sent, the issuer would not have been able to support it.
SUPPORTED If addressVerificationData had been sent, the integrator would have been able to support it.

AddressVerificationSentUnsupported

JSON representation
{
  "reason": enum (AvsNotSupportedReason)
}
Fields
reason

enum (AvsNotSupportedReason)

REQUIRED: The addressVerificationData was sent but Address Verification could not be performed for the following reason.

AvsNotSupportedReason

Enums
AVS_NOT_SUPPORTED_REASON_UNSPECIFIED Do not ever set this default value!
UNSUPPORTED_BY_INTEGRATOR The integrator could not support Address Verification for this request.
UNSUPPORTED_BY_NETWORK The network could not support Address Verification for this request.
UNSUPPORTED_BY_ISSUER The issuer could not support Address Verification for this request.

AddressVerificationSentResult

JSON representation
{
  "rawAvsResult": string,
  "addressLine": enum (VerificationResult),
  "localityName": enum (VerificationResult),
  "administrativeAreaName": enum (VerificationResult),
  "postalCodeNumber": enum (VerificationResult),
  "countryCode": enum (VerificationResult),
  "nameOnCard": enum (VerificationResult)
}
Fields
rawAvsResult

string

REQUIRED: The raw AVS value returned from the card network.

If addressVerificationData was not set in the request, omit this field.

addressLine

enum (VerificationResult)

REQUIRED: The result of verifying the streetAddress sent in the addressVerificationSystemData field of the request.

localityName

enum (VerificationResult)

REQUIRED: The result of verifying the localityName sent in the addressVerificationSystemData field of the request.

administrativeAreaName

enum (VerificationResult)

REQUIRED: The result of verifying the administrativeAreaName sent in the addressVerificationSystemData field of the request.

postalCodeNumber

enum (VerificationResult)

REQUIRED: The result of verifying the postalCodeNumber sent in the addressVerificationSystemData field of the request.

countryCode

enum (VerificationResult)

REQUIRED: The result of verifying the countryCode sent in the addressVerificationSystemData field of the request.

nameOnCard

enum (VerificationResult)

REQUIRED: The result of verifying the nameOnCard sent in the card field of this request.

VerificationResult

Enums
VERIFICATION_RESULT_UNSPECIFIED Do not ever set this default value!
MATCH Google sent the field to the integrator and it was checked via AVS and it matched the expected value.
MISMATCH Google sent the field to the integrator and it was checked via AVS but did not match the expected value.
NOT_SPECIFIED Google sent the field to the integrator and the integrator checked the field via AVS, but the AVS result code does not provide enough info for the integrator to know if the field matched the expected the value.
SKIPPED_BY_NETWORK Google sent the field to the integrator but the Network did not return an AVS result (due to timeout etc.).
SKIPPED_BY_ISSUER Google sent the field to the integrator but the issuer did not perform AVS (due to timeout etc.).