Onboarding Spec Details
Principal
The data definitions displayed below are specifically related to principal details of the business.
Parameter | Data Type | Format | minLength | maxLength | Definition |
---|---|---|---|---|---|
principal.firstName | string | John | 0 | 255 | Principal's first name. |
principal.lastName | string | Lee | 0 | 255 | Principal's last name. |
principal.title | enum | CEO/President, Owner/Founder, VP/Director, Manager, Administrator, Other | N/A | N/A | Principal's business title. |
principal.telephone | string | 1234567890 | 0 | 10 | Principal's telephone number. |
principal.email | string | [email protected] | 0 | 30 | Principal's email address. |
principal.dateOfBirth | string($date-time) | 2001-01-01T16:24:22.678+00:00 | N/A | N/A | Principal's date of birth. |
principal.driversLicense | string | D12345678 | 0 | 30 | Principal's drivers license. |
principal.driversLicenseState | string | AZ | 0 | 2 | Principal's drivers license issued state. |
principal.ssn | string | 123456789 | 0 | 9 | Principal's social security number. |
principal.percentOwnership | number | 80 | 0 | 100 | Principal's ownership percentage of the business. |
principal.line1 | string | 123 Main Street | 0 | 255 | Principal's home address line 1. |
principal.line2 | string | Suite 101 | 0 | 40 | Principal's home address line 2. |
principal.city | string | Phoenix | 0 | 40 | Principal's home address city. |
principal.postalCode | string | 85251 | 0 | 10 | Principal's home address postal code. |
principal.countrySubdivision | string | AZ | 0 | 2 | Principal's home address state. |
principal.country | string | USA | 0 | 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 | minLength | maxLength | Definition |
---|---|---|---|---|---|
merchant.name | string | ExactPayDS, LLC | 0 | 255 | The company's legal name. |
merchant.businessRegistrationNumber | string | 123456789 | 0 | 9 | The company's business Tax-ID. |
merchant.dbaName | string | ExactPay Donut Shop | 0 | 22 | The company's business name that will be seen on cardholder statements. |
merchant.establishedDate | string($date-time) | 2001-01-01T16:24:22.678+00:00 | N/A | N/A | The date the business was established. |
merchant.telephone | string | 1234567890 | 0 | 10 | The company's business phone number. |
merchant.email | string | [email protected] | 0 | 40 | The company's business email address. |
merchant.onlinePresence | string | www.example.com | 0 | 40 | The company's business website URL. |
merchant.facebook | string | facebook.com/merchant | 0 | 40 | The company's business Facebook URL. |
merchant.twitter | string | twitter.com/merchant | 0 | 40 | The company's business Twitter URL. |
merchant.linkedin | string | linkedin.com/merchant | 0 | 40 | The company's business LinkedIn URL. |
merchant.entityType | enum | LLC, Org, Sole Prop, Non-Profit, Corp | 0 | 40 | The company's entity type. |
merchant.mcc | number | 5999 | 0 | 4 | The company's merchant category code that best describes their business. |
merchant.line1 | string | 123 Main Street | 0 | 255 | Company's business address line 1. |
merchant.line2 | string | Suite 101 | 0 | 40 | Company's business address line 2. |
merchant.city | string | Phoenix | 0 | 40 | Company's business address city. |
merchant.postalCode | string | 85251 | 0 | 10 | Company's business address postal code. |
merchant.countrySubdivision | string | AZ | 0 | 2 | Company's business address state. |
merchant.country | string | USA | 0 | 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 | minLength | maxLength | Definition |
---|---|---|---|---|---|
businessProfile.servicesDescription | string | B2B Billing Platform | 0 | 255 | A brief description of the goods or services being sold. |
businessProfile.currentlyAcceptingPayments | boolean | true/false | N/A | N/A | Determine if the merchant is currently accepting credit cards through another provider. |
businessProfile.currentProcessor | string | Payment Company | 0 | 255 | If the merchant is currently accepting credit cards, who are they processing with? |
businessProfile.currentGateway | string | Payment Gateway | 0 | 255 | If the merchant is currently accepting credit cards, which gateway are they using? |
businessProfile.reasonForLeaving | string | Rates | 0 | 255 | A brief explanation of why they are leaving their current processor. |
businessProfile.acceptanceMethods | number | moto, internet, swipe, keyed | 0 | 100 | Provide a numeric value for each acceptance type, totalling 100. |
__businessProfile.recurringServices | boolean | true/false | N/A | N/A | Determine if the merchant is processing recurring billing payments. |
businessProfile.recurringServicesDescription | string | Subscription Billing | 0 | 255 | A brief description of the services offered associated with recurring payments. |
businessProfile.refundPolicyDescription | string | Refund within 30 days | 0 | 255 | A brief description of the refund policy or link to refund policy on website. |
businessProfile.paymentTime | enum | upon purchase, upon download, at time of delivery, other | N/A | N/A | A brief description of when the payment is processed. |
businessProfile.deliveryTimeframe | enum | immediate, within 7 days, within 14 days, within 30+ days | N/A | N/A | A brief description of when the goods or services are provided to the cardholder. |
Anticipated Transaction Amounts
Parameter | Data Type | Format | minLength | maxLength | Definition |
---|---|---|---|---|---|
averageTicketSize | number | 500 | 0 | 20 | The average dollar amount of payments processed. |
maxTicketSize | number | 1500 | 0 | 20 | The projected highest dollar amount a payment may be processed for. |
anticipatedMonthlyVolume | number | 50000 | 0 | 20 | The projected total transaction volume amount processed within a given month. |
Banking
Parameter | Data Type | Format | minLength | maxLength | Definition |
---|---|---|---|---|---|
bankName | string | U.S. Bank | 0 | 25 | The name of the banking institution that funds will be deposited into. |
routingNumber | number | 122100024 | 0 | 9 | The ABA bank routing number associated with your bank account. |
ddaNumber | number | 2233445566 | The DDA bank account number associated with your bank account. |