Signing up Merchants

Overview

Merchants on your platform can sign up to offer Sunbit to customers.

Sunbit's Merchant API makes signing up for Sunbit quick and easy. You can incorporate this API in your current onboarding process by adding a Call to Action in your registration form.

Once a merchant expresses interest in offering financing, you can initiate the Sunbit sign up process by either:

a. Asking Sunbit to send an onboarding text message to the merchant.

b. Requesting a unique URL so that you can incorporate the Sunbit sign up into your platform's onboarding experience.

Ask Sunbit to send an onboarding text message to the merchant

Send merchant information to Sunbit in the request payload. The information you send will be pre-filled for the merchant so it's helpful to provide as much information as possible for a smoother onboarding experience. The request should also include a Location ID which you will provide as a unique identifier for each specific merchant location. Merchants from the following states are not supported: VT, WV and WY. Business information of Dental Merchants/Customers located in CA will not be pre-filled.

Important

Merchants from the following states are not supported: VT, WV and WY. Business information of Dental Merchants/Customers located in CA will not be pre-filled.

Request a unique URL

Based on the request, Sunbit will return a unique URL for the merchant or text the merchant directly to the phone number specified.

Once the merchant completes and submits the onboarding form they will be reviewed and activated. Sunbit will send merchants a training package so that they can start offering Sunbit right away. You can use a webhook to check the status of the merchant application. The URL will expire within 30 days if an application has not been submitted.

Merchant Onboarding Form

Add a new merchant

POST https://api-sandbox.sunbit.com/onboarding/api/v1/location

Headers

Property	Required	Type	Description
sunbit-key	yes	text	Provided to you by Sunbit
sunbit-secret	yes	text	Provided to you by Sunbit

Body

Attribute	Required	Type	Description
location	yes	text	Unique identifier of the merchant.
sendSMS	no	boolean	True if Sunbit should send SMS with the onboarding link, false by default
legalName	no	text	The legal name of the business entity
businessName	no	text	The business name
vertical	yes	text	The name of vertical as defined in Verticals
businessAddress	no	AddressDetails	The business address
representativeDetails	yes	BusinessRepresentative	Business representative details that is associated with the location
sourcePlatform	no	text	The originating platform on whose behalf the API request is being made, if different from the alliance.

AddressDetails

Attribute	Required	Type	Description
address	no	text	Customer's address
city	no	text	Customer's city
state	no	text	Customer's state
zipcode	no	text	Customer's zipcode
suite	no	text	Customer's suite

BusinessRepresentative

Attribute	Required	Type	Description
firstName	no	text
lastName	no	text
phoneNumber	no	text
email	no	text

Response

Attribute	Type	Description
location	text	Same as in request body
url	text	Merchant application URL for onboarding form
creationDate	text	Format YYYY-MM-DD
status	text	CREATED

Verticals

The vertical should be taken from the defined below options:

• Car_Dealerships
• Car_Services
• Veterinary
• Motorsports_Parts_and_Services
• Dental
• Eyewear
• Home_Services
• Med_Spa
• Bridal
• General_Retail
• Jewelry_and_Watches
• Legal_Services
• Medical_Office
• Hospital_Health_System

Example

Request

curl -X POST \  '"https://api-sandbox.sunbit.com/onboarding/api/v1/location' \  -H 'Content-Type: application/json' \  -H 'sunbit-key: YOUR_KEY' \  -H 'sunbit-secret: YOUR_SECRET' \  -d '{      "location" : "johns-store",      "sendSMS" : true,      "legalName" : "John Doe Dental",      "vertical" : "Car_Dealerships",      "representativeDetails" : {             "firstName" : "John",             "lastName" : "Doe",             "phoneNumber" : "303-988-8945",             "email":"john.doe@emailaddress.email"      }}'

Response

{      "location" : "johns-store",      "url" : "https://merchant-onboarding.sunbit.com/hwerityQas",      "creationDate" : "2019-12-19",      "status" : "CREATED"}

Errors

Error Code	Message	Description
400	Bad Request	Missing or invalid input, or sendSMS is true but no representative phone number provided
401	Unauthorized	sunbit-key and/or sunbit-secret do not match any alliance credentials
409	Conflict	Same location was already added for this alliance
422	Unprocessable Entity	Vertical parameter is not supported
422	Unprocessable Entity	State is not supported, List of Unsupported States
500	Internal Server Error	Something went wrong on Sunbit's side

Get merchant status

GET https://api-sandbox.sunbit.com/onboarding/api/v1/location/{location}

Headers

Property	Required	Type	Description
sunbit-key	yes	text	Provided to you by Sunbit
sunbit-secret	yes	text	Provided to you by Sunbit

Body

Path Parameters

Property	Required	Type	Description
location	yes	text	Unique identifier of the merchant.

Response

Attribute	Type	Description
location	text	Same as in request path
url	text	Merchant application URL for onboarding form
creationDate	text	Format YYYY-MM-DD
status	text	The list of possible statuses includes CREATED LOCATION_DETAILS_ADDED CONTACT_DETAILS_ADDED BANK_INFORMATION_ADDED SUBMITTED LEGAL_INFORMATION_ADDED ACTIVATED DECLINED
expiredInDays	number	Number of days for token to expire
expirationDate	text	Token expiration date in format YYYY-MM-DD

Example

Request

curl 'https://api-sandbox.sunbit.com/onboarding/api/v1/location/johns-store' \  -H 'sunbit-key: YOUR_KEY' \  -H 'sunbit-secret: YOUR_SECRET'

Response

{  "location" : "johns-store",  "url" : "https://merchant-onboarding.sunbit.com/hwerityQas",  "creationDate" : "2019-12-19",  "status" : "LOCATION_DETAILS_ADDED",  "expiredInDays": 30,  "expirationDate": "2020-01-19"}

Errors

Error Code	Message	Description
401	Unauthorized	sunbit-key and/or sunbit-secret do not match any alliance credentials
404	Resource Not Found	Location was not found
422	State Not Supported	Merchant is operating in an unsupported State
500	Internal Server Error	Something went wrong on Sunbit's side