Onboarding Spec Details

Below you will find the defined data sets related to the merchant application which is submitted using the Create Onboarding POST API call.

Principal

The data definitions displayed below are specifically related to principal details of the business.

Parameter

Data Type

Format

Definition

principal.firstName

string

example: John
minLength: 0
maxLength: 255

Principal's first name.

principal.lastName

string

example: Lee
minLength: 0
maxLength: 255

Principal's last name.

principal.title

enum

options: CEO/President, Owner/Founder, VP/Director, Manager, Administrator, Other

Principal's business title.

principal.telephone

string

example: 1234567890
minLength: 0
maxLength: 10

Principal's direct phone number.

principal.email

string

example: [email protected]
minLength: 0
maxLength: 30

Principal's direct email.

principal.dateOfBirth

string($date-time)

example: 2001-01-01T16:24:22.678+00:00

Principal's date of birth.

principal.driversLicense

string

example: D12345678
minLength: 0
maxLength: 30

Principal's drivers's license.

principal.driversLicenseState

string

example: AZ
minLength: 0
maxLength:2

Principal's driver's license issued state.

principal.ssn

string

example: 123456789
minLength: 0
maxLength: 9

Principal's social security number.

principal.percentOwnership

number

example: 80
minLength: 0
maxLength: 100

Principals ownership percentage of the business.

principal.line1

string

example: 123 E Main Street
minLength: 0
maxLength: 255

Principals home address line 1

principal.line2

string

example: Suite 101
minLength: 0
maxLength: 40

Principals home address line 2.

principal.city

string

example: Phoenix
minLength: 0
maxLength: 40

Principal's home address city.

principal.postalCode

string

example: 85251
minLength: 0
maxLength: 10

Principal's home address postal code.

principal.countrySubdivision

string

example: AZ
minLength: 0
maxLength: 2

Principal's home address state.

principal.country

string

example: USA
minLength: 0
maxLength: 3

Principal's home address country.

Merchant

The data definitions displayed below are specifically related to the business details on the application.

Parameter

Data Type

Format

Definition

merchant.name

string

example: ExactPay DS, LLC.
minLength: 0
maxLength: 255

The company's legal name.

merchant.businessRegistrationNumber

string

example: 123456789
minLength: 0
maxLength: 9

The company's business Tax-ID.

merchant.dbaName

string

example: ExactPay Donut Shop
minLength: 0
maxLength: 22

The company's business name that will be seen on cardholder statements.

merchant.establishedDate

string($date-time)

example: 2001-01-01T16:24:22.678+00:00

The date the business was established.

merchant.telephone

string

example: 1234567890
minLength: 0
maxLength: 10

The company's business phone number.

merchant.email

string

example: [email protected]
minLength: 0
maxLength: 40

The company's business e-mail address.

merchant.onlinePresence

string

example: www.example.com
minLength: 0
maxLength: 40

The company's business website URL.

merchant.facebook

string

example: facebook.com/merchant
minLength: 0
maxLength: 40

The company's business Facebook URL.

merchant.twitter

string

example: instagram.com/merchant
minLength: 0
maxLength: 40

The company's business Twitter URL.

merchant.linkedin

string

example: linkedin.com/merchant
minLength: 0
maxLength: 40

The company's business Linkedin URL.

merchant.entityType

string

options: LLC, Org, Sole Prop, Non-Profit, Corp

The company's entity type.

merchant.mcc

number

example: 5999
minLength: 0
maxLength: 4

The company's merchant category code that best describes their business.

merchant.line1

string

example: Phoenix
minLength: 0
maxLength: 255

Company's business address line 1

merchant.line2

string

example: Phoenix
minLength: 0
maxLength: 40

Company's business address line 2.

merchant.city

string

example: Phoenix
minLength: 0
maxLength: 40

Company's business address city.

merchant.postalCode

string

example: 85251
minLength: 0
maxLength: 10

Company's business address postal code.

merchant.countrySubdivision

string

example: AZ
minLength: 0
maxLength: 2

Company's business address state.

merchant.country

string

example: USA
minLength: 0
maxLength: 3

Company's business address country.

Business Profile

The data definitions displayed below are specifically related to profile details of the business

Parameter

Data Type

Format

Definition

businessProfile.servicesDescription

string

example: B2B Billing Platform
minLength: 0
maxLength: 255

A brief description of the goods or services being sold.

businessProfile.currentlyAcceptingPayments

boolean

options: true, false

Determine if the merchant is currently accepting credit cards through another provider.

businessProfile.currentProcessor

string

example: Payment Company
minLength: 0
maxLength: 255

If the merchant is currently accepting credit cards, who are they processing with?

businessProfile.currentGateway

string

example: Payment Gateway
minLength: 0
maxLength: 255

If the merchant is currently accepting credit cards, which gateway are they using?

businessProfile.reasonForLeaving

string

example: Rates
minLength: 0
maxLength: 255

A brief explanation of why they are leaving their current processor.

businessProfile.acceptanceMethods

number

options: moto, internet, swipe, keyed

Provide a numeric value for each acceptance type, totalling 100.

businessProfile.recurringServices

boolean

options: true, false

Determine if the merchant is processing recurring billing payments.

businessProfile.recurringServicesDescription

string

example: Subscription Billing
minLength: 0
maxLength: 255

A brief description of the services offered associated with recurring payments.

businessProfile.refundPolicyDescription

string

example: Refund within 30 days
minLength: 0
maxLength: 255

A brief description of the refund policy or link to refund policy on website.

businessProfile.paymentTime

enum

options: upon purchase, upon download, at time of delivery, other

A brief description of when the payment is processed.

businessProfile.deliveryTimeframe

enum

options: immediate, within 7 days, within 14 days, within 30+ days

A brief description of when the goods or services are provided to the cardholder.

Anticipated Transaction Amounts

Parameter

Data Type

Format

Definition

averageTicketSize

number

example: 500
minLength: 0
maxLength: 20

The average dollar amount of payments processed.

maxTicketSize

number

example: 1500
minLength: 0
maxLength: 20

The projected highest dollar amount a payment may be processed for.

anticipatedMonthlyVolume

number

example: 50000
minLength: 0
maxLength: 20

The projected total transaction volume amount processed within a given month.

Banking

Parameter

Data Type

Format

Definition

bankName

string

example: U.S. Bank
minLength: 0
maxLength: 25

The name of the banking institution that funds will be deposited into.

routingNumber

number

example: 122100024
minLength: 0
maxLenght: 9

The ABA bank routing number associated with your bank account.

ddaNumber

number

example: 2233445566

The DDA bank account number associated with your bank account.