Addresses
The address resource is your billing address.
An active address is required in order to use a payment card funding source.
To associate an address with a funding source, use the same user_token or business_token for both resources.
Note
The/users and /businesses resources also have address fields.
Those are used for other purposes, such as KYC identity verification or as shipping addresses for physical cards.
Create address
Copy section link
Action: POST
Endpoint: /fundingsources/addresses
Use this endpoint to create an address resource.
When creating the address, you must pass the token of either an existing user in the user_token field or an existing business in the business_token field.
Do not pass both.
Request body
Copy section link
| Fields | Description |
|---|---|
active
boolean
|
Specifies whether the address is active. Allowable Values:
Default value: |
address_1
string
|
Street address. Allowable Values: 255 char max |
address_2
string
|
Additional address information. Allowable Values: 255 char max |
business_token
string
|
Unique identifier of the business account holder.
This token is required if a Allowable Values: 1–36 chars |
city
string
|
City of the address. Allowable Values: 40 char max |
country
string
|
Country of the address. Allowable Values: 1–40 chars |
first_name
string
|
First name of the account holder. Allowable Values: 40 char max |
is_default_address
boolean
|
A value of Allowable Values:
Default value: |
last_name
string
|
Last name of the account holder. Allowable Values: 40 char max |
phone
string
|
Telephone number of the account holder. Allowable Values: 255 char max |
postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
state
string
|
Two-character state, province, or territorial abbreviation. For a complete list of valid state and province abbreviations, see Valid state, provincial, and territorial abbreviations. Allowable Values: 2 char max |
token
string
|
Unique identifier of the address. If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
user_token
string
|
Unique identifier of the user account holder.
This token is required if a Allowable Values: 1–36 chars |
zip
string
|
United States ZIP code.
This field is required if Allowable Values: 10 char max |
Response body
Copy section link
| Fields | Description |
|---|---|
active
boolean
|
Specifies whether the address is active. This field is returned if it exists in the resource. Allowable Values:
|
address_1
string
|
Street address. Allowable Values: 255 char max |
address_2
string
|
Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max |
business_token
string
|
Unique identifier of the business account holder.
This token is returned if a Allowable Values: 1–36 chars |
city
string
|
City of the address. Allowable Values: 40 char max |
country
string
|
Country of the address. Allowable Values: 1–40 chars |
created_time
datetime
|
Date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
first_name
string
|
First name of the cardholder. Allowable Values: 40 char max |
is_default_address
boolean
|
A value of This field is returned if it exists in the resource. Allowable Values:
|
last_modified_time
datetime
|
Date and time when the resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
last_name
string
|
Last name of the cardholder. Allowable Values: 40 char max |
phone
string
|
Telephone number of the cardholder. This field is returned if it exists in the resource. Allowable Values: 255 char max |
postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
state
string
|
Two-character state, province, or territorial abbreviation. For a complete list, see Valid state, provincial, and territorial abbreviations. Allowable Values: 2 char max |
token
string
|
Unique identifier of the address object. Allowable Values: 1–36 chars |
user_token
string
|
Unique identifier of the Allowable Values: 1–36 chars |
zip
string
|
United States ZIP code of the address.
This field is returned if Allowable Values: 10 char max |
List business addresses
Copy section link
Action: GET
Endpoint: /fundingsources/addresses/business/{business_token}
Use this endpoint to list existing addresses for a business. This endpoint supports field filtering.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
business_token
string
|
Unique identifier of the business account holder. Allowable Values: Existing business resource token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: Comma-delimited list of fields, or blank |
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
data
array of objects
|
Array of address objects. Objects are returned as appropriate to your query. Allowable Values: Valid data array of one or more address objects |
data[].active
boolean
|
Specifies whether the address is active. This field is returned if it exists in the resource. Allowable Values:
|
data[].address_1
string
|
Street address. Allowable Values: 255 char max |
data[].address_2
string
|
Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max |
data[].business_token
string
|
Unique identifier of the business account holder.
This token is returned if a Allowable Values: 1–36 chars |
data[].city
string
|
City of the address. Allowable Values: 40 char max |
data[].country
string
|
Country of the address. Allowable Values: 1–40 chars |
data[].created_time
datetime
|
Date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].first_name
string
|
First name of the cardholder. Allowable Values: 40 char max |
data[].is_default_address
boolean
|
A value of This field is returned if it exists in the resource. Allowable Values:
|
data[].last_modified_time
datetime
|
Date and time when the resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].last_name
string
|
Last name of the cardholder. Allowable Values: 40 char max |
data[].phone
string
|
Telephone number of the cardholder. This field is returned if it exists in the resource. Allowable Values: 255 char max |
data[].postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
data[].state
string
|
Two-character state, province, or territorial abbreviation. For a complete list, see Valid state, provincial, and territorial abbreviations. Allowable Values: 2 char max |
data[].token
string
|
Unique identifier of the address object. Allowable Values: 1–36 chars |
data[].user_token
string
|
Unique identifier of the Allowable Values: 1–36 chars |
data[].zip
string
|
United States ZIP code of the address.
This field is returned if Allowable Values: 10 char max |
end_index
integer
|
Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of This field is returned if there are resources in your returned array. Allowable Values:
|
start_index
integer
|
Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Lists all addresses for a user
Copy section link
Action: GET
Endpoint: /fundingsources/addresses/user/{user_token}
Use this endpoint to list existing addresses for a user. This endpoint supports field filtering.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
user_token
string
|
Unique identifier of the user account holder. Allowable Values: Existing user resource token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: Comma-delimited list of fields, or blank |
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
data
array of objects
|
Array of address objects. Objects are returned as appropriate to your query. Allowable Values: Valid data array of one or more address objects |
data[].active
boolean
|
Specifies whether the address is active. This field is returned if it exists in the resource. Allowable Values:
|
data[].address_1
string
|
Street address. Allowable Values: 255 char max |
data[].address_2
string
|
Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max |
data[].business_token
string
|
Unique identifier of the business account holder.
This token is returned if a Allowable Values: 1–36 chars |
data[].city
string
|
City of the address. Allowable Values: 40 char max |
data[].country
string
|
Country of the address. Allowable Values: 1–40 chars |
data[].created_time
datetime
|
Date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].first_name
string
|
First name of the cardholder. Allowable Values: 40 char max |
data[].is_default_address
boolean
|
A value of This field is returned if it exists in the resource. Allowable Values:
|
data[].last_modified_time
datetime
|
Date and time when the resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].last_name
string
|
Last name of the cardholder. Allowable Values: 40 char max |
data[].phone
string
|
Telephone number of the cardholder. This field is returned if it exists in the resource. Allowable Values: 255 char max |
data[].postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
data[].state
string
|
Two-character state, province, or territorial abbreviation. For a complete list, see Valid state, provincial, and territorial abbreviations. Allowable Values: 2 char max |
data[].token
string
|
Unique identifier of the address object. Allowable Values: 1–36 chars |
data[].user_token
string
|
Unique identifier of the Allowable Values: 1–36 chars |
data[].zip
string
|
United States ZIP code of the address.
This field is returned if Allowable Values: 10 char max |
end_index
integer
|
Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of This field is returned if there are resources in your returned array. Allowable Values:
|
start_index
integer
|
Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Retrieve address
Copy section link
Action: GET
Endpoint: /fundingsources/addresses/{funding_source_address_token}
Use this endpoint to retrieve a funding source address.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
funding_source_address_token
string
|
Unique identifier of the funding source address. Allowable Values: Existing funding source address token |
Response body
Copy section link
| Fields | Description |
|---|---|
active
boolean
|
Specifies whether the address is active. This field is returned if it exists in the resource. Allowable Values:
|
address_1
string
|
Street address. Allowable Values: 255 char max |
address_2
string
|
Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max |
business_token
string
|
Unique identifier of the business account holder.
This token is returned if a Allowable Values: 1–36 chars |
city
string
|
City of the address. Allowable Values: 40 char max |
country
string
|
Country of the address. Allowable Values: 1–40 chars |
created_time
datetime
|
Date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
first_name
string
|
First name of the cardholder. Allowable Values: 40 char max |
is_default_address
boolean
|
A value of This field is returned if it exists in the resource. Allowable Values:
|
last_modified_time
datetime
|
Date and time when the resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
last_name
string
|
Last name of the cardholder. Allowable Values: 40 char max |
phone
string
|
Telephone number of the cardholder. This field is returned if it exists in the resource. Allowable Values: 255 char max |
postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
state
string
|
Two-character state, province, or territorial abbreviation. For a complete list, see Valid state, provincial, and territorial abbreviations. Allowable Values: 2 char max |
token
string
|
Unique identifier of the address object. Allowable Values: 1–36 chars |
user_token
string
|
Unique identifier of the Allowable Values: 1–36 chars |
zip
string
|
United States ZIP code of the address.
This field is returned if Allowable Values: 10 char max |
Updates the account holder address for a funding source
Copy section link
Action: PUT
Endpoint: /fundingsources/addresses/{funding_source_address_token}
Use this endpoint to update an address. Only values of parameters in the request are modified; all others are left unchanged.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
funding_source_address_token
string
|
Unique identifier of the funding source address. Allowable Values: Existing funding source address token |
Request body
Copy section link
| Fields | Description |
|---|---|
active
boolean
|
Specifies whether the address is active. Allowable Values:
Default value: |
address_1
string
|
Street address. Allowable Values: 255 char max |
address_2
string
|
Additional address information. Allowable Values: 255 char max |
city
string
|
City of the address. Allowable Values: 40 char max |
country
string
|
Country of the address. Allowable Values: 40 char max |
first_name
string
|
First name of the account holder. Allowable Values: 40 char max |
is_default_address
boolean
|
A value of Allowable Values:
Default value: |
last_name
string
|
Last name of the account holder. Allowable Values: 40 char max |
phone
string
|
Telephone number of the account holder. Allowable Values: 255 char max |
postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
state
string
|
Two-character state, province, or territorial abbreviation. For a complete list, see Valid state, provincial, and territorial abbreviations. Allowable Values: 2 char max |
zip
string
|
United States ZIP code of the address. Allowable Values: 10 char max |
Response body
Copy section link
| Fields | Description |
|---|---|
active
boolean
|
Specifies whether the address is active. This field is returned if it exists in the resource. Allowable Values:
|
address_1
string
|
Street address. Allowable Values: 255 char max |
address_2
string
|
Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max |
business_token
string
|
Unique identifier of the business account holder.
This token is returned if a Allowable Values: 1–36 chars |
city
string
|
City of the address. Allowable Values: 40 char max |
country
string
|
Country of the address. Allowable Values: 1–40 chars |
created_time
datetime
|
Date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
first_name
string
|
First name of the cardholder. Allowable Values: 40 char max |
is_default_address
boolean
|
A value of This field is returned if it exists in the resource. Allowable Values:
|
last_modified_time
datetime
|
Date and time when the resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
last_name
string
|
Last name of the cardholder. Allowable Values: 40 char max |
phone
string
|
Telephone number of the cardholder. This field is returned if it exists in the resource. Allowable Values: 255 char max |
postal_code
string
|
Postal code of the address. Allowable Values: 10 char max |
state
string
|
Two-character state, province, or territorial abbreviation. For a complete list, see Valid state, provincial, and territorial abbreviations. Allowable Values: 2 char max |
token
string
|
Unique identifier of the address object. Allowable Values: 1–36 chars |
user_token
string
|
Unique identifier of the Allowable Values: 1–36 chars |
zip
string
|
United States ZIP code of the address.
This field is returned if Allowable Values: 10 char max |