Memento Payments
Search…
Addresses

The address object

Attribute
Type
Description
title
string
Address name.
street_address
string
Street address (line 1).
sub_street_address
string
Street address (line 2).
locality
string
E.g. city / town / locality.
sub_locality
string
Area name.
administrative_area
string
E.g. state.
sub_administrative_area
string
E.g. county.
postal_code
string
Postal code / zip.
country
string
Two letter ISO 3166-1 alpha-2 country code representing the country the contact is located in.
is_primary
boolean
Whether or not this is the user's primary address.
verified
boolean
Whether or not this address has been verified.

Example

{
"title": "Calista Wise",
"street_address": "7292 Dictum Av.",
"locality": "San Antonio",
"administrative_area": "MI",
"postal_code": "47096",
"country": "US",
"is_primary": true,
"verified": true,
}

Get a list of addresses

Get a list of all of the user's addresses.
Request
Response
GET /v1/addresses
200 OK
Returns a list of address objects.

Get an address

Get a single address object.
Request
Response
GET /v1/addresses/{id}
200 OK
Returns an address object.

Create an address

Create a new address for a user.
Request
Response
POST /v1/addresses
Attribute
Type
Description
title
string
Address name.
street_address
string
Street address (line 1).
sub_street_address
string
Street address (line 2).
locality
string
E.g. city / town / locality.
sub_locality
string
Area name.
administrative_area
string
E.g. state.
sub_administrative_area
string
E.g. county.
postal_code
string
Postal code / zip.
country
string
Two letter ISO 3166-1 alpha-2 country code representing the country the contact is located in.
is_primary
boolean
Whether or not this is the user's primary address.
201 Created
Returns an address object.

Update an address

Updates an existing address.
Request
Response
PATCH /v1/addresses/{id}
Attribute
Type
Description
title
string
Address name.
street_address
string
Street address (line 1).
sub_street_address
string
Street address (line 2).
locality
string
E.g. city / town / locality.
sub_locality
string
Area name.
administrative_area
string
E.g. state.
sub_administrative_area
string
E.g. county.
postal_code
string
Postal code / zip.
country
string
Two letter ISO 3166-1 alpha-2 country code representing the country the contact is located in.
is_primary
boolean
Whether or not this is the user's primary address.
200 OK
Returns the updated address object.

Delete an address

Deletes an existing address.
Request
Response
DELETE /v1/addresses/{id}
200 OK