❗️
Prerequisites to invoke this API:
Authenticate and send the bearer token for this call.

Request

Details


HTTP Method	GET
Endpoint * Sandbox	https://api-sandbox.flexfactor.io/v1/merchants
Endpoint * Production	https://api.flexfactor.io/v1/merchants
Authentication	Bearer Token

Body

This API doesn't require body parameters.

Response

General response parameters


`accountId`	string	Unique identifier for the account.
`id`	string	Unique identifier of the merchant (use as the `{mid}` path parameter).
`companyName`	string	Name of the company.
`legalEntityName`	string	Legal name of the entity.
`dba`	string	Doing Business As (DBA) name of the company.
`type`	string	Type of the business entity, E.g.: Sole Partnership.
`website`	string	Company's website URL.
`description`	string	Description of the company.
`specialTerms`	string	Special terms related to the merchant account.
`mcc`	string	Merchant Category Code.
`industry`	string	Industry type, E.g.: 'Publishing'
`status`	string	Status of the account: `ACTIVE` or `INACTIVE`.
`statusName`	string	Name of the status, E.g.: 'ACTIVE'
`customerSupportInformation`	object	Contains customer support details like name, email, phone, and support link, plus an optional `note` and `tags`.
`createdOn`	datetime	Timestamp of when the account was created.
`primaryContact`	object	Contains merchant's primary contact's first name, last name, email, and phone, plus `userCreated` and `confirmedUser` flags and an optional `note` and `tags`.
`developerContact`	object	Contains developer contact information, plus an optional `note` and `tags`.
`sites`	array of objects	Contains information about sites associated with the merchant.
`timezone`	integer	Timezone of the merchant, represented as an offset from UTC in minutes.
`language`	string	Language preference of the merchant.
`timezoneName`	string	Name of the timezone, E.g.: "Pacific/Pitcairn".
`externalMerchantIdentifier`	string	Your own identifier for the merchant, if one was supplied at onboarding. Optional
`partnerResellerReference`	string	Reference of the partner or reseller that onboarded the merchant. Optional

Customer Support Information


`customerSupportName`	string	Name of the customer support contact.
`customerSupportEmail`	string	Email address for customer support.
`customerSupportPhone`	string	Phone number for customer support.
`customerSupportLink`	string	URL to customer support webpage.
`note`	string	Free-text note. Optional
`tags`	object	Tags grouped by key. Optional

Primary Contact


`firstName`	string	First name of the merchant's primary contact.
`lastName`	string	Last name of the merchant's primary contact.
`email`	string	Email address of the merchant's primary contact.
`phone`	string	Phone number of the merchant's primary contact.
`userCreated`	boolean	`true` when a portal user exists for this contact.
`confirmedUser`	boolean	`true` when that portal user has confirmed their account.
`note`	string	Free-text note. Optional
`tags`	object	Tags grouped by key. Optional

Developer Contact


`developerFirstName`	string	First name of the developer contact.
`developerLastName`	string	Last name of the developer contact.
`developerEmail`	string	Email address of the developer contact.
`developerPhone`	string	Phone number of the developer contact.
`note`	string	Free-text note. Optional
`tags`	object	Tags grouped by key. Optional

Sites


`id`	string	required	Unique identifier for the site.
`name`	string	required	Name of the site.
`descriptor`	string	required	Descriptor of the site.
`descriptorCity`	string	optional	Deprecated. Use `location.city`.
`location`	object	optional	Location shown with the descriptor: `country`, `state`, `city`, `addressLine`, `postal`.
`useLocationDescriptor`	boolean	optional	`true` when the location is appended to the descriptor.
`state`	string	optional	State of the site.
`customerSupportName`	string	required	Name of the site-specific customer support contact.
`customerSupportEmail`	string	required	Email address for site-specific customer support.
`customerSupportPhone`	string	required	Phone number for site-specific customer support.
`customerSupportLink`	string	required	URL to site-specific customer support webpage.
`whitelistedUrls`	array of strings	optional	List of whitelisted URLs for the site.
`tags`	array of strings	optional	Tags associated with the site.

A 'Site' is a unique online entity within a merchant's account. Key attributes include:

multiple URLs: Each site can be linked to several web addresses, accommodating diverse online facets of a business.
multiple Tags: Sites can be labeled with various tags for easy categorization and identification.
unique FlexFactor Descriptor: Each site is distinguished by a specific FlexFactor descriptor, ensuring unique identification within the system.
dedicated Customer Support Info: Sites have individual customer support details, including contact name, email, phone number, and a support link, enabling tailored customer service for each site.

Payload examples

Request

curl --request GET \
     --url https://api-sandbox.flexfactor.io/v1/merchants \
     --header 'Authorization: Bearer abc123def456' \  //replace with bearer returned by /oauth2
     --header 'accept: application/json'

Response

{
  "accountId": "12345678-90ab-cdef-1234-567890abcdef",
  "id": "abcdef12-3456-7890-abcd-ef1234567890",
  "companyName": "Example Corporation",
  "legalEntityName": "Example Corporation Legal",
  "dba": "Example Corp",
  "type": "Limited Liability Company",
  "website": "https://example-website.com/",
  "description": "A sample description of Example Corporation.",
  "specialTerms": "Special terms and conditions apply.",
  "mcc": "1234",
  "industry": "Software and IT Services",
  "status": "INACTIVE",
  "statusName": "INACTIVE",
  "customerSupportInformation": {
    "customerSupportName": "Example Support",
    "customerSupportEmail": "[email protected]",
    "customerSupportPhone": "+12345678901",
    "customerSupportLink": "https://support.example.com",
    "note": null,
    "tags": null
  },
  "createdOn": "2023-01-01T00:00:00.000000Z",
  "primaryContact": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phone": "0123456789",
    "userCreated": true,
    "confirmedUser": true,
    "note": null,
    "tags": null
  },
  "developerContact": {
    "developerFirstName": "Jane",
    "developerLastName": "Smith",
    "developerEmail": "[email protected]",
    "developerPhone": "0987654321",
    "note": null,
    "tags": null
  },
  "sites": [
    {
      "id": "ab12cd34-ef56-gh78-ij90-kl12mn34op56",
      "name": "Example Site",
      "descriptor": "ExampleDescriptor",
      "descriptorCity": "Example City",
      "location": {
        "country": "US",
        "state": "CA",
        "city": "Example City",
        "addressLine": "123 Main St.",
        "postal": "94111"
      },
      "useLocationDescriptor": true,
      "customerSupportName": "Alice",
      "customerSupportEmail": "[email protected]",
      "customerSupportPhone": "+10987654321",
      "customerSupportLink": "https://support.examplesite.com",
      "whitelistedUrls": ["https://www.examplesite.com"],
      "tags": ["Example", "Sample", "Demo"],
      "state": "CA"
    }
  ],
  "timezone": -60,
  "language": "en",
  "timezoneName": "Atlantic/Azores",
  "externalMerchantIdentifier": null,
  "partnerResellerReference": null
}