Boarding Applications

This endpoint provides an interface for working with Boarding Applications. Each application belongs to a pre-created campaign. A campaign controls several aspects of a Boarding Application, such as pricing fees, the type of processing and several other parameters.

The overall boarding process is as follows:

1. Create a Boarding Application and get the Boarding Application id

2. Update the Boarding Application data using the id

   • Update Principal using the principals.id

   • Add Principals or Mass Update/Insert Principals if needed

   • Update the Processing/ACH section

   • Upload necessary documents and assign them to the Boarding Application

   • Update Fee where necessary

3. Request eSign or use AutoSign functionality to get needed signatures from principals.

4. Update application status to Underwriting or use AutoUnderwriting functionality

5. Check application status for changes.

Expand Flow Chart

> Keep in mind that after creating an application you can get the url and send it for merchant completion. The link will initiate a web interface which allows the Boarding Application to be completed by the merchant online.

Application Object

Fields	Description	Type	Filterable	Required	Readonly
id	Unique ID of the Boarding Application	Integer	Yes	No	Yes
processingMethod	Acquiring, ACH, All	ENUM	Yes	Yes	Yes
campaign	Object	Object	No	Yes	Yes
campaign.id	Unique ID of the Campaign to which the Boarding Application is assigned	Integer	Yes	Yes	Yes
company	Object	Object	No	Yes	Yes
company.name	Corporate / Legal Name	String	Yes	Yes	No
company.type	Individual, Partnership, Corporation, Government, LLC, Non-Profit, Publicly-Traded	ENUM	No	Yes	No
company.stockSymbol	If the company.type is of type Publicly-Traded the stock symbol is required	String	No	Conditional	No
company.federalTaxId	Federal Tax ID/EIN	Integer	No	Yes	No
company.address	Object	Object	No	Yes	No
company.address.street	Street address	String	No	Yes	No
company.address.city	City	String	No	Yes	No
company.address.zip	Zip code	String	No	Yes	No
company.address.state	Object	Object	No	Yes	No
company.address.state.id	State ID	Integer	No	Yes	No
company.address.country	Object	Object	No	Yes	No
company.address.country.id	Country ID	Integer	No	Yes	No
company.founded	The date when the business was founded	Date	No	Yes	No
dba	Object	Object	No	Yes	No
dba.sameAsCompany	Set as Yes if DBA information is the same as legal/corporate else No	ENUM	No	Yes	No
dba.name	DBA Name	String	Yes	Conditional	No
dba.address	Object	Object	No	Conditional	No
dba.address.street	Street address	String	No	Conditional	No
dba.address.city	City	String	No	Conditional	No
dba.address.zip	Zip code	String	No	Conditional	No
dba.address.state	Object	Object	No	Conditional	No
dba.address.state.id	State ID	Integer	No	Conditional	No
dba.address.country	Object	Object	No	Conditional	No
dba.address.country.id	Country ID	Integer	No	Conditional	No
website	Business website	String	No	No	No
serviceDescription	Describe your products and services	String	No	Yes	No
mailingAddress	dba, legal (Preference where to receive mail)	ENUM	No	Yes	No
businessLocation	Object	Object	No	Yes	No
businessLocation.buildingType	Shopping Center, Office Building, Industrial Building, Residence	ENUM	No	Yes	No
businessLocation.numberOfLocations	Number of business locations	Integer	No	No	No
businessLocation.buildingOwnership	Owns, Rents	ENUM	No	Yes	No
businessLocation.areaZoned	Commercial, Industrial, Residential	ENUM	No	Yes	No
businessLocation.squareFootage	0-500,501-2500,2501-5000,5001-10000,10000+	ENUM	No	Yes	No
customerServiceContact	Object	Object	No	No	No
customerServiceContact.phone	Customer service phone number	String	No	Yes	No
customerServiceContact.email	Customer service email	String	No	No	No
corporateContact	Object	Object	No	No	No
corporateContact.phone	Corporate phone number	String	No	No	No
corporateContact.fax	Corporate fax number	String	No	No	No
corporateContact.email	Corporate email	String	No	No	No
bankruptcy	Object	Object	No	Yes	No
bankruptcy.hasBankruptcy	Business Bankruptcy, Personal Bankruptcy, Never	ENUM	No	Yes	No
bankruptcy.description	If applicable, explain bankruptcy reason	String	No	Conditional	No
principals	Array of Objects	Object	No	Yes	No
principals.id	Unique ID of principal	Integer	Yes	No	Yes
principals.title	CEO, CFO, Chairman, Co-owner, Controller, Director, General Manager, Office Manager, Owner, Partner, President, Treasurer, Vice President, COO	ENUM	No	Yes	No
principals.name	Object	Object	No	Yes	No
principals.name.first	First name	String	No	Yes	No
principals.name.last	Last name	String	No	Yes	No
principals.dayOfBirth	Date of Birth	Date	No	No	No
principals.ssn	Social Security Number	String	No	Yes	No
principals.driverLicense	Object	Object	No	Yes	No
principals.driverLicense.number	Driver's License Number	String	No	Yes	No
principals.driverLicense.expiration	Driver's License Expiration Date	Date	No	Yes	No
principals.driverLicense.state	Object	Object	No	Yes	No
principals.driverLicense.state.id	The ID of the Driver's License State	Integer	No	Yes	No
principals.address	Object	Object	No	Yes	No
principals.address.street	Street address	String	No	Yes	No
principals.address.city	City	String	No	Yes	No
principals.address.zip	Zip code	String	No	Yes	No
principals.address.state	Object	Object	No	Yes	No
principals.address.state.id	State ID	String	No	Yes	No
principals.address.country	Object	Object	No	Yes	No
principals.address.country.id	Country ID	String	No	Yes	No
principals.phone	Object	Object	No	Yes	No
principals.email	Country ID	String	No	Yes	No
principals.ownershipPercentage	Percentage of ownership	Integer	No	Yes	No
principals.isManagement	Yes, No (If this is the individual you want to list as a Management)	ENUM	No	Yes	No
principals.isSigner	Yes, No (If this is the individual you want to list as a Signer)	ENUM	No	Yes	No
principals.isPersonalGuarantee	Yes, No (If this is the individual you want to list as a Guarantee)	ENUM	No	Yes	No
processing	Object	Object	No	Yes	No
processing.bank	Object (Business bank account information where funds are to be deposited)	Object	No	Yes	No
processing.bank.accountNumber	Bank Account Number	Integer	No	Yes	No
processing.bank.routingNumber	Bank Routing Number	Integer	No	Yes	No
processing.banks	Bank Details	Object	No	No	Yes
processing.banks.id	Unique ID of the Bank Account	Integer	No	No	Yes
processing.banks.type	The Bank Account type All Debits Deposits	ENUM	No	No	Yes
processing.banks.bankAccountNumber	The Bank Account Number	String	No	No	Yes
processing.banks.bankRoutingNumber	The Bank Routing Number	String	No	No	Yes
processing.volumes	Object	Object	No	Yes	No
processing.volumes.monthlyTransactionAmount	Monthly Volume	Integer	No	Yes	No
processing.volumes.avgTransactionAmount	Average Transaction Amount	Integer	No	Yes	No
processing.volumes.maxTransactionAmount	Max Transaction Amount	Integer	No	Yes	No
processing.sales	Object	Object	No	Yes	No
processing.sales.swiped	Percentage of card-present transactions	Integer	No	Yes	No
processing.sales.mail	Percentage of mail/phone card not present transactions	Integer	No	Yes	No
processing.sales.internet	Percentage of internet/eCommerce card not present transactions	Integer	No	Yes	No
processing.alreadyProcessing	Object	String	No	Yes	No
processing.alreadyProcessing.isProcessing	Yes, No (If this business currently accept credit/debit cards)	ENUM	No	Yes	No
processing.alreadyProcessing.processor	If applicable who is the current processor	String	No	Conditional	No
processing.terminated	Object	Object	No	Yes	No
processing.terminated.isTerminated	Yes, No (If business or any principal has ever been terminated from accepting bank cards)	ENUM	No	Yes	No
processing.terminated.description	If applicable Explain Terminated Reason	String	No	Conditional	No
processing.customers	Object	Object	No	Conditional	No
processing.customers.type	Object	Object	No	Conditional	No
processing.customers.type.individual	Percentage of sales to individual customers	Integer	No	Conditional	No
processing.customers.type.business	Percentage of sales to business customers	Integer	No	Conditional	No
processing.customers.type.government	Percentage of sales to government customers	Integer	No	Conditional	No
processing.customers.location	Object	Object	No	Conditional	No
processing.customers.location.local	Percentage of local sales	Integer	No	Conditional	No
processing.customers.location.national	Percentage of national sales	Integer	No	Conditional	No
processing.customers.location.international	Percentage of international sales	Integer	No	Conditional	No
processing.fulfillmentPolicy	Object	Object	No	Conditional	No
processing.fulfillmentPolicy.fulfillment	24-hours,2-days,3-10-days,11-30-days,31-90-days,90-plus-days,other	ENUM	No	Conditional	No
processing.fulfillmentPolicy.fulfillmentOther	If your fulfillment policy is not listed above explain it briefly here	String	No	Conditional	No
processing.fulfillmentPolicy.delivery	24-hours, 2-5-days, 6-10-days, 11-plus-days, other	ENUM	No	Conditional	No
processing.fulfillmentPolicy.deliveryOther	If your delivery policy is not listed above explain it briefly here	String	No	Conditional	No
processing.recurringPayments	Object	Object	Yes	Conditional	No
processing.recurringPayments.hasRecurring	Yes, No	ENUM	Yes	Conditional	Yes
processing.recurringPayments.description	Explain if offered any subscriptions, memberships, recurring plans etc.	String	No	Conditional	No
processing.intendedUsage	Object (Which payments would you like to accept?)	String	No	Yes	No
processing.intendedUsage.creditCards	Yes, No	ENUM	No	Yes	No
processing.intendedUsage.pinDebit	Yes, No	ENUM	No	Yes	No
processing.intendedUsage.ebt	Yes, No	ENUM	No	Yes	No
processing.intendedUsage.fns	EBT - EBT FNS Number	String	No	Conditional	No
processing.intendedUsage.notes	Intended usage notes	String	No	No	No
processing.seasonalBusiness	Object	Object	No	No	No
processing.seasonalBusiness.isSeasonal	Yes, No (Is business seasonal?)	ENUM	No	No	No
processing.seasonalBusiness.months	Jan, Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec	ENUM	No	No	No
processing.inventory	Object (Where is inventory maintained)	Object	No	No	No
processing.inventory.onSite	Yes, No (Inventory maintained On-Site)	ENUM	No	Yes	No
processing.inventory.offSite	Yes, No (Inventory maintained Off-Site, Warehouse)	ENUM	No	Yes	No
processing.inventory.offSiteAddress	If inventory is maintained off-site provide the address	String	No	Conditional	No
processing.inventory.thirdParty	Yes, No (If you are using 3rd Party Fulfillment Center)	ENUM	No	Yes	No
processing.inventory.serviceOnly	Yes, No (Service only business, no product sold)	ENUM	No	Yes	No
processing.retailLocation	Confirm Physical Address of retail location	String	No	Conditional	No
processing.externalFulfillment	Yes, No (If there are any other external companies involved in fulfillment)	String	No	No	No
processing.customerCharged	time-offer-order, upon-shipment (When is the customer charged)	String	No	No	No
processing.equipmentUsed	List equipment and/or software used to process cards (point-of-sale, terminal, payment gateway, etc.)	String	No	Yes	No
processing.advertise	How do you advertise (internet, magazines, tv, etc.)	String	No	Conditional	No
processing.refundPolicy	Describe your refund and return policy	String	No	Yes	No
ach	Object	String	No	Yes	No
ach.bank	Object (Business bank account information where funds are to be deposited)	Object	No	Yes	No
ach.bank.accountNumber	Bank Account Number	Integer	No	Yes	No
ach.bank.routingNumber	Bank Routing Number	Integer	No	Yes	No
ach.banks	Bank Details	Object	No	No	Yes
ach.banks.id	Unique ID of the Bank Account	Integer	No	No	Yes
ach.banks.type	The Bank Account type All Debits Credits Billing	ENUM	No	No	Yes
ach.banks.bankAccountNumber	The Bank Account Number	String	No	No	Yes
ach.banks.bankRoutingNumber	The Bank Routing Number	String	No	No	Yes
ach.volumes	Object	Object	No	Yes	No
ach.volumes.monthlyTransactions	Number Of Monthly Transactions	Integer	No	Yes	Yes
ach.volumes.monthlyTransactionAmount	Monthly Volume	Integer	No	Yes	No
ach.volumes.avgTransactionAmount	Average Transaction Amount	Integer	No	Yes	No
ach.volumes.maxTransactionAmount	Max Transaction Amount	Integer	No	Yes	No
ach.volumes.monthlyReturn	Monthly Return	Integer	No	Yes	No
ach.alreadyProcessing	Object	String	No	Yes	No
ach.alreadyProcessing.isProcessing	Yes, No (If this business currently processes ACH payments)	ENUM	No	Yes	No
ach.alreadyProcessing.isProcessing.processor	If applicable who is the current processor	String	No	Conditional	No
ach.terminated	Object	Object	No	Yes	No
ach.terminated.isTerminated	Yes, No (If business or any principal has ever been terminated from accepting bank cards)	ENUM	No	Yes	No
ach.terminated.description	If applicable Explain Terminated Reason	String	No	Conditional	No
ach.customers	Object	Object	No	Conditional	No
ach.customers.type	Object	Object	No	Conditional	No
ach.customers.type.individual	Percentage of sales to individual customers	Integer	No	Conditional	No
ach.customers.type.business	Percentage of sales to business customers	Integer	No	Conditional	No
ach.customers.type.government	Percentage of sales to government customers	Integer	No	Conditional	No
ach.customers.location	Object	Object	No	Conditional	No
ach.customers.location.local	Percentage of local sales	Integer	No	Conditional	No
ach.customers.location.national	Percentage of national sales	Integer	No	Conditional	No
ach.customers.location.international	Percentage of international sales	Integer	No	Conditional	No
ach.fulfillmentPolicy	Object	Object	No	Conditional	No
ach.fulfillmentPolicy.delivery	24-hours,2-5-days,6-10-days,11-plus-days,other	ENUM	No	Conditional	No
ach.fulfillmentPolicy.deliveryOther	If your fulfillment policy is not listed above explain it briefly here	String	No	Conditional	No
ach.recurringPayments	Object	Object	Yes	Conditional	No
ach.recurringPayments.hasRecurring	Yes, No (Do you charge any sort of recurring fees for ongoing)	ENUM	Yes	Conditional	Yes
ach.recurringPayments.description	Explain if offered any subscriptions, memberships, recurring plans/fees etc.	String	No	Conditional	No
ach.issueCredits	Object	Object	Yes	Conditional	No
ach.issueCredits.hasissueCredit	Yes, No (Will you need to issue credits)	ENUM	Yes	Conditional	Yes
ach.issueCredits.description	Provide details if you need to issue credits	String	No	Conditional	No
ach.secCodes	Object	Object	Yes	Conditional	No
ach.secCodes.ccd	Percentage of CCD ACH transactions	Integer	No	Yes	No
ach.secCodes.ppd	Percentage of PPD ACH transactions	Integer	No	Yes	No
ach.secCodes.tel	Percentage of TEL ACH transactions	Integer	No	Yes	No
ach.secCodes.web	Percentage of WEB ACH transactions	Integer	No	Yes	No
ach.customerCharged	time-offer-order, upon-shipment (When is the customer charged)	ENUM	No	No	No
ach.refundPolicy	Describe your refund and return policy	String	No	Yes	No
documents	Array of attachment ID's	Array	No	Yes	No
agent	Object	String	No	Yes	No
agent.id	Unique id of the agent to whom the Boarding Application is assigned	Integer	Yes	Yes	Yes
signature	Object	Object	No	Yes	No
signature.status	Unsigned, Partially Signed, Signed, Rejected	ENUM	Yes	No	Yes
signature.via	eSign, DocuSign, PrintedPDF (How was the application signed)	ENUM	No	No	Yes
status	New, Pending, Underwriting, Approved, Declined, Cancelled	ENUM	Yes	Yes	No
updatedOn	Date and Time of last update on the Boarding Application	Datetime	Yes	No	Yes
createdOn	Date and Time when the Boarding Application was created	Datetime	Yes	No	Yes