GET////
Use this endpoint to list existing addresses for a user. This endpoint supports field filtering.
URL path parameters
| Fields | Description |
|---|---|
| user_token string Required | Unique identifier of the user account holder. Allowable Values: Existing user resource token |
URL query parameters
| Fields | Description |
|---|---|
| fields string Optional | Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.Allowable Values: Comma-delimited list of fields, or blank |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | 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 Conditionally returned | 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 Conditionally returned | Specifies whether the address is active. This field is returned if it exists in the resource. Allowable Values: true, false |
| data[].address_1 string Returned | Street name and number of the address. Allowable Values: 255 char max |
| data[].address_2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| data[].business_token string Conditionally returned | Unique identifier of the business account holder. This token is returned if a user_token is not specified.Allowable Values: 1–36 chars |
| data[].city string Returned | City of the address. Allowable Values: 40 char max |
| data[].country string Returned | Country of the address. Allowable Values: 1–40 chars |
| data[].created_time datetime Returned | Date and time when the resource was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].first_name string Returned | First or given name of the cardholder. Allowable Values: 40 char max |
| data[].is_default_address boolean Conditionally returned | A value of true specifies that this address is the default address used by the account holder’s funding source. If this is the account holder’s only address, it is used as the default regardless of this field’s setting.This field is returned if it exists in the resource. Allowable Values: true, false |
| data[].last_modified_time datetime Returned | Date and time when the resource was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].last_name string Returned | Last name or family name of the cardholder. Allowable Values: 40 char max |
| data[].phone string Conditionally returned | Telephone number of the cardholder. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| data[].postal_code string Returned | Postal code of the address. Allowable Values: 10 char max |
| data[].state string Returned | Two-character state, provincial, or territorial abbreviation. For the complete list, see Valid state, provincial, territorial, and federal abbreviations. Allowable Values: 2 char max |
| data[].token string Returned | Unique identifier of the address object. Allowable Values: 1–36 chars |
| data[].user_token string Conditionally returned | Unique identifier of the user account holder. This token is returned if a business_token is not specified.Allowable Values: 1–36 chars |
| data[].zip string Returned | United States ZIP code of the address. This field is returned if postal_code is not specified.Allowable Values: 10 char max |
| end_index integer Conditionally returned | 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 Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| start_index integer Conditionally returned | 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 |
Sample response body
JSON
{
"count": 2,
"start_index": 0,
"end_index": 1,
"is_more": false,
"data": [
{
"business_token": "my_user_01",
"token": "my_funding_source_address_user_01",
"first_name": "Jane",
"last_name": "Doe",
"address_1": "1234 Grove Street",
"city": "Berkeley",
"state": "CA",
"postal_code": "94705",
"zip": "94705",
"country": "USA",
"phone": "5104444444",
"is_default_address": true,
"active": true,
"created_time": "2023-02-27T21:34:42Z",
"last_modified_time": "2023-02-28T18:55:59Z"
},
{
"business_token": "my_user_01",
"token": "my_funding_source_address_user_02",
"first_name": "Jane",
"last_name": "Doe",
"address_1": "5678 Grove Street",
"city": "Berkeley",
"state": "CA",
"postal_code": "94705",
"zip": "94705",
"country": "USA",
"phone": "5104444444",
"is_default_address": false,
"active": true,
"created_time": "2023-02-25T19:48:30Z",
"last_modified_time": "2023-03-25T19:48:30Z"
}
]
}