Application Boarding Conventions
This page provides conventions for use with the Application Boarding API resource. For instructions on implementing Application Boarding API requests, see the Application Boarding implementation guide as well as the relevant endpoints' implementation guides and API reference.
'Save Data' Request Conventions
The following table shows key
and value
pairs accepted in the data
array in a 'Save Data' request. The sets marked "Required" will ultimately be required for the application's approval in underwriting, but they are not required for a 'Save Data' request to succeed. For instructions on sending this request, see the Save Data implementation guide:
key | Requirement for Application Approval | value |
---|---|---|
legal_name | Conditional Requirement: Required, except when business-type is sole-prop . | The legal name of the business. |
business_name | Required | The 'Doing Business As' (DBA) name of the business. This will appear on a cardholder's statement. |
business_websites | Required | A list of URLs. |
business_email | Required | An email address for the business. |
business_phone | Optional | The telephone number for the business. This will appear on a cardholder's statement. |
business_address | Required | The mailing address for the business. |
business_type | Required | The business type. Send one of the following: • sole-prop - Sole Proprietorship• llc - Limited Liability Company• corporation-public - Public Corporation• corporation-private - Private Corporation• partnership - Partnership• tax-exempt - Non-Profit |
limited_partnership | Required | Send true if the business is a limited partnership, false if it is not. |
trading_status | Required | The trading status of the business. Send one of the following: • pt - Publicly traded• np - Non-public |
tax_id_type | Required | The type of tax ID provided in the application. Send one of the following: • ein - Employer Identification Number (EIN)• ssn - Social Security Number (SSN) |
tax_id | Required | The tax ID for the business. |
state_filed | Required | The U.S. state in which the business files taxes. |
business_established | Required | The date the business was established, formatted as YYYY-MM-DD. |
business_mcc | Required | The Merchant Category Code (MCC) of the business's industry. |
business_description | Required | A detailed description of the type of clients the business sells to. |
ownership | Required | An object containing an array of objects, the requisite form of which is determined by business_type . See Owner / Officer Information in the 'Save Data' implementation guide. |
processing_history | Required | Send true if the business has processed credit cards before or false if it has not. |
business_services_process | Required | At what point the business processes a payment. Send one of the following: • order - Payments are processed at the time of order.• fulfill - Payments are processed at the time of fulfillment. |
business_services_auth_time | Required | The number of days before fulfillment the business takes payment. Send one or more of the following: • 1 - 0 to 1 days• 30 - 2 to 29 days• 30+ - 30 to 89 days• 90+ - 90 or more days |
card_brands | Required | The card brands the business accepts. This should be an object of five Booleans: • vi - Set this to true if Visa is accepted.• mc - Set this to true if Mastercard is accepted.• di - Set this to true if Discover is accepted.• am - Set this to true if American Express is accepted.• gp - Set this to true if Google Pay is accepted. |
card_volume | Required | The projected annual volume of all card payments to the business. |
ach_volume | Optional | The projected annual volume of ACH payments to the business. |
total_volume | Required | The projected total annual sales, including cash. |
high_ticket | Required | The high ticket business to consumer (B2C) amount. |
fulfillment_provider_flag | Required | How the order is filled. Send one of the following: • business - The order is fulfilled by the business submitting this application.• thirdparty - The order is fulfilled by a third party. |
fulfillment_delivery_method | Required | How the order is received. This should be an object of four Booleans: • digitally - Set this to true if some or all orders are fulfilled digitally.• pickup - Set this to true if some or all orders are picked up.• delivery - Set this to true if some or all orders are delivered.• Service - Set this to true if some or all orders are provided as a service. |
delivery_confirmation | Required | Send true if you authorize delivery without getting a signature, false if you do not. |
fulfillment_name | Optional | The name of the fulfillment center. |
fulfillment_contact | Optional | The name of the fulfillment contact. |
fulfillment_email | Optional | The email address of the fulfillment contact. |
fulfillment_phone | Optional | The phone number of the fulfillment contact. |
fulfillment_address | Optional | The address of the fulfillment center. |
fulfillment_process_flag | Optional | Send true if the fulfillment center enters credit card payments on your behalf, false if they do not. |
bank_routing | Required | The 9-digit routing number of the bank receiving the money. |
bank_account_number | Required | The account number of the bank account receiving the money (usually 10-12 digits). |
Updated 12 months ago