Onboarding Merchants

Everyware strives to provide a seamless experience to onboard new merchants. We collect relevant merchant information to perform necessary know your customer (KYC / KYB) checks and approve or decline the merchant application for payment processing.

We provide two options for collecting merchant data, as follows:

Embedded form / link - Everyware will provide a form which you can embed into your software or send to merchants via a unique link.
API-based - Everyware provides an onboarding endpoint and webhook for API-based onboarding requests. This is especially beneficial for clients that have an existing application process or onboarding mass merchants as part of a 'back-book' conversion.

In both scenarios, the merchant must agree to the Merchant Tri-Party Agreement found here.

Embedded form / link + Onboarding Webhook

Everyware will generate a form tied to a unique link which captures your merchants' data. This link can be embedded within a landing page or within your platform. Clicking the link will open a new window with the form.

Key points of implementation:

Setup: If this option is chosen, the merchant's ID should be captured and exposed in your platform so that the merchant may submit their merchant ID in the ExternalID input along with the rest of their information.
Status and return of credentials - To automate the return of the relevant credentials to your system, your team will need to develop an endpoint that can accept a data push from the Onboarding Webhook (See API-based section below). In addition, the webhook will communicate the status of an application, such as when a merchant has been declined.

Everyware monitors basic information related to the form, including merchants that have clicked/opened it and its status related to submission.

API-Based - Onboarding Endpoint + Onboarding Webhook

Everyware's fully integrated onboarding solution consists of two components.

Onboarding Endpoint: the OnboardMerchant endpoint is called to submit the merchant's data to Everyware. When Everyware receives the data, the KYC process is initiated. After KYC is passed, the merchant's application for payment processing is reviewed. If an integration to this endpoint is pursued, the merchant will need to read and accept Everyware's Merchant Tri-Party Agreement. This can be done through a link to the agreement and checkbox on the form.
Onboarding Webhook: Everyware also uses an Onboarding Webhook to push credentials back to your system, so that you can match the data in your database directly. The webhook also communicates back the status on an application (i.e. approved, declined, etc.).

Onboarding Endpoint

Access Endpoint URL: https://rest.everyware.com/api/onboarding

Inbound Parameters

Parameter Name Type Description Required/Optional

onboardingWebhookURL string The URL for the endpoint that will receive the data push from Everyware when the onboarding process has concluded. Optional

OnboardingWebhookUsername string The basic auth username used in the request that is pushed to the onboarding webhook URL. Optional

OnboardingWebhookPassword string The basic auth password used in the request that is pushed to the onboarding webhook URL. Optional

MasterSalesSite string The master sales site for the integrated partner. Optional

contactFirstName string First name of the main business contact. Optional

contactLastName string Last name of the main business contact. Optional

contactPhone int Phone number of the main business contact. 10-digits max, no formatting. Optional

contactEmail string Email of the main business contact. Optional

ownerTitle

string

