Skip to main content

 

Affirm Merchant Help

Contact object

The Contact object includes the shipping object, which is is required, and the billing object, which is optionalBoth objects have the same format. It also includes the Address and Name objects.


"shipping":{
        "name":{
          "first":"John",
          "last":"Doe"
          // You can include the full name instead
          // "full" : "John Doe"
        },
        "address":{
          "line1":"325 Pacific Ave",
          "city":"San Francisco",
          "state":"CA",
          "zipcode":"94112",
          "country":"USA"
        }
      }

 "billing":{
        "name":{
          "first":"John",
          "last":"Doe"
          // You can include the full name instead
          // "full" : "John Doe"
        },
        "address":{
          "line1":"325 Pacific Ave",
          "city":"San Francisco",
          "state":"CA",
          "zipcode":"94112",
          "country":"USA"
        }
      }
(object key name)

required string.

Either 'shipping' or 'billing'. Only the 'shipping' object is required, 'billing' object is optional.

name

required object.

First and last, or full name. Used to pre-populate the account sign-up form.

address

required object.

Address information. Validated against public address service APIs.


"address":{
   "line1":"633 Folsom St",
   "city":"San Francisco",
   "state":"CA",
   "zipcode":"94107",
   "country":"USA"
}
line 1

required string.

Valid U.S. street address, verified by public address service APIs.

line 2

optional string.

Apartment, suite, floor, etc.

city

required string.

City name, verified by public address service APIs.

state

required string.

2-letter ISO code or full name, verified by public address service APIs.

zipcode

required string.

Must match other provided address information, verified by public address service APIs.

country

optional string.

If provided, must be 'US' or 'USA' (3-letter ISO code). Affirm is only available to U.S. residents.


"name":{
   "first": "John",
   "last": "Doe",
   "full": "John Doe"
}
first

required string.

Can contain multiple words (for middle names).

last

required string.

 

full

optional string.

Required if 'first' and 'last' keys are missing. String must contain at two words.

  • Was this article helpful?