Addresses
The addresses object represents the customer's billing and/or shipping addresses and includes the physical_address sub-object. NOTE: For token payments, Forte will use the default shipping and billing addresses. Set the customers default shipping and billing addresses prior to creating a token payment.
Addresses Object
Parameter | Description | Type | Req |
address_token | A unique string used to represent an address. For example, add_tq0hemmmtf-zsxgq689rew. [max length = 26] | string | R |
customer_token | A unique string used to represent a customer. For example, cst_SoGUG6mcLUS1nVzYBIbk3g. [max length = 26] | string | R |
organization_id | The identification number of the associated organization. For example, org_5551236. | string | R |
location_id | The identification number of the associated location. For example, loc_1234568. | string | R |
first_name | The first name of the user associated with this billing or shipping address [max length = 25]. NOTE: Either the first_name, last_name, or company_name parameters are required when creating addresses. | string | O |
last_name | The last name of the user associated with this billing or shipping address [max length = 25]. NOTE: Either the first_name, last_name, or company_name parameters are required when creating addresses. | string | O |
company_name | The name of the company associated with this billing or shipping address [max length = 20]. NOTE: Either the first_name, last_name, or company_name parameters are required when creating addresses. | string | O |
phone | The phone number associated with this billing or shipping address. This field supports both U.S. and Canadian phone numbers. [max length = 15] | string | O |
The email address associated with this billing or shipping address [max length = 50] | string | O | |
label | A label that succinctly identifies the address. For example, "Work" or "Home." [max length = 50] | string | O |
address_type | The type of address. Use one of the following values: default_shipping - The default shipping address none - The address is not a default address) both - The address is both a default shipping and default billing address | string | O |
shipping_address_type | Indicates whether the address is a residential or commercial address. | string | R |
physical_address | The Physical Address Object. | object | O |
physical_address.street_line1 | The first line of the street address [max length = 35] | string | O |
physical_address.street_line2 | The second line of the street address [max length = 35] | string | O |
physical_address.locality | Locality or city/town/village [max length = 25] | string | O |
physical_address.region | Region or state/province. [max length = 10] | string | O |
physical_address.country | The ISO 3166-1 alpha-2 country abbreviation. [max length = 2] | string | O |
physical_address.postal_code | Postal Code [max length = 15]. | string | O |
POST Customer Address (Simple)
{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses
This URI creates a new address record for the customer and returns a new address_token.
{
"physical_address": {
"street_line1": "8003 Clock Tower Ln",
"street_line2": "Suite 200",
"locality": "Hill Valley",
"region": "CA",
"country": "US",
"postal_code": "95420"
}
}
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--header 'Content-Type: application/json' \
--data '{
"physical_address": {
"street_line1": "8003 Clock Tower Ln",
"street_line2": "Suite 200",
"locality": "Hill Valley",
"region": "CA",
"postal_code": "95420"
}
}'
Example Response
POST Customer Address (Alternate URI)
{{baseURI}}/organizations/org_{{organizationID}}/customers/cst_{{customertoken}}/addresses
This URI creates a new address for the customer and returns a new address_token; however, you must include the location_id in the body of the request since this value is not included in the specified route. The Location ID identifies the location from where you are processing transactions.
{
"location_id": "loc_192642"
"physical_address": {
"street_line1": "8003 Clock Tower Ln",
"street_line2": "Suite 200",
"locality": "Hill Valley",
"region": "CA",
"country": "US",
"postal_code": "95420"
}
}
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/customers/cst_{{customertoken}}/addresses' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--header 'Content-Type: application/json' \
--data '{
"location_id": "loc_192642",
"physical_address": {
"street_line1": "8003 Clock Tower Ln",
"street_line2": "Suite 200",
"locality": "Hill Valley",
"region": "CA",
"postal_code": "95420"
}
}'
Example Response
POST Customer Address
{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses
This URI creates a new address for the customer and returns a new address_token.
{
"label": "Shipping",
"first_name": "Marty",
"last_name": "McFly",
"company_name": "Brown Associates",
"phone": "444-444-4444",
"email": "m.mcfly@brown.net",
"physical_address":{
"street_line1": "8003 Clock Tower Ln",
"street_line2": "Suite 200",
"locality": "Hill Valley",
"region": "CA",
"country": "US",
"postal_code": "95420"
}
}
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"label": "Shipping",
"first_name": "Marty",
"last_name": "McFly",
"company_name": "Brown Associates",
"phone": "444-444-4444",
"email": "m.mcfly@brown.net",
"physical_address":{
"street_line1": "8003 Clock Tower Ln",
"street_line2": "Suite 200",
"locality": "Hill Valley",
"postal_code": "95420"
}
} '
Example Response
Get Address by ID
{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/addresses/add_{{addresstoken}}
This URI returns detailed address data using the address_token.
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organization}}/locations/loc_{{location}}/addresses/add_{{addresstoken}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'
Example Response
Get Customer's Address(es)
{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses/
This URI returns all address(es) associated with a customer based on the customer_token.
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses/' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'
Example Response
Get All Addresses for a Location
{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/addresses/
This URI returns all addresses owned by a location. Remember, a location is a processing endpoints that merchant organizations use to initiate transactions. To narrow your search data, use the customer_token parameter to filter your results.
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organization}}/locations/loc_{{location}}/addresses/' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'
Example Response
Get All Addresses for an Organization
{{baseURI}}/organizations/org_{{organizationID}}/addresses/
This URI returns all address(es) owned by an Organization. To narrow your search data using specific criteria, use the following parameters to filter your results:
location_id
customer_token
Note:Â Please note that sending a request at the partner (org) level may result in a large data set and may cause timeout errors depending on the request. We recommend sending your GET request at the Merchant (Organization) level.
Example Request
curl --location -g 'https://api.forte.net/v3/organizations/org_{{organization}}/addresses' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'
Example Response
PUT Update an Address (Simple)
{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses/add_{{addresstoken}}
This URI updates the specified address record.
{
"physical_address": {
"street_line1": "8003 Clock Tower Ln",
"street_line2": "Suite 101",
"locality": "Hill Valley",
"region": "CA",
"country": "US"
}
}
Example Request
curl --location -g --request PUT 'https://api.forte.net/v3/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses/add_{{addresstoken}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--header 'Content-Type: application/json' \
--data '{
"physical_address": {
"street_line1": "8003 Clock Tower Ln",
"street_line2": "Suite 101",
"locality": "Hill Valley",
"region": "CA",
"country": "US"
}
}'
Example Response
PUT Update an Address
{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses/add_{{addresstoken}}
This URI updates the specified address record.
{
"label": "Shipping",
"first_name": "Jennifer",
"last_name": "Parker-McFly",
"company_name": "Brown Associates",
"phone": "444-444-4444",
"email": "j.mcfly@brown.net",
"shipping_address_type": "commercial",
"address_type": "none",
"physical_address": {
"street_line1": "58003 Clock Tower Ln",
"street_line2": "Suite 101",
"locality": "Hill Valley",
"region": "CA",
"postal_code": "95420",
"country": "US"
}
}
Example Request
curl --location -g --request PUT 'https://api.forte.net/v3/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses/add_{{addresstoken}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"label": "Shipping",
"first_name": "Jennifer",
"last_name": "Parker-McFly",
"company_name": "Brown Associates",
"phone": "444-444-4444",
"email": "j.mcfly@brown.net",
"shipping_address_type": "commercial",
"address_type": "none",
"physical_address": {
"street_line1": "58003 Clock Tower Ln",
"street_line2": "Suite 101",
"locality": "Hill Valley",
"region": "CA",
"postal_code": "95420",
"country": "US"
}
}'
Example Response
DELETE Address
{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/addresses/add_{{addresstoken}}
Deletes the address associated with the specified address_token.
Example Request
curl --location -g --request DELETE 'https://api.forte.net/v3/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/addresses/add_{{addresstoken}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--data ''
Example Response