Title of the owner. Can be one of the following values:

    * 1 for President
    * 2 for Vice President
    * 3 for Treasurer
    * 4 for Owner
    * 5 for Partner
    * 6 for CEO
    * 7 for Secretary
    * 8 for Director
  </td><td>
    Required
  </td></tr><tr><td>
    ownerFirstName
  </td><td>
    string
  </td><td>
    First name of the business owner.
  </td><td>
    Required
  </td></tr><tr><td>
    ownerLastName
  </td><td>
    string
  </td><td>
    Last name of the business owner.
  </td><td>
    Required
  </td></tr><tr><td>
    ownerAddress
  </td><td>
    string
  </td><td>
    Line one of the owner's street address.
  </td><td>
    Required
  </td></tr><tr><td>
    ownerCity
  </td><td>
    string
  </td><td>
    City of owner's street address.
  </td><td>
    Required
  </td></tr><tr><td>
    ownerPhone
  </td><td>
    int
  </td><td>
    Owner's phone number.

    Format: XXX-XXX-XXXX or\
    YYY-YYY-YYYY xYYYY
  </td><td>
    Required
  </td></tr><tr><td>
    ownerState
  </td><td>
    string
  </td><td>
    State code of owner's street address.

    Format: 2-letter code (TX, FL, etc.)
  </td><td>
    Required
  </td></tr><tr><td>
    ownerZip
  </td><td>
    string
  </td><td>
    The zip code of the owner's address.
  </td><td>
    Required
  </td></tr><tr><td>
    ownerCountry
  </td><td>
    string
  </td><td>
    The country of the owner's address.

    * 1 for USA
  </td><td>
    Required
  </td></tr><tr><td>
    ownerDOB
  </td><td>
    date
  </td><td>
    Date of birth of owner.

    Format: MM/DD/YYYY
  </td><td>
    Required
  </td></tr><tr><td>
    ownerSSN
  </td><td>
    string
  </td><td>
    Social security number of owner.

    Format: No hyphens
  </td><td>
    Required
  </td></tr><tr><td>
    OwnershipPercentage
  </td><td>
    int
  </td><td>
    The percentage owned by the business owner whose information is submitted via this endpoint. Must be between 1 and 100 inclusive.
  </td><td>
    Required
  </td></tr><tr><td>
    ownerEmail
  </td><td>
    string
  </td><td>
    Email address of owner.

    Appears on your email receipts and invoices.
  </td><td>
    Required
  </td></tr><tr><td>
    businessDBA
  </td><td>
    string
  </td><td>
    The Doing Business As name of the company.
  </td><td>
    Required
  </td></tr><tr><td>
    businessLegalName
  </td><td>
    string
  </td><td>
    Legal name of the company.
  </td><td>
    Required
  </td></tr><tr><td>
    businessAddress
  </td><td>
    string
  </td><td>
    Line one of the business's street address. Appears on invoices and receipts.
  </td><td>
    Required
  </td></tr><tr><td>
    businessCity
  </td><td>
    string
  </td><td>
    City of the business's street address.
  </td><td>
    Required
  </td></tr><tr><td>
    businessState
  </td><td>
    string
  </td><td>
    State code of the business's street address.

    Format: 2-letter code (TX, FL, etc.)
  </td><td>
    Required
  </td></tr><tr><td>
    businessZip
  </td><td>
    string
  </td><td>
    The zip/postal code of the business street address.
  </td><td>
    Required
  </td></tr><tr><td>
    businessCountry
  </td><td>
    string
  </td><td>
    The country of the business address. As of now, must be "United States of America".
  </td><td>
    Required
  </td></tr><tr><td>
    corporateAddress
  </td><td>
    string
  </td><td>
    The address associated with the business's headquarters, if applicable.
  </td><td>
    Optional
  </td></tr><tr><td>
    corporateCity
  </td><td>
    string
  </td><td>
    The city of the corporate address, if applicable.
  </td><td>
    Optional
  </td></tr><tr><td>
    corporateState
  </td><td>
    string
  </td><td>
    The state of the corporate address, if applicable.
  </td><td>
    Optional
  </td></tr><tr><td>
    corporateZip
  </td><td>
    string
  </td><td>
    The postal code/ZIP of the corporate address, if applicable.
  </td><td>
    Optional
  </td></tr><tr><td>
    corporateCountry
  </td><td>
    string
  </td><td>
    The country of the corporate address, if applicable.
  </td><td>
    Optional
  </td></tr><tr><td>
    businessEmail
  </td><td>
    string
  </td><td>
    Email address of the business.
  </td><td>
    Required
  </td></tr><tr><td>
    businessPhone
  </td><td>
    int
  </td><td>
    Phone number of the business.

    Format: XXX-XXX-XXXX or\
    YYY-YYY-YYYY xYYYY
  </td><td>
    Required
  </td></tr><tr><td>
    merchantVertical
  </td><td>
    string
  </td><td>
    Must be one of the following values:

    * 1 for Retail Services
    * 8 for Restaurant
    * 9 for Automotive
    * 10 for CBD/THC/Hemp
    * 11 for Healthcare
    * 12 for Dental
    * 13 for Veterinary
    * 14 for Pharmacy
    * 15 for Clubs/Member Based Org
    * 17 for Travel - Packages
    * 18 for Travel - Airfare
    * 19 for Non-Profit
    * 20 for Business Services
    * 21 for Computer Services
  </td><td>
    Required
  </td></tr><tr><td>
    productServicesSold
  </td><td>
    string
  </td><td>
    Product/Services sold by business.
  </td><td>
    Required
  </td></tr><tr><td>
    businessFederalTaxID
  </td><td>
    string
  </td><td>
    Tax Identification Number
  </td><td>
    Required
  </td></tr><tr><td>
    businessPrimaryWebsite
  </td><td>
    string
  </td><td>
    Primary website of business. Do not include the http prefix.
  </td><td>
    Required
  </td></tr><tr><td>
    businessSecondaryWebsite
  </td><td>
    string
  </td><td>
    Secondary website of business. Do not include the http prefix.
  </td><td>
    Optional
  </td></tr><tr><td>
    bankNameOnAccount
  </td><td>
    string
  </td><td>
    The name associated with the bank account.
  </td><td>
    Required
  </td></tr><tr><td>
    bankDDA
  </td><td>
    string
  </td><td>
    The number associated with the demand deposit account.
  </td><td>
    Required
  </td></tr><tr><td>
    bankName
  </td><td>
    string
  </td><td>
    The name of the business's bank. This is the bank to which Everyware will deposit funds.
  </td><td>
    Required
  </td></tr><tr><td>
    bankRoutingNumber
  </td><td>
    string
  </td><td>
    The business's bank routing number. This is the bank to which Everyware will deposit funds.
  </td><td>
    Required
  </td></tr><tr><td>
    creditCardHighTicket
  </td><td>
    int
  </td><td>
    Highest CC ticket.
  </td><td>
    Required
  </td></tr><tr><td>
    creditCardAvgTicket
  </td><td>
    int
  </td><td>
    Average CC ticket.
  </td><td>
    Required
  </td></tr><tr><td>
    creditCardMonthlyVolume
  </td><td>
    int
  </td><td>
    Monthly credit card volume.
  </td><td>
    Required
  </td></tr><tr><td>
    businessStartDate
  </td><td>
    date
  </td><td>
    The date the business was started.

    Format: MM/DD/YYYY
  </td><td>
    Required
  </td></tr><tr><td>
    externalID
  </td><td>
    string
  </td><td>
    ID of the merchant in an external system that must be passed through to Everyware
  </td><td>
    Required
  </td></tr><tr><td>
    TermsAcceptance
  </td><td>
    bool
  </td><td>
    Indicates the merchant has accepted Everyware's Tri-Party Agreement.
  </td><td>
    Required
  </td></tr><tr><td>
    IPAddress
  </td><td>
    string
  </td><td>
    The IP address of the authorized signer for the merchant. This is used during the KYC process. It should be captured via your platform and sent in the request body.
  </td><td>
    Required
  </td></tr><tr><td>
    ProcessingACH
  </td><td>
    bool
  </td><td>
    True/False value that indicates whether the merchant would like to process ACH transactions.

    Default value set to false.
  </td><td>
    Required
  </td></tr><tr><td>
    NumberOfDevicesDesired
  </td><td>
    string
  </td><td>
    The number of terminals the merchant would like to purchase for card present transactions.

    Default value is "0".
  </td><td>
    Optional
  </td></tr><tr><td>
    EntityType
  </td><td>
    string
  </td><td>
    The type of organization that applies to the merchant. Possible values below:

    * "0" for Private Corp
    * "1" for LLC
    * "2" for Sole Proprietor
    * "3" for Public Corporation
    * "4" for Non-Profit
    * "5" for Government
    * "6" for Partnership
    * "8" for Other
  </td><td>
    Required
  </td></tr><tr><td>
    PartnerInformation
  </td><td>
    string
  </td><td>
    This unique identifier will be provided to you by the Everyware tech support team.
  </td><td>
    Optional
  </td></tr><tr><td>
    Documents
  </td><td>
    List
  </td><td>
    Each document in the list has two parameters:

    * FileName: String data type. The name of the file being passed to Everyware.
    * FileContent: String data type. The content of the file being passed to Everyware. The file content must be a raw binary file encoded in base64 when passed to Everyware.
  </td><td>
    Optional
  </td></tr></tbody></table>

