ApplicationData Object Model

API Basics

Pay In Endpoints

MoneyIn
Subscription
TokenStorage
Invoice
LineItem
PaymentLink
PaymentMethodDomain
HostedPaymentPages
Cloud
Wallet: Apple Pay

Pay Out Endpoints

MoneyOut
Bill

Pay Ops Endpoints

Templates
Boarding
Chargebacks and ACH Returns
Entities
Notification
Query
Statistic
Export
Import

Object Models

Object Model References

orgId

integer | null

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

Example:

123

dbaname

string | null

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

Example:

"Sunshine Gutters"

legalname

string | null

Business legal name.

Example:

"Sunshine Services, LLC"

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.

Example:

"www.example.com"

ein

string | null

Business EIN or tax ID. This value is masked in API responses, for example XXXX6789.

Example:

"123456789"

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.

Example:

"Sunshine LLC"

license

string | null

Business license ID or state ID number.

Example:

"2222222FFG"

licstate

string | null

Business license issuing state or province.

Example:

"CA"

startdate

string | null

Business start date.
Accepted formats:

YYYY-MM-DD
MM/DD/YYYY

Example:

"01/01/1990"

phonenumber

string | null

The business's phone number.

Example:

"1234567890"

faxnumber

string | null

The business's fax number.

Example:

"1234567890"

baddress

string | null

Business address.

Example:

"123 Walnut Street"

baddress1

string | null

Business address additional line.

Example:

"Suite 103"

bcity

string | null

Business city

Example:

"New Vegas"

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

Example:

"Limited Liability Company"

bstate

string | null

Business state.

Example:

"FL"

bzip

string | null

Business ZIP.

Example:

"33000"

bcountry

string | null

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

Example:

"US"

maddress

string | null

The business's mailing address.

Example:

"123 Walnut Street"

maddress1

string | null

Additional line for the business's mailing address.

Example:

"STE 900"

mcity

string | null

The business's mail city.

Example:

"Johnson City"

mstate

string | null

The business's mailing address state.

Example:

"TN"

mzip

string | null

Business mailing ZIP.

Example:

"37615"

mcountry

string | null

Business mailing country.

Example:

"US"

mcc

string | null

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

Example:

"7777"

bsummary

string | null

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

Example:

"Brick and mortar store that sells office supplies"

whenCharged

enum<string>

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

Available options:

When Service Provided,

In Advance

Example:

"When Service Provided"

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

Example:

"30 Days or Less"

whenDelivered

enum<string>

When goods and services are delivered.

Available options:

0-7 Days,

8-14 Days,

15-30 Days,

Over 30 Days

Example:

"Over 30 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

Example:

"30 Days or Less"

binperson

integer | null

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

Example:

60

binphone

integer | null

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

Example:

20

binweb

integer | null

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

Example:

20

templateId

integer | null

The associated boarding template's ID in Payabli.

Example:

22

annualRevenue

number | null

Annual revenue amount.

Example:

1000

avgmonthly

number | null

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

Example:

1000

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.

Example:

1000

highticketamt

number | null

High ticket amount.

Example:

1000

recipientEmail

string | null

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

Maximum length: 320

Example:

"example@email.com"

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.

Example:

true

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.

Example:

"Paypoint-100"

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.

Example:

false

payoutAverageMonthlyVolume

number

The total number of bills the business pays each month. For example, if your business pays an electric bill of $500, an internet bill of $150, and various suppliers $5,000 every month then your monthly bill volume would be $5,650.

Example:

5650

payoutHighTicketAmount

number

The largest amount for bill you will pay through our service. For example, if your business paid for 3 bills each month for $500, $1000, and $5000 respectively, then your highest ticket is $5000.

Example:

5000

payoutAverageTicketLimit

number

The average amount of each bill you pay through our service. For example, if your business paid 3 bills for a total of $1,500 then your average bill size is $500.

Example:

500

payoutCreditLimit

number

The maximum amount of credit that our lending partner has authorized to the business for on-demand payouts. It's the upper boundary on how much you can spend or owe on a credit account at any given time.

Example:

1000

contacts

object[] | null

List of contacts.

ownership

object[] | null

List of Owners with at least a 25% ownership.

bankData

object

Object that contains bank account details.

attachments

object[] | null

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

Contains details about a file. See See fileObject Object Model for a complete reference. Max upload size is 30 MB.

services

object

Controls which services will be enabled for the merchant.

signer

object

Information about the application's signer.

Was this page helpful?

OCR a Base64-encoded String

BillOutData Object Model

{
  "orgId": 123,
  "dbaname": "Sunshine Gutters",
  "legalname": "Sunshine Services, LLC",
  "website": "www.example.com",
  "ein": "123456789",
  "taxfillname": "Sunshine LLC",
  "license": "2222222FFG",
  "licstate": "CA",
  "startdate": "01/01/1990",
  "phonenumber": "1234567890",
  "faxnumber": "1234567890",
  "baddress": "123 Walnut Street",
  "baddress1": "Suite 103",
  "bcity": "New Vegas",
  "btype": "Limited Liability Company",
  "bstate": "FL",
  "bzip": "33000",
  "bcountry": "US",
  "maddress": "123 Walnut Street",
  "maddress1": "STE 900",
  "mcity": "Johnson City",
  "mstate": "TN",
  "mzip": "37615",
  "mcountry": "US",
  "mcc": "7777",
  "bsummary": "Brick and mortar store that sells office supplies",
  "whenCharged": "When Service Provided",
  "whenProvided": "30 Days or Less",
  "whenDelivered": "Over 30 Days",
  "whenRefunded": "30 Days or Less",
  "binperson": 60,
  "binphone": 20,
  "binweb": 20,
  "templateId": 22,
  "annualRevenue": 1000,
  "avgmonthly": 1000,
  "ticketamt": 1000,
  "highticketamt": 1000,
  "recipientEmail": "example@email.com",
  "recipientEmailNotification": true,
  "externalPaypointId": "Paypoint-100",
  "resumable": false,
  "payoutAverageMonthlyVolume": 5650,
  "payoutHighTicketAmount": 5000,
  "payoutAverageTicketLimit": 500,
  "payoutCreditLimit": 1000,
  "contacts": [
    {
      "contactName": "Herman Martinez",
      "contactEmail": "example@email.com",
      "contactTitle": "Owner",
      "contactPhone": "3055550000"
    }
  ],
  "ownership": [
    {
      "ownername": "John Smith",
      "ownertitle": "CEO",
      "ownerpercent": 25,
      "ownerssn": "123456789",
      "ownerdob": "01/01/1990",
      "ownerphone1": "555888111",
      "ownerphone2": "555888111",
      "owneremail": "example@email.com",
      "ownerdriver": "CA6677778",
      "odriverstate": "CA",
      "oaddress": "33 North St",
      "ostate": "CA",
      "ocountry": "US",
      "ocity": "Any City",
      "ozip": "55555"
    }
  ],
  "bankData": {
    "id": 123,
    "nickname": "Business Checking 1234",
    "bankName": "Country Bank",
    "routingAccount": "123123123",
    "accountNumber": "1XXXXXX3123",
    "typeAccount": "Checking",
    "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
    "bankAccountHolderType": "Business",
    "bankAccountFunction": 0
  },
  "attachments": [
    {
      "ftype": "pdf",
      "filename": "my-doc.pdf",
      "furl": "https://mysite.com/my-doc.pdf",
      "fContent": "TXkgdGVzdCBmaWxlHJ==..."
    }
  ],
  "services": {
    "card": {
      "acceptVisa": true,
      "acceptMastercard": true,
      "acceptDiscover": false,
      "acceptAmex": true
    },
    "ach": {
      "acceptWeb": true,
      "acceptPPD": false,
      "acceptCCD": false
    },
    "odp": {
      "allowAch": true,
      "allowChecks": true,
      "allowVCard": true,
      "processor": "tysys",
      "processing_region": "US",
      "programId": 123456
    }
  },
  "signer": {
    "name": "John Smith",
    "ssn": "123456789",
    "dob": "01/01/1990",
    "phone": "555888111",
    "email": "example@email.com",
    "address": "33 North St",
    "address1": "STE 900",
    "state": "TN",
    "country": "US",
    "city": "Bristol",
    "zip": "55555",
    "acceptance": false
  }
}