Skip to main content

Onboarding Spec Details

Principal

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

ParameterData TypeFormatminLengthmaxLengthDefinition
principal.firstNamestringJohn0255Principal's first name.
principal.lastNamestringLee0255Principal's last name.
principal.titleenumCEO/President, Owner/Founder, VP/Director, Manager, Administrator, OtherN/AN/APrincipal's business title.
principal.telephonestring1234567890010Principal's telephone number.
principal.emailstring[email protected]030Principal's email address.
principal.dateOfBirthstring($date-time)2001-01-01T16:24:22.678+00:00N/AN/APrincipal's date of birth.
principal.driversLicensestringD12345678030Principal's drivers license.
principal.driversLicenseStatestringAZ02Principal's drivers license issued state.
principal.ssnstring12345678909Principal's social security number.
principal.percentOwnershipnumber800100Principal's ownership percentage of the business.
principal.line1string123 Main Street030Principal's home address line 1.
principal.line2stringSuite 101040Principal's home address line 2.
principal.citystringPhoenix040Principal's home address city.
principal.postalCodestring85251010Principal's home address postal code.
principal.countrySubdivisionstringAZ02Principal's home address state.
principal.countrystringUSA03Principal's home address country.

Merchant

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

ParameterData TypeFormatminLengthmaxLengthDefinition
merchant.namestringExactPayDS, LLC0255The company's legal name.
merchant.businessRegistrationNumberstring12345678909The company's business Tax-ID.
merchant.dbaNamestringExactPay Donut Shop022The company's business name that will be seen on cardholder statements.
merchant.establishedDatestring($date-time)2001-01-01T16:24:22.678+00:00N/AN/AThe date the business was established.
merchant.telephonestring1234567890010The company's business phone number.
merchant.emailstring[email protected]040The company's business email address.
merchant.onlinePresencestringwww.example.com040The company's business website URL.
merchant.facebookstringfacebook.com/merchant040The company's business Facebook URL.
merchant.twitterstringtwitter.com/merchant040The company's business Twitter URL.
merchant.linkedinstringlinkedin.com/merchant040The company's business LinkedIn URL.
merchant.entityTypeenumLLC, Org, Sole Prop, Non-Profit, Corp040The company's entity type.
merchant.mccnumber599904The company's merchant category code that best describes their business.
merchant.line1string123 Main Street0255Company's business address line 1.
merchant.line2stringSuite 101040Company's business address line 2.
merchant.citystringPhoenix040Company's business address city.
merchant.postalCodestring85251010Company's business address postal code.
merchant.countrySubdivisionstringAZ02Company's business address state.
merchant.countrystringUSA03Company's business address country.

Business Profile

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

ParameterData TypeFormatminLengthmaxLengthDefinition
businessProfile.servicesDescriptionstringB2B Billing Platform0255A brief description of the goods or services being sold.
businessProfile.currentlyAcceptingPaymentsbooleantrue/falseN/AN/ADetermine if the merchant is currently accepting credit cards through another provider.
businessProfile.currentProcessorstringPayment Company0255If the merchant is currently accepting credit cards, who are they processing with?
businessProfile.currentGatewaystringPayment Gateway0255If the merchant is currently accepting credit cards, which gateway are they using?
businessProfile.reasonForLeavingstringRates0255A brief explanation of why they are leaving their current processor.
businessProfile.acceptanceMethodsnumbermoto, internet, swipe, keyed0100Provide a numeric value for each acceptance type, totalling 100.
__businessProfile.recurringServicesbooleantrue/falseN/AN/ADetermine if the merchant is processing recurring billing payments.
businessProfile.recurringServicesDescriptionstringSubscription Billing0255A brief description of the services offered associated with recurring payments.
businessProfile.refundPolicyDescriptionstringRefund within 30 days0255A brief description of the refund policy or link to refund policy on website.
businessProfile.paymentTimeenumupon purchase, upon download, at time of delivery, otherN/AN/AA brief description of when the payment is processed.
businessProfile.deliveryTimeframeenumimmediate, within 7 days, within 14 days, within 30+ daysN/AN/AA brief description of when the goods or services are provided to the cardholder.

Anticipated Transaction Amounts

ParameterData TypeFormatminLengthmaxLengthDefinition
averageTicketSizenumber500020The average dollar amount of payments processed.
maxTicketSizenumber1500020The projected highest dollar amount a payment may be processed for.
anticipatedMonthlyVolumenumber50000020The projected total transaction volume amount processed within a given month.

Banking

ParameterData TypeFormatminLengthmaxLengthDefinition
bankNamestringU.S. Bank025The name of the banking institution that funds will be deposited into.
routingNumbernumber12210002409The ABA bank routing number associated with your bank account.
ddaNumbernumber2233445566The DDA bank account number associated with your bank account.