Code Samples

Note: If the application failed because information was not submitted completely or properly, the Message parameter of the response will include additional instructions.

{
  "ownerTitle": "1",
  "ownerFirstName": "John",
  "ownerLastName": "Smith",
  "ownerAddress": "1234 South Street",
  "ownerCity": "Austin",
  "ownerPhone": "444-122-3345",
  "ownerState": "TX",
  "ownerZip": "78701",
  "ownerCountry": "1",
  "ownerDOB": "08/04/1990",
  "ownerSSN": "222334444",
  "ownerEmail": "john.smith@hellosunshine.com",
  "MasterSalesSite": "142977",
  "businessDBA": "Hello Sunshine",
  "businessLegalName": "Hello Sunshine, LLC",
  "businessAddress": "4567 North Street",
  "businessCity": "Austin",
  "businessState": "TX",
  "businessZip": "78702",
  "businessCountry": "1",
  "businessEmail": "info@hellosunshine.com",
  "businessPhone": 7778225432,
  "merchantVertical": "1",
  "productServicesSold": "Office supplies",
  "businessFederalTaxId": "222222222",
  "businessPrimaryWebsite": "www.hellosunshine.com",
  "bankNameOnAccount": "John Smith",
  "bankDDA": "111111111",
  "bankName": "Chase",
  "bankRoutingNumber": "322271627",
  "creditCardHighTicket": 1234,
  "creditCardAvgTicket": 444,
  "creditCardMonthlyVolume": 10000,
  "businessStartDate": "09/01/2020",
  "externalID": "12345432",
  "TermsAcceptance": true,
  "Documents": [{
  	"FileName": "Bank Statement One",
    "FileContent": "2arsinoiaesrntoieanrstoieanrst"
  },
  {
  	"FileName": "Bank Statement Two",
    "FileContent": "28aoenokhbdoaoirsn"
  }]
}

curl --location 'https://rest.everyware.com/Default/OnboardMerchant' \
--header 'Content-Type: application/json' \
--data-raw '{
  "ownerTitle": "1",
  "ownerFirstName": "John",
  "ownerLastName": "Smith",
  "ownerAddress": "1234 South Street",
  "ownerCity": "Austin",
  "ownerPhone": "4441223345",
  "ownerState": "TX",
  "ownerZip": "78701",
  "ownerCountry": "1",
  "ownerDOB": "08/04/1990",
  "ownerSSN": "xxxxxxxxx",
  "ownerEmail": "john.smith@hellosunshine.com",
  "businessDBA": "Hello Sunshine",
  "businessLegalName": "Hello Sunshine, LLC",
  "businessAddress": "4567 North Street",
  "businessCity": "Austin",
  "businessState": "TX",
  "businessZip": "78702",
  "businessCountry": "1",
  "businessEmail": "info@hellosunshine.com",
  "businessPhone": "7778225432",
  "merchantVertical": "1",
  "productServicesSold": "Office supplies",
  "businessFederalTaxId": "xxxxxxxxxxx",
  "businessPrimaryWebsite": "www.hellosunshine.com",
  "bankNameOnAccount": "John Smith",
  "bankDDA": "111111111",
  "bankName": "Chase",
  "bankRoutingNumber": "",
  "creditCardHighTicket": 1234,
  "creditCardAvgTicket": 444,
  "creditCardMonthlyVolume": 10000,
  "businessStartDate": "09012020",
  "externalID": "12345432"
}'

{
	"ApplicationID": "string",
  "Message": "Your application has been submitted successfully"
}

{
	"Message": "Sorry, your application was unsuccessfully submitted."
}

Onboarding Webhook

Outbound Parameters

Parameter Name	Type	Description
ProcessorApplicationSuccess	boolean	Will always return true
SSID	string	The ID of the sales site (business) in Everyware's system. Also serves as the username when doing Basic Authentication.
ExternalID	string	The ID of the sales site (business) in the integrated partner's system.
API Key	string	The API key associated with the sales site. This key is used with the SSID for Basic Authentication.

Code Samples

{
  "ProcessorApplicationSuccess": true,
	"SSID": "172434",
  "ExternalID": "154328",
  "APIKey": "Aes2341Xethre42",
}

Get Application Status

Access Endpoint URL: https://rest.everyware.com/api/onboarding/status/{applicationId:int} [GET]

Send a GET request to this endpoint to retrieve the status of the onboarding application. Use the application ID provided in the response to the onboarding endpoint described above.

Response Values

Value	Meaning
0	Pending
1	Successful
2	Failed