/merchants
Use the Merchants API to retrieve information details on a merchant account set up on Flex.
Request
Details
| HTTP Method | GET |
| Endpoint - Sandbox | https://api-sandbox.flex-charge.com/v1/merchants |
| Endpoint - Production | https://api.flex-charge.com/v1/merchants |
| Authentication | Bearer Token |
Body
This API doesn't require body parameters.
Request example
curl --request GET \
--url https://api-sandbox.flex-charge.com/v1/merchants \
--header 'Authorization: abc123def456' \ //replace with bearer returned by /oauth2
--header 'accept: application/json'
Prerequisites to invoke this API:
Authenticate and send the bearer token for this call.
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": 0,
"statusName": "INACTIVE",
"customerSupportInformation": {
"customerSupportName": "Example Support",
"customerSupportEmail": "[email protected]",
"customerSupportPhone": "+12345678901",
"customerSupportLink": "https://support.example.com"
},
"createdOn": "2023-01-01T00:00:00.000000Z",
"primaryContact": {
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"phone": "0123456789"
},
"developerContact": {
"developerFirstName": "Jane",
"developerLastName": "Smith",
"developerEmail": "[email protected]",
"developerPhone": "0987654321"
},
"bankAccountInformation": {
"ddaType": "Savings",
"accountNumber": "1234567890",
"maskedAccountNumber": "xxxxx1234",
"routingNumber": "987654321",
"maskedRoutingNumber": "xxxxx4321",
"bankAccountVerified": true,
"bankName": "Example Bank"
},
"sites": [
{
"id": "ab12cd34-ef56-gh78-ij90-kl12mn34op56",
"name": "Example Site",
"descriptor": "ExampleDescriptor",
"descriptorCity": "Example City",
"customerSupportName": "Alice",
"customerSupportEmail": "[email protected]",
"customerSupportPhone": "+10987654321",
"customerSupportLink": "https://support.examplesite.com",
"whitelistedUrls": ["https://www.examplesite.com"],
"tags": ["Example", "Sample", "Demo"]
}
],
"timezone": 60,
"language": "en",
"timezoneName": "Atlantic/Azores"
}
General response parameters
accountId | string | Unique identifier for the account. |
id | string | Merchant ID. |
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 | integer | Numerical status of the account 1 for active 0 for inactive |
statusName | string | Name of the status, E.g.: 'ACTIVE' |
customerSupportInformation | object | Contains customer support details like name, email, phone, and support link. |
createdOn | datetime | Timestamp of when the account was created. |
primaryContact | object | Contains merchant's primary contact's first name, last name, email, and phone. |
developerContact | object | Contains developer contact information. |
bankAccountInformation | object | Contains banking details like account type, masked account and routing numbers. |
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". |
Detailed object parameters:
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. |
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. |
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. |
Bank Account Information
ddaType | string | Type of bank account, e.g., Checking, Savings. |
accountNumber | string | Full bank account number. |
maskedAccountNumber | string | Masked version of the account number. |
routingNumber | string | Full routing number for the bank account. |
maskedRoutingNumber | string | Masked version of the routing number. |
bankAccountVerified | boolean | Indicates whether the bank account is verified by Flex. |
bankName | string | Name of the bank. |
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 | required | City associated with the site descriptor. |
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 Flex Descriptor: Each site is distinguished by a specific Flex 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.
Updated 12 days ago