Creating A New Business (No Merchant Data)
Access Endpoint URL: https://rest.everyware.com/api/Default/CreateNewBusiness [POST]
You can use CreateNewBusiness to rapidly create a business entity in Everyware that does not have any merchant or payment services attached. It can be used for two way text messaging, and many of the other built-in features that the Everyware Portal system provides.
Two-Way Text Messaging will be possible right away from the new mobile number assigned.
Payments can be activated and integrated later when you are ready to provide your Account Manager with the appropriate merchant account details.
Inbound Parameters
| Parameter | Description | Required |
|---|---|---|
| FirstName | First name of Main Business Contact | REQUIRED |
| LastName | Last name of Main Business Contact | REQUIRED |
| Email address of Main Business Contact (must follow standard [email protected] format) | REQUIRED | |
| Phone | Phone number of Main Business Contact. No formatting, 10 digits max. Example: 3055551212 | REQUIRED |
| Address1 | Primary street address for Main Business Contact | Optional |
| Address2 | Secondary street address for main business contact, usually Apt/Ste/Unit number. | Optional |
| City | City main business contact is located in | Optional |
| State | State code of main business contact (please use 2 letter state code, “TX”, “FL”) | Optional |
| PostalCode | Zipcode of main business contact address | Optional |
| BusinessLegalName | Legal name of the business | REQUIRED |
| BusinessPhone | Phone number of business. No formatting, 10 digits max. Example: 3055551212 This is the main phone number used to determine the mobile number area code assigned for the site. It is also the number to which calls will be forwarded from your assigned mobile number. (This can be changed later.) If left blank, the main contact's phone will be used to determine mobile area code and for call forwarding. | *See Description |
| BusinessEmail | Primary email address of business. If left blank, no email address will appear at the bottom of your email receipts and receipts will appear to come from the main contact's email address. | Optional *See Description |
| BusinessAddress1 | Line one of business street address | Optional |
| BusinessAddress2 | Line two of business street address | Optional |
| BusinessCity | City of business street address | Optional |
| BusinessState | State code of main business contact (please use 2 letter state code, “TX”, “FL”) | Optional |
| BusinessPostalCode | Zip/postal code of business street address | Optional |
| BusinessTypeId | Numeric field denoting the type of business/industry/vertical the merchant account is for. Please contact your Everyware representative to confirm which BusinessTypeId value you should use for the business(es) you will be onboarding with Everyware. | REQUIRED |
| URL | Website address for the business. http/https prefix is not required Example: google.com | REQUIRED |
| EIN | EIN/Tax Identification Number | REQUIRED |
| ExternalID | Optional unique identifier Everyware can store. Returns in Payment Report Webhook. If an ExternalID is sent twice, Everyware will block the duplicate site from being created. | Optional |
| ExternalAPIKey | Enter only if you want an External Key defined by you to override the key that is assigned by Everyware. | Optional |
| PaymentsWebhookURL | When a payment is completed, this is an optional webhook hosted by you that Everyware will post the data. Please include a valid URL prefix (https://). | Optional |
| MessagesWebhookURL | When a message is created, this is an optional webhook hosted by you that Everyware will post the data. Please include a valid URL prefix (https://). | Optional |
| CreateBusinessAPIURL | When a business is created, this is an optional webhook hosted by you that Everyware will post the data. Please include a valid URL prefix (https://). | Optional |
| CustomersWebhookURL | When a customer is added, this is an optional webhook hosted by you that Everyware will post the data. Please include a valid URL prefix (https://). | Optional |
| APIKey | When creating a sub location, use the parent API key you wish for this location to be associated with. | Optional |
| Username | When creating a sub-location, use the parent Username you wish for this location to be associated with. | Optional |
| ExternalUsername | Username for gateway connection. | OPTIONAL |
| ExternalPassword | Password associated with username for gateway connection. | OPTIONAL |
| ExternalMID | Merchant ID associated with gateway, username and credentials needed to connect gateway. The merchant account you want associated with this account's Everyware payments. | OPTIONAL |
| ExternalTerminalId | Needed to connect a MID to a payment terminal. | OPTIONAL |
Optional: BusinessTypeID
The BusinessTypeID will determine the default services, invoice fields and other feature settings throughout the site. If blank, the industry will default to the Master Site’s Business Type. If blank at the Master Site level and business level, sites will default to the most generic site type, “Other.”
BusinessPhone
This is the main phone number used to determine the mobile number area code assigned for the site. And it is the number to which calls will be forwarded from your assigned mobile number.
If left blank, the main contact's phone will be used to determine mobile area code and for call forwarding.
BusinessEmail
Primary email address of business.
If left blank, no email address will appear at the bottom of your email receipts and receipts will appear to come from the main contact's email address.
Webhook formatting
Make sure to include a proper URL prefix for a fully qualified address to your webhook.
Response Parameters
Please note that the API response for this call is not in the universal response format. It is specific to this call.
| Parameter | Description | Data Type |
|---|---|---|
| MobileNumber | Unique messaging phone number assigned for the business. | string |
| SalesSiteID | The unique identifier in Everyware for the business. | int32 |
| APIKey | The API Key for the newly created business. | string |
| Username | The username generated for the newly created business, which will usually be the same as a SalesSiteID. | string |
Sample Code
{
"FirstName": "John",
"LastName": "Doe",
"Email": "[email protected]",
"Phone": "5555555555",
"Address1": "100 Main St",
"Address2": "Apt B",
"City": "Austin",
"State": "TX",
"PostalCode": "78701",
"BusinessLegalName": "Business, Inc.",
"BusinessPhone": "5551112222",
"BusinessEmail": "[email protected]",
"BusinessAddress1": "200 South St",
"BusinessAddress2": "",
"BusinessCity": "Austin",
"BusinessState": "TX",
"BusinessPostalCode": "78018",
"BusinessTypeID": "88",
"URL": "www.website.com",
"EIN": "123456789",
"Gateway": "",
"ExternalID": "",
"ExternalAPIKey": "",
"PaymentsWebhookURL": "https://yoursite.com/api/method",
"MessagesWebhookURL": "",
"CreateBusinessAPIURL": "",
"CustomersWebhookURL": "",
"ExternalUsername" : "",
"ExternalPassword" : "",
"ExternalMID" : "",
"ExternalTerminalID": ""
}
curl --location 'https://rest.everyware.com/api/Default/CreateNewBusiness' \
--header 'Authorization: Basic [xxx]' \
--header 'Content-Type: application/json' \
--data-raw ' {
"FirstName": "John",
"LastName": "Doe",
"Email": "[email protected]",
"Phone": "5555555555",
"Address1": "100 Main St",
"Address2": "Apt B",
"City": "Austin",
"State": "TX",
"PostalCode": "78701",
"BusinessLegalName": "Business, Inc.",
"BusinessPhone": "5551112222",
"BusinessEmail": "[email protected]",
"BusinessAddress1": "200 South St",
"BusinessAddress2": "",
"BusinessCity": "Austin",
"BusinessState": "TX",
"BusinessPostalCode": "78018",
"BusinessTypeID": "88",
"URL": "www.website.com",
"EIN": "123456789",
"Gateway": "",
"ExternalID": "",
"ExternalAPIKey": "",
"PaymentsWebhookURL": "https://yoursite.com/api/method",
"MessagesWebhookURL": "",
"CreateBusinessAPIURL": "",
"CustomersWebhookURL": "",
"ExternalUsername" : "",
"ExternalPassword" : "",
"ExternalMID" : "",
"ExternalTerminalID": ""
}'
{
"IsSuccess": true,
"Message": "Nice! New Business Account has been created successfully.",
"Data": {
"MobileNumber": "5555555555",
"SalesSiteID": 127982,
"APIKey": "XXXC-CCCC-CCCC-CCCC-XXXXXXXXX",
"UserName": "127982"
}
Example Business Profile Portal View
Updated about 2 months ago