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
Get List of Boarding Applications for Org
Returns a list of boarding applications for an organization. Use filters to limit results.
curl --request GET \
--url https://api-sandbox.payabli.com/api/Query/boarding/{orgId} \
--header 'requestToken: <api-key>'{
"Summary": {
"totalRecords": 2,
"totalAmount": 77.22,
"totalNetAmount": 77.22,
"totalPages": 2,
"pageSize": 20,
"pageIdentifier": "null"
},
"Records": [
{
"idApplication": 352,
"orgId": 123,
"orgParentName": "PropertyManager Pro",
"dbaName": "Sunshine Gutters",
"legalName": "Sunshine Services, LLC",
"ein": "123456789",
"taxfillname": "Sunshine LLC",
"whencharged": "When Service Provided",
"whenProvided": "30 Days or Less",
"whendelivered": "Over 30 Days",
"whenrefund": "30 Days or Less",
"licenseState": "CA",
"license": "2222222FFG",
"bAddress1": "123 Walnut Street",
"bAddress2": "Suite 103",
"bCity": "New Vegas",
"bZip": "33000",
"bState": "FL",
"bCountry": "US",
"websiteAddress": "www.example.com",
"bPhone": "5551234567",
"bSummary": "Brick and mortar store that sells office supplies",
"bFax": "5551234567",
"mAddress1": "123 Walnut Street",
"mAddress2": "STE 900",
"mCity": "TN",
"mZip": "37615",
"mState": "TN",
"mCountry": "US",
"bStartdate": "01/01/1990",
"ownType": "Limited Liability Company",
"salesCode": "<string>",
"averageMonthlyVolume": 1000,
"highTicketAmount": 1000,
"averageTicketAmount": 1000,
"annualRevenue": 1000,
"mccid": "<string>",
"binPerson": 60,
"binPhone": 20,
"binWeb": 20,
"boardingStatus": 123,
"boardingSubStatus": 123,
"templateId": 22,
"boardingLinkId": 91,
"logo": {
"ftype": "pdf",
"filename": "my-doc.pdf",
"furl": "https://mysite.com/my-doc.pdf",
"fContent": "TXkgdGVzdCBmaWxlHJ==..."
},
"documentsRef": {
"zipfile": "zx45.zip",
"filelist": [
{
"originalName": "<string>",
"zipName": "<string>"
}
]
},
"contactData": [
{
"contactName": "Herman Martinez",
"contactEmail": "example@email.com",
"contactTitle": "Owner",
"contactPhone": "3055550000"
}
],
"ownerData": [
{
"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"
}
],
"serviceData": {
"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
}
},
"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
}
],
"createdAt": "2022-07-01 15:00:01",
"lastModified": "2022-07-01 15:00:01",
"builderData": {
"business": {
"details": {
"dbaname": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"legalname": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"btype": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"website": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ein": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"taxfillname": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"license": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"licstate": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"startdate": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"phonenumber": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"faxnumber": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
},
"address": {
"baddress": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"baddress1": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"bcity": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"bstate": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"bzip": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"bcountry": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"maddress": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"maddress1": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"mcity": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"mstate": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"mzip": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"mcountry": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
}
},
"owners": {
"own_list": {
"ownername": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownertitle": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownerpercent": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownerssn": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownerdob": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownerphone1": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownerphone2": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"owneremail": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownerdriver": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"odriverstate": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"oaddress": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ostate": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ocountry": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ocity": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ozip": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
},
"contact_list": {
"contactName": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"contactTitle": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"contactEmail": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"contactPhone": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
}
},
"processing": {
"mcc": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"bsummary": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"whenCharged": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"whenProvided": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"whenDelivered": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"whenRefunded": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"binperson": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"binphone": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"binweb": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"avgmonthly": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ticketamt": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"highticketamt": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
},
"services": {
"card": {
"acceptance": {
"visa": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"mastercard": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"discover": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"amex": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
},
"price": {
"header": {
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
},
"body": [
{
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
}
]
},
"fees": {
"header": {
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
},
"body": [
{
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
}
]
}
},
"ach": {
"acceptance": {
"web": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ppd": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ccd": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
},
"price": {
"header": {
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
},
"body": [
{
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
}
]
},
"fees": {
"header": {
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
},
"body": [
{
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
}
]
}
}
},
"banking": {
"depositAccount": {
"bankName": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"routingAccount": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"accountNumber": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"typeAccount": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
},
"withdrawalAccount": {
"bankName": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"routingAccount": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"accountNumber": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"typeAccount": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
}
},
"attributes": {
"multipleOwners": true,
"multipleContacts": true,
"minimumDocuments": 123
}
},
"signer": {
"signerUuid": "54455d5d-34ff-416c-91e0-5bc87199999",
"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,
"signedDocumentReference": null
},
"generalEvents": [
{
"description": "TransferCreated",
"eventTime": "2023-07-05T22:31:06.8317486+00:00",
"refData": "<string>",
"extraData": {},
"source": "api"
}
],
"pageidentifier": "null",
"recipientEmailNotification": true,
"resumable": false,
"externalPaypointId": "Paypoint-100"
}
]
}You must remove parameters= from the request before you send it, otherwise Payabli will ignore the filters.
Because of a technical limitation, you can’t make a request that includes filters from the API console on this page. The response won’t be filtered. Instead, copy the request, remove parameters= and run the request in a different client.
For example:
should become:
—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
The numeric identifier for organization, assigned by Payabli.
123
Query Parameters
Collection of field names, conditions, and values used to filter the query
See Filters and Conditions Reference for help.
List of field names accepted:
- createdAt (gt, ge, lt, le, eq, ne)
- startDate (gt, ge, lt, le, eq, ne)
- dbaname (ct, nct)
- legalname (ct, nct)
- ein (ct, nct)
- address (ct, nct)
- city (ct, nct)
- state (ct, nct)
- phone (ct, nct)
- mcc (ct, nct)
- owntype (ct, nct)
- ownerName (ct, nct)
- contactName (ct, nct)
- status (in, nin, eq,ne)
- orgParentname (ct, nct)
- externalpaypointID (ct, nct, eq, ne)
List of comparison accepted - enclosed between parentheses:
- eq or empty => equal
- gt => greater than
- ge => greater or equal
- lt => less than
- le => less or equal
- ne => not equal
- ct => contains
- nct => not contains
- in => inside array
- nin => not inside array
Max number of records to return for the query. Use 0 or negative value to return all records.
0
The number of records to skip before starting to collect the result set.
251
The field name to use for sorting results. Use desc(field_name) to sort descending by field_name, and use asc(field_name) to sort ascending by field_name.
"desc(field_name)"
Response
Total number of records in response.
2
Total amount for the records.
77.22
Total net amount for the records.
77.22
Total number of records in response.
2
Number of records on each response page.
20
Auxiliary validation used internally by payment pages and components.
null
Boarding application ID.
352
Organization ID. Unique identifier assigned to an org by Payabli.
123
The name of the parent organization.
"PropertyManager Pro"
The alternate or common name that this business is doing business under usually referred to as a DBA name.
"Sunshine Gutters"
Business legal name.
"Sunshine Services, LLC"
Business EIN or tax ID. This value is masked in API responses, for example XXXX6789.
"123456789"
Business name in tax document. This is only relevant if a government entity has given you an alternative name to file tax documents with.
"Sunshine LLC"
Describes when customers are charged for goods or services. Accepted values:
When Service Provided, In Advance "When Service Provided"
Describes when goods or services are provided, from time of transaction.
30 Days or Less, 31 to 60 Days, 60+ Days "30 Days or Less"
When goods and services are delivered.
0-7 Days, 8-14 Days, 15-30 Days, Over 30 Days "Over 30 Days"
Describes the business refund policy.
Exchange Only, No Refund or Exchange, More than 30 days, 30 Days or Less "30 Days or Less"
Business license issuing state or province.
"CA"
Business license ID or state ID number.
"2222222FFG"
Business address.
"123 Walnut Street"
Business address additional line.
"Suite 103"
Business city
"New Vegas"
Business ZIP.
"33000"
Business state.
"FL"
Business country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference
"US"
The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: www.example.com is acceptable.
"www.example.com"
Business phone number.
"5551234567"
A summary of what the business sells in terms of goods or services.
"Brick and mortar store that sells office supplies"
The business's fax number.
"5551234567"
The business's mailing address.
"123 Walnut Street"
Additional line for the business's mailing address.
"STE 900"
The business's mailing address state.
"TN"
Business mailing ZIP.
"37615"
The business's mailing address state.
"TN"
Business mailing country.
"US"
Business start date.
Accepted formats:
- YYYY-MM-DD
- MM/DD/YYYY
"01/01/1990"
The business ownership type.
Limited Liability Company, Non-Profit Org, Partnership, Private Corp, Public Corp, Tax Exempt, Government, Sole Proprietor "Limited Liability Company"
Average total amount of transactions in your local currency that are processed each month.
1000
High ticket amount.
1000
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.
1000
Annual revenue amount.
1000
Numeric percent of volume processed in person. To pass validation, binperson, binweb, and binphone must total 100 together.
60
Numeric percent of volume processed by phone. To pass validation, binperson, binweb, and binphone must total 100 together.
20
Numeric percent of volume processed on web. To pass validation, binperson, binweb, and binphone must total 100 together.
20
The application's status in the merchant boarding process. See Boarding Status Reference for more.
The application's status in the merchant boarding process. See Boarding Status Reference for more.
The associated boarding template's ID in Payabli.
22
The boarding link ID. Can be found at the end of the boarding link reference name. The boarding link reference name. For example https://boarding.payabli.com/boarding/app/myorgaccountname-00091. The ID is 91.
91
Object containing logo file.
The MIME type of the file (if content is provided)
pdf, doc, docx, jpg, jpeg, png, gif, txt "pdf"
The name of the attached file.
"my-doc.pdf"
Optional url provided to show or download the file remotely
"https://mysite.com/my-doc.pdf"
Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB.
"TXkgdGVzdCBmaWxlHJ==..."
Zip file containing attachments.
"zx45.zip"
Array of objects describing files contained in zip file.
List of contacts.
Contact name.
"Herman Martinez"
Contact email address.
320"example@email.com"
Contact title.
"Owner"
Contact phone number.
"3055550000"
List of Owners with at least a 25% ownership.
Person who is registered as the beneficial owner of the business. This is a combination of first and last name.
"John Smith"
The job title of the person such as CEO or director.
"CEO"
Percentage of ownership the person holds, in integer format.
25
The relevant identifier for the person such as a Social Security Number.
"123456789"
Owner's date of birth.
"01/01/1990"
Owner phone 1.
"555888111"
Owner phone 2.
"555888111"
Owner email.
320"example@email.com"
Owner driver's License. Payabli strongly recommends including this.
"CA6677778"
Owner driver's license State. Payabli strongly recommends including this.
"CA"
Owner street address.
"33 North St"
Owner address state.
"CA"
Owner address country in ISO-3166-1 alpha 2 format
Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference
"US"
Owner address city.
"Any City"
Owner address ZIP.
"55555"
Controls which services will be enabled for the merchant.
Determines whether Visa is accepted.
true
Determines whether Mastercard is accepted.
true
Determines whether Discover is accepted.
false
Determines whether American Express is accepted.
true
Web is an ACH SEC Code that can be used in ACH transactions by the user that indicates the transaction is a Internet Initiated/Mobile Entry Options are true and false.
true
PPD is an ACH SEC Code that can be used in ACH transactions by the user that indicates the transaction is a Prearranged Payment and Deposit.
false
CCD is an ACH SEC Code that can be used in ACH transactions by the user that indicates the transaction is a Corporate Credit or Debit Entry. Options are: true and false
false
Enables or disables ACH payout functionality
Enables or disables check printing payout functionality
Enables or disables vCard payout functionality
Payment processor identifier
"tysys"
Region where payment processing occurs
US, CA "US"
Reference ID for the program enabled for ODP issuance
123456
Information about associated bank accounts.
Object that contains bank account details.
The bank's ID in Payabli.
User-defined name for the bank account.
"Business Checking 1234"
Name of bank for account.
"Country Bank"
Routing number of bank account.
"123123123"
Masked account number for bank account.
"1XXXXXX3123"
Type of bank account: Checking or Savings.
Checking, Savings "Checking"
The accountholder's name.
"Gruzya Adventure Outfitters LLC"
Describes whether the bank is a personal or business account.
Personal, Business "Business"
Indicates the function of the bank account:
- 0 - Deposits
- 1 - Withdrawals
- 2 - Deposits & Withdrawals
- 3 - Remittances
- 4 - Remittances & Deposits
- 5 - Remittances & Withdrawals
- 6 - Remittances & Withdrawals & Deposits
A paypoint is required to have a single deposit and withdrawal account. A Paypoint can have as many remittance accounts as needed for pay outs (remittances).
0, 1, 2, 3, 4, 5, 6 0
Timestamp of when record was created, in UTC.
"2022-07-01 15:00:01"
Timestamp of when record was last updated, in UTC.
"2022-07-01 15:00:01"
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
false
When true, the element is required.
true
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
false
When true, the element is required.
true
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
false
When true, the element is required.
true
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
false
When true, the element is required.
true
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
false
When true, the element is required.
true
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
false
When true, the element is required.
true
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
false
When true, the element is required.
true
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
false
When true, the element is required.
true
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
false
When true, the element is required.
true
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
false
When true, the element is required.
true
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
false
When true, the element is required.
true
The type of validation applied to the field. Available values:
- text
- alpha
- ein
- url
- phone
- alphanumeric
- zipcode
- numbers
- float
- ssn
- routing
When true, the element is read-only.
false
When true, the element is required.
true
Information about the application's signer.
The signer's ID. This is automatically generated by Payabli.
"54455d5d-34ff-416c-91e0-5bc87199999"
The signer's name.
"John Smith"
The signer's SSN.
"123456789"
The signer's date of birth.
"01/01/1990"
The signer's phone number.
"555888111"
The signer's email address.
320"example@email.com"
The signer's address.
"33 North St"
Additional line for the signer's address.
"STE 900"
The signer's state.
"TN"
The signer's country in ISO-3166-1 alpha 2 format. \r\nCheck out https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
"US"
The signer's city.
"Bristol"
The signer's zip code.
"55555"
The signer's acceptance status. A true or false indicating an acceptance to the terms of service with the root org or provider.
false
Reference to the signed document.
null
Events associated with the application.
Event description.
"TransferCreated"
Event timestamp, in UTC.
"2023-07-05T22:31:06.8317486+00:00"
Reference data.
Extra data.
The event source.
100"api"
Auxiliary validation used internally by payment pages and components.
null
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.
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.
false
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.
"Paypoint-100"
Was this page helpful?
curl --request GET \
--url https://api-sandbox.payabli.com/api/Query/boarding/{orgId} \
--header 'requestToken: <api-key>'{
"Summary": {
"totalRecords": 2,
"totalAmount": 77.22,
"totalNetAmount": 77.22,
"totalPages": 2,
"pageSize": 20,
"pageIdentifier": "null"
},
"Records": [
{
"idApplication": 352,
"orgId": 123,
"orgParentName": "PropertyManager Pro",
"dbaName": "Sunshine Gutters",
"legalName": "Sunshine Services, LLC",
"ein": "123456789",
"taxfillname": "Sunshine LLC",
"whencharged": "When Service Provided",
"whenProvided": "30 Days or Less",
"whendelivered": "Over 30 Days",
"whenrefund": "30 Days or Less",
"licenseState": "CA",
"license": "2222222FFG",
"bAddress1": "123 Walnut Street",
"bAddress2": "Suite 103",
"bCity": "New Vegas",
"bZip": "33000",
"bState": "FL",
"bCountry": "US",
"websiteAddress": "www.example.com",
"bPhone": "5551234567",
"bSummary": "Brick and mortar store that sells office supplies",
"bFax": "5551234567",
"mAddress1": "123 Walnut Street",
"mAddress2": "STE 900",
"mCity": "TN",
"mZip": "37615",
"mState": "TN",
"mCountry": "US",
"bStartdate": "01/01/1990",
"ownType": "Limited Liability Company",
"salesCode": "<string>",
"averageMonthlyVolume": 1000,
"highTicketAmount": 1000,
"averageTicketAmount": 1000,
"annualRevenue": 1000,
"mccid": "<string>",
"binPerson": 60,
"binPhone": 20,
"binWeb": 20,
"boardingStatus": 123,
"boardingSubStatus": 123,
"templateId": 22,
"boardingLinkId": 91,
"logo": {
"ftype": "pdf",
"filename": "my-doc.pdf",
"furl": "https://mysite.com/my-doc.pdf",
"fContent": "TXkgdGVzdCBmaWxlHJ==..."
},
"documentsRef": {
"zipfile": "zx45.zip",
"filelist": [
{
"originalName": "<string>",
"zipName": "<string>"
}
]
},
"contactData": [
{
"contactName": "Herman Martinez",
"contactEmail": "example@email.com",
"contactTitle": "Owner",
"contactPhone": "3055550000"
}
],
"ownerData": [
{
"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"
}
],
"serviceData": {
"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
}
},
"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
}
],
"createdAt": "2022-07-01 15:00:01",
"lastModified": "2022-07-01 15:00:01",
"builderData": {
"business": {
"details": {
"dbaname": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"legalname": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"btype": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"website": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ein": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"taxfillname": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"license": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"licstate": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"startdate": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"phonenumber": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"faxnumber": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
},
"address": {
"baddress": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"baddress1": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"bcity": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"bstate": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"bzip": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"bcountry": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"maddress": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"maddress1": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"mcity": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"mstate": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"mzip": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"mcountry": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
}
},
"owners": {
"own_list": {
"ownername": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownertitle": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownerpercent": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownerssn": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownerdob": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownerphone1": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownerphone2": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"owneremail": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ownerdriver": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"odriverstate": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"oaddress": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ostate": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ocountry": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ocity": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ozip": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
},
"contact_list": {
"contactName": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"contactTitle": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"contactEmail": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"contactPhone": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
}
},
"processing": {
"mcc": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"bsummary": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"whenCharged": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"whenProvided": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"whenDelivered": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"whenRefunded": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"binperson": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"binphone": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"binweb": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"avgmonthly": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ticketamt": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"highticketamt": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
},
"services": {
"card": {
"acceptance": {
"visa": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"mastercard": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"discover": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"amex": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
},
"price": {
"header": {
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
},
"body": [
{
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
}
]
},
"fees": {
"header": {
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
},
"body": [
{
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
}
]
}
},
"ach": {
"acceptance": {
"web": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ppd": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"ccd": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
},
"price": {
"header": {
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
},
"body": [
{
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
}
]
},
"fees": {
"header": {
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
},
"body": [
{
"columns": [
{
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
]
}
]
}
}
},
"banking": {
"depositAccount": {
"bankName": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"routingAccount": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"accountNumber": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"typeAccount": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
},
"withdrawalAccount": {
"bankName": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"routingAccount": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"accountNumber": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
},
"typeAccount": {
"value": "<string>",
"validator": "<string>",
"ro": false,
"rq": true
}
}
},
"attributes": {
"multipleOwners": true,
"multipleContacts": true,
"minimumDocuments": 123
}
},
"signer": {
"signerUuid": "54455d5d-34ff-416c-91e0-5bc87199999",
"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,
"signedDocumentReference": null
},
"generalEvents": [
{
"description": "TransferCreated",
"eventTime": "2023-07-05T22:31:06.8317486+00:00",
"refData": "<string>",
"extraData": {},
"source": "api"
}
],
"pageidentifier": "null",
"recipientEmailNotification": true,
"resumable": false,
"externalPaypointId": "Paypoint-100"
}
]
}