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

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": "[email protected]",
  "businessDBA": "Hello Sunshine",
  "businessLegalName": "Hello Sunshine, LLC",
  "businessAddress": "4567 North Street",
  "businessCity": "Austin",
  "businessState": "TX",
  "businessZip": 78702,
  "businessCountry": "1",
  "businessEmail": "[email protected]",
  "businessPhone": 7778225432,
  "merchantVertical": "1",
  "productServicesSold": "Office supplies",
  "businessFederalTaxId": 222222222,
  "businessPrimaryWebsite": "www.hellosunshine.com",
  "bankNameOnAccount": "John Smith",
  "bankDDA": 111111111,
  "bankName": "Chase",
  "bankRoutingNumber": 1111111111,
  "creditCardHighTicket": 1234,
  "creditCardAvgTicket": 444,
  "creditCardMonthlyVolume": 10000,
  "businessStartDate": "09/01/2020",
  "externalID": "12345432",
  "TermsAcceptance": true
}

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": "[email protected]",
  "businessDBA": "Hello Sunshine",
  "businessLegalName": "Hello Sunshine, LLC",
  "businessAddress": "4567 North Street",
  "businessCity": "Austin",
  "businessState": "TX",
  "businessZip": "78702",
  "businessCountry": "1",
  "businessEmail": "[email protected]",
  "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

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