Organizations
The organizations
object represents a a legal entity that can own multiple sub-organizations (for Forte Partners) or multiple locations (for Forte Merchants) as well as the customers, payment methods, and transactions that belong to those locations.
NOTE: All the parameters of the organizations
object are return only.
Parameter | Description | Type | Req |
organization_id | The identification number of the organization. For example, org_1234568. | string | -- |
parent_organization_id | The identification number of the merchant's parent organization. | string | -- |
legal_name | The legal name of the business. The value of this parameter must match the name associated with the merchant's Tax ID Number. [max length = 50]. | string | -- |
organization_name | The Doing-Business-As (DBA) name of the organization. For example, Bob Smith Enterprises. | string | -- |
status | The status of this organization. Supported values include the following: | string | -- |
organization_type | The type of organization. Supported values include the following: merchant | string | -- |
last_4_tax_id | The last four digits of the Tax ID associated with this organization. | string | -- |
language | The language associated with the organization. Currently, the only supported language is English (en). | string | -- |
currency | The preferred currency of the organization. Currently, the only supported currency option is USD. | string | -- |
physical_address | The physical_address object. | string | -- |
physical_address.street_address1 | The first line of the organization's street address. | string | -- |
physical_address.street_address2 | If needed, the second line of the organization's street address. | string | -- |
physical_address.locality | The city/town/village/locality of the organization. | object | -- |
physical_address.region | The state or province of the organization. This field supports ISO-standard, 2-digit abbreviations for state and province names. | string | -- |
physical_address.postal_code | The zip or postal code of the organization. | string | -- |
physical_address.country | The Alpha-3, ISO-standard country code of the organization. For example, USA or CAN. | string | -- |
created_date | The date and time when this organization was created | string | -- |
legal_structure | The legal business struture of this organization. Supported values for this field include the following:limited_liability_corporation | string | -- |
contact | The contacts object. | object | -- |
contact.contact_type | The type of contact associated with this organization. Only the primary contact displays for "GET All Organizations" requests. SUpported values for this field include the following: primary | string | -- |
contact.full_name | The first and last name of the contact associated with this orgniaztion. | string | -- |
contact.phone | The phone number of this organization's contact. [max length = 15] | string | -- |
contact.email | The business email address of this organization's contact. This email cannot be a generic email address or from a distribution list. The value of this parameter must be in a valid email format (e.g., john.doe@email.com). [max length = 100] | string | -- |
GET Find All Organizations
{{baseURI}}/organizations
This URI returns all organizations beneath a parent organization (e.g., a partner organization or an enterprise organization). To narrow your search data using specific criteria, use the following parameters to filter your results:
organization_name
region
country
status:
active
suspended
pending
legal_structure:
limited_liability_corporation
publicly_held_corporation
sole_proprietorship
partnership_general_or_limited
c-corporation
s-corporation
government
tax_exempt_or_non_profit_organization
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 '{{baseURI}}/organizations' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'
Example Response
{
"number_results": 2,
"search_criteria": {
"page_size": 50,
"page_index": 0,
"resource_specific": {}
},
"results": [
{
"organization_id": "org_344174",
"parent_organization_id": "org_235433",
"status": "active",
"organization_name": "Hill Valley County Treasurer",
"legal_name": "Hill Valley County Treasurer",
"organization_type": "merchant",
"last_4_tax_id": "6423",
"language": "en",
"currency": "usd",
"physical_address": {
"street_line1": "111 East Main Street",
"locality": "Hill Valley",
"region": "CA",
"postal_code": "90214",
"country": "USA"
},
"contact": [],
"links": {
"fundings": "https://api.forte.net/v3/organizations/org_344174/fundings",
"disputes": "https://api.forte.net/v3/organizations/org_344174/disputes",
"documents": "https://api.forte.net/v3/organizations/org_344174/documents",
"bankaccounts": "https://api.forte.net/v3/organizations/org_344174/bankaccounts",
"locations": "https://api.forte.net/v3/organizations/org_344174/locations",
"customers": "https://api.forte.net/v3/organizations/org_344174/customers",
"addresses": "https://api.forte.net/v3/organizations/org_344174/addresses",
"paymethods": "https://api.forte.net/v3/organizations/org_344174/paymethods",
"transactions": "https://api.forte.net/v3/organizations/org_344174/transactions",
"settlements": "https://api.forte.net/v3/organizations/org_344174/settlements",
"scheduleitems": "https://api.forte.net/v3/organizations/org_344174/scheduleitems",
"applications": "https://api.forte.net/v3/organizations/org_344174/applications",
"self": "https://api.forte.net/v3/organizations/org_344174/"
}
},
{
"organization_id": "org_300005",
"parent_organization_id": "org_234791",
"status": "active",
"organization_name": "Hill Valley County Waste Management",
"legal_name": "Hill Valley County Waste Management",
"legal_structure": "government",
"organization_type": "merchant",
"last_4_tax_id": "3122",
"language": "en",
"currency": "usd",
"physical_address": {
"street_line1": "1435 Clock Tower Rd",
"locality": "Hill Valley",
"region": "CA",
"postal_code": "90214",
"country": "USA"
},
"contact": [
{
"contact_type": "primary",
"full_name": "Marty McFly",
"phone": "(555) 555-5555",
"email": "marty.mcfly@hvcwm.com"
}
],
"links": {
"fundings": "https://api.forte.net/v3/organizations/org_300005/fundings",
"disputes": "https://api.forte.net/v3/organizations/org_300005/disputes",
"documents": "https://api.forte.net/v3/organizations/org_300005/documents",
"bankaccounts": "https://api.forte.net/v3/organizations/org_300005/bankaccounts",
"locations": "https://api.forte.net/v3/organizations/org_300005/locations",
"customers": "https://api.forte.net/v3/organizations/org_300005/customers",
"addresses": "https://api.forte.net/v3/organizations/org_300005/addresses",
"paymethods": "https://api.forte.net/v3/organizations/org_300005/paymethods",
"transactions": "https://api.forte.net/v3/organizations/org_300005/transactions",
"settlements": "https://api.forte.net/v3/organizations/org_300005/settlements",
"scheduleitems": "https://api.forte.net/v3/organizations/org_300005/scheduleitems",
"applications": "https://api.forte.net/v3/organizations/org_300005/applications",
"self": "https://api.forte.net/v3/organizations/org_300005/"
}
}
],
"response": {
"environment": "live",
"response_desc": "Get Successful."
},
"links": {
"self": "https://api.forte.net/v3/organizations/"
}
}
Headers (8) |
|
---|---|
date |
Tue, 03 Nov 2020 19:48:12 GMT |
content-type |
application/json; charset=utf-8 |
Content-Length |
3447 |
Connection |
keep-alive |
Cache-Control |
no-cache |
pragma |
no-cache |
expires |
-1 |
server |
|
GET Find an Organization by ID
{{baseURI}}/organizations/org_{{organizationID}}
This endpoint returns all the information for a specific organization based on the organization_id
.
Example Request
curl --location -g '{{baseURI}}/organizations/org_{{organizationID}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'
Example Response
{
"organization_id": "org_300005",
"parent_organization_id": "org_234791",
"status": "active",
"organization_name": "Hill Valley County Waste Management",
"legal_name": "Hill Valley County Waste Management",
"legal_structure": "government",
"organization_type": "merchant",
"last_4_tax_id": "3122",
"language": "en",
"currency": "usd",
"physical_address": {
"street_line1": "1435 Clock Tower Rd",
"locality": "Hill Valley",
"region": "CA",
"postal_code": "90214",
"country": "USA"
},
"contact": [
{
"contact_type": "primary",
"full_name": "Marty McFly",
"phone": "(555) 555-5555",
"email": "marty.mcfly@hvcwm.com"
}
],
"response": {
"environment": "live",
"response_desc": "Get Successful."
},
"links": {
"fundings": "https://api.forte.net/v3/organizations/org_300005/fundings",
"disputes": "https://api.forte.net/v3/organizations/org_300005/disputes",
"documents": "https://api.forte.net/v3/organizations/org_300005/documents",
"bankaccounts": "https://api.forte.net/v3/organizations/org_300005/bankaccounts",
"locations": "https://api.forte.net/v3/organizations/org_300005/locations",
"customers": "https://api.forte.net/v3/organizations/org_300005/customers",
"addresses": "https://api.forte.net/v3/organizations/org_300005/addresses",
"paymethods": "https://api.forte.net/v3/organizations/org_300005/paymethods",
"transactions": "https://api.forte.net/v3/organizations/org_300005/transactions",
"settlements": "https://api.forte.net/v3/organizations/org_300005/settlements",
"scheduleitems": "https://api.forte.net/v3/organizations/org_300005/scheduleitems",
"applications": "https://api.forte.net/v3/organizations/org_300005/applications",
"self": "https://api.forte.net/v3/organizations/org_300005/"
}
}
Headers (8) |
|
---|---|
date |
Tue, 03 Nov 2020 20:02:53 GMT |
content-type |
application/json; charset=utf-8 |
Content-Length |
1728 |
Connection |
keep-alive |
Cache-Control |
no-cache |
pragma |
no-cache |
expires |
-1 |
server |
|