PUT///
Use this endpoint to update an address.
URL path parameters
| Fields | Description |
|---|---|
| funding_source_address_token string Required | Unique identifier of the funding source address. Allowable Values: Existing funding source address token |
Request body
| Fields | Description |
|---|---|
| active boolean Optional | Specifies whether the address is active. Allowable Values: true, falseDefault value: false |
| address_1 string Optional | Street name and number of the address. Allowable Values: 255 char max |
| address_2 string Optional | Additional address information. Allowable Values: 255 char max |
| city string Optional | City of the address. Allowable Values: 40 char max |
| country string Optional | Country of the address. Allowable Values: 40 char max |
| first_name string Optional | First name or given name of the account holder. Allowable Values: 40 char max |
| is_default_address boolean Optional | 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.Allowable Values: true, falseDefault value: false |
| last_name string Optional | Last name or family name of the account holder. Allowable Values: 40 char max |
| phone string Optional | Telephone number of the account holder. Allowable Values: 255 char max |
| postal_code string Optional | Postal code of the address. Allowable Values: 10 char max |
| state string Optional | Two-character state, provincial, or territorial abbreviation. For the complete list, see Valid state, provincial, territorial, and federal abbreviations. Allowable Values: 2 char max |
| zip string Optional | United States ZIP code of the address. Allowable Values: 10 char max |
Sample request body
JSON
{
"address_1": "333 Elm Street"
}
Response body
| Fields | Description |
|---|---|
| active boolean Conditionally returned | Specifies whether the address is active. This field is returned if it exists in the resource. Allowable Values: true, false |
| address_1 string Returned | Street name and number of the address. Allowable Values: 255 char max |
| address_2 string Conditionally returned | Additional address information. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| 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 |
| city string Returned | City of the address. Allowable Values: 40 char max |
| country string Returned | Country of the address. Allowable Values: 1–40 chars |
| created_time datetime Returned | Date and time when the resource was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| first_name string Returned | First or given name of the cardholder. Allowable Values: 40 char max |
| 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 |
| 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 |
| last_name string Returned | Last name or family name of the cardholder. Allowable Values: 40 char max |
| phone string Conditionally returned | Telephone number of the cardholder. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| postal_code string Returned | Postal code of the address. Allowable Values: 10 char max |
| 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 |
| token string Returned | Unique identifier of the address object. Allowable Values: 1–36 chars |
| 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 |
| 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 |
Sample response body
JSON
{
"business_token": "my_business_01",
"token": "my_funding_source_address_biz_01",
"first_name": "Jane",
"last_name": "Doe",
"address_1": "333 Elm Street",
"city": "Berkeley",
"state": "CA",
"postal_code": "94705",
"zip": "94705",
"country": "USA",
"phone": "5104444444",
"is_default_address": true,
"active": true,
"created_time": "2023-02-20T20:04:13Z",
"last_modified_time": "2023-02-28T16:00:00Z"
}