ApplicationData Object Model
Object model for the ApplicationData object
Organization ID. Unique identifier assigned to an org by Payabli.
The alternate or common name that this business is doing business under usually referred to as a DBA name.
Business legal name.
The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: www.example.com is acceptable.
Business EIN or tax ID. This value is masked in API responses, for example XXXX6789.
Business name in tax document. This is only relevant if a government entity has given you an alternative name to file tax documents with.
Business license ID or state ID number.
Business license issuing state or province.
Business start date.
Accepted formats:
- YYYY-MM-DD
- MM/DD/YYYY
The business's phone number.
The business's fax number.
Business address.
Business address additional line.
Business city
The business ownership type.
Limited Liability Company, Non-Profit Org, Partnership, Private Corp, Public Corp, Tax Exempt, Government, Sole Proprietor Business state.
Business ZIP.
Business country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference
The business's mailing address.
Additional line for the business's mailing address.
The business's mail city.
The business's mailing address state.
Business mailing ZIP.
Business mailing country.
Business Merchant Category Code (MCC). This resource lists MCC codes.
A summary of what the business sells in terms of goods or services.
Describes when customers are charged for goods or services. Accepted values:
When Service Provided, In Advance Describes when goods or services are provided, from time of transaction.
30 Days or Less, 31 to 60 Days, 60+ Days When goods and services are delivered.
0-7 Days, 8-14 Days, 15-30 Days, Over 30 Days Describes the business refund policy.
Exchange Only, No Refund or Exchange, More than 30 days, 30 Days or Less Numeric percent of volume processed in person. To pass validation, binperson, binweb, and binphone must total 100 together.
Numeric percent of volume processed by phone. To pass validation, binperson, binweb, and binphone must total 100 together.
Numeric percent of volume processed on web. To pass validation, binperson, binweb, and binphone must total 100 together.
The associated boarding template's ID in Payabli.
Annual revenue amount.
Average total amount of transactions in your local currency that are processed each month.
The average transaction size that the business expects to process. For example, if you process $10,000 a month across 10 transactions, that's an average ticket of $1000.
High ticket amount.
Email address for the applicant. This is used to send the applicant a boarding link.
When true, Payabli will send the applicant a boarding link. Set this value to false if you are sending pre-filled applications via the API and don't want Payabli to send the applicant an email to complete the boarding application.
A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.
When true, the applicant can save an incomplete application and resume it later. When false, the applicant won't have an option to save their progress, and must complete the application in one session.
List of contacts.
List of Owners with at least a 25% ownership.
Object that contains bank account details.
Object that contains bank account details.
Object that contains bank account details.
Array of fileContent objects with attached documents. Max upload size is 30 MB.
Controls which services will be enabled for the merchant.
Information about the application's signer.
Was this page helpful?