annualRevenue
number | null

Annual revenue amount.

attachments
object[] | null

Array of fileContent objects with attached documents. Max upload size is 30 MB.

avgmonthly
number | null

Average total amount of transactions in your local currency that are processed each month.

baddress
string | null

Business address.

baddress1
string | null

Business address additional line.

bcity
string | null

Business city

bcountry
string | null

Business country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference

binperson
integer | null

Numeric percent of volume processed in person. To pass validation, binperson, binweb, and binphone must total 100 together.

binphone
integer | null

Numeric percent of volume processed by phone. To pass validation, binperson, binweb, and binphone must total 100 together.

binweb
integer | null

Numeric percent of volume processed on web. To pass validation, binperson, binweb, and binphone must total 100 together.

bstate
string | null

Business state.

bsummary
string | null

A summary of what the business sells in terms of goods or services.

btype
enum<string> | null

The business ownership type.

Available options:
Limited Liability Company,
Non-Profit Org,
Partnership,
Private Corp,
Public Corp,
Tax Exempt,
Government,
Sole Proprietor
bzip
string | null

Business ZIP.

contacts
object[] | null

List of contacts.

dbaname
string | null

The alternate or common name that this business is doing business under usually referred to as a DBA name.

depositAccount
object

Object that contains bank account details.

ein
string | null

Business EIN or tax ID.

externalPaypointId
string | null

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.

faxnumber
string | null

The business's fax number.

highticketamt
number | null

High ticket amount.

legalname
string | null

Business legal name.

license
string | null

Business license ID or state ID number.

licstate
string | null

Business license issuing state or province.

maddress
string | null

The business's mailing address.

maddress1
string | null

Additional line for the business's mailing address.

mcc
string | null

Business Merchant Category Code (MCC). This resource lists MCC codes.

mcity
string | null

The business's mail city.

mcountry
string | null

Business mailing country.

mstate
string | null

The business's mailing address state.

mzip
string | null

Business mailing ZIP.

orgId
integer | null

Organization ID. Unique identifier assigned to an org by Payabli.

ownership
object[] | null

List of Owners with at least a 25% ownership.

phonenumber
string | null

The business's phone number.

recipientEmail
string | null

Email address for the applicant. This is used to send the applicant a boarding link.

recipientEmailNotification
boolean
default:
true

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.

remittanceAccount
object

Object that contains bank account details.

resumable
boolean
default:
true

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.

services
object

Controls which services will be enabled for the merchant.

signer
object

Information about the application's signer.

startdate
string | null

Business start date.
Accepted formats:

  • YYYY-MM-DD
  • MM/DD/YYYY
taxfillname
string | null

Business name in tax document. This is only relevant if a government entity has given you an alternative name to file tax documents with.

templateId
integer | null

The associated boarding template's ID in Payabli.

ticketamt
number | null

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.

website
string | null

The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: www.example.com is acceptable.

whenCharged
enum<string>

Describes when customers are charged for goods or services. Accepted values:

Available options:
When Service Provided,
In Advance
whenDelivered
enum<string>

When goods and services are delivered.

Available options:
0-7 Days,
8-14 Days,
15-30 Days,
Over 30 Days
whenProvided
enum<string>

Describes when goods or services are provided, from time of transaction.

Available options:
30 Days or Less,
31 to 60 Days,
60+ Days
whenRefunded
enum<string>

Describes the business refund policy.

Available options:
Exchange Only,
No Refund or Exchange,
More than 30 days,
30 Days or Less
withdrawalAccount
object

Object that contains bank account details.

Was this page helpful?