GET
/
Boarding
/
read
/
{appId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Boarding/read/{appId} \
  --header 'requestToken: <api-key>'
{
  "idApplication": 325,
  "orgId": 123,
  "orgParentName": "PropertyManager Pro",
  "dbaName": "Sunshine Gutters",
  "legalName": "Sunshine Services, LLC",
  "ein": "XXXX6789",
  "taxfillname": "Sunshine LLC",
  "whencharged": "When Service Provided",
  "whenProvided": "30 Days or Less",
  "whendelivered": "Over 30 Days",
  "whenrefund": "<string>",
  "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": "<string>",
  "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": "<any>",
  "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": "herman@hermanscoatings.com",
      "contactTitle": "Owner",
      "contactPhone": "3055550000"
    }
  ],
  "ownerData": [
    {
      "ownername": "John Smith",
      "ownertitle": "CEO",
      "ownerpercent": 25,
      "ownerssn": "123456789",
      "ownerdob": "01/01/1990",
      "ownerphone1": "555888111",
      "ownerphone2": "555888111",
      "owneremail": "test@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": true,
      "acceptAmex": true
    },
    "ach": {
      "acceptWeb": true,
      "acceptPPD": true,
      "acceptCCD": true
    }
  },
  "bankData": [
    {
      "id": 123,
      "nickname": "Withdrawal Account",
      "bankName": "Test Bank",
      "routingAccount": "123123123",
      "accountNumber": "123123123",
      "typeAccount": "Checking",
      "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
      "bankAccountHolderType": "Business",
      "bankAccountFunction": 1
    }
  ],
  "createdAt": "2022-07-01 15:00:01",
  "lastModified": "2022-07-01 15:00:01",
  "builderData": {
    "business": {
      "details": {
        "dbaname": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "legalname": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "btype": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "website": {
          "value": "<string>",
          "validator": "url",
          "ro": false,
          "rq": null
        },
        "ein": {
          "value": "<string>",
          "validator": "routing",
          "ro": false,
          "rq": null
        },
        "taxfillname": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "license": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "licstate": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "startdate": {
          "value": "2021-12-13T05:00:00.000Z",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "phonenumber": {
          "value": "<string>",
          "validator": "phone",
          "ro": false,
          "rq": null
        },
        "faxnumber": {
          "value": "<string>",
          "validator": "phone",
          "ro": false,
          "rq": null
        }
      },
      "address": {
        "baddress": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "baddress1": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "bcity": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "bstate": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "bzip": {
          "value": "<string>",
          "validator": "zipcode",
          "ro": false,
          "rq": null
        },
        "bcountry": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "maddress": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "maddress1": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "mcity": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "mstate": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "mzip": {
          "value": "<string>",
          "validator": "zipcode",
          "ro": false,
          "rq": null
        },
        "mcountry": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        }
      }
    },
    "owners": {
      "own_list": {
        "ownername": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "ownertitle": {
          "value": "<string>",
          "validator": "alpha",
          "ro": false,
          "rq": null
        },
        "ownerpercent": {
          "value": "<string>",
          "validator": "number",
          "ro": false,
          "rq": null
        },
        "ownerssn": {
          "value": "<string>",
          "validator": "routing",
          "ro": false,
          "rq": null
        },
        "ownerdob": {
          "value": "2003-06-05T04:00:00.000Z",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "ownerphone1": {
          "value": "<string>",
          "validator": "phone",
          "ro": false,
          "rq": null
        },
        "ownerphone2": {
          "value": "<string>",
          "validator": "phone",
          "ro": false,
          "rq": null
        },
        "owneremail": {
          "value": "<string>",
          "validator": "email",
          "ro": false,
          "rq": null
        },
        "ownerdriver": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "odriverstate": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "oaddress": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "ostate": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "ocountry": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "ocity": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "ozip": {
          "value": "<string>",
          "validator": "zipcode",
          "ro": false,
          "rq": null
        }
      },
      "contact_list": {
        "contactName": {
          "value": "<string>",
          "validator": "alphanumeric",
          "ro": false,
          "rq": null
        },
        "contactTitle": {
          "value": "<string>",
          "validator": "alpha",
          "ro": false,
          "rq": null
        },
        "contactEmail": {
          "value": "<string>",
          "validator": "email",
          "ro": false,
          "rq": null
        },
        "contactPhone": {
          "value": "<string>",
          "validator": "phone",
          "ro": false,
          "rq": null
        }
      }
    },
    "processing": {
      "mcc": {
        "value": "<string>",
        "validator": null,
        "ro": false,
        "rq": null
      },
      "bsummary": {
        "value": "<string>",
        "validator": "text",
        "ro": false,
        "rq": null
      },
      "whenCharged": {
        "value": "<string>",
        "validator": null,
        "ro": false,
        "rq": null
      },
      "whenProvided": {
        "value": "<string>",
        "validator": null,
        "ro": false,
        "rq": null
      },
      "whenDelivered": {
        "value": "<string>",
        "validator": null,
        "ro": false,
        "rq": null
      },
      "whenRefunded": {
        "value": "<string>",
        "validator": null,
        "ro": false,
        "rq": null
      },
      "binperson": {
        "value": "<string>",
        "validator": null,
        "ro": false,
        "rq": null
      },
      "binphone": {
        "value": "<string>",
        "validator": null,
        "ro": false,
        "rq": null
      },
      "binweb": {
        "value": "<string>",
        "validator": null,
        "ro": false,
        "rq": null
      },
      "avgmonthly": {
        "value": "<string>",
        "validator": "numbers",
        "ro": false,
        "rq": null
      },
      "ticketamt": {
        "value": "<string>",
        "validator": "numbers",
        "ro": false,
        "rq": null
      },
      "highticketamt": {
        "value": "<string>",
        "validator": "numbers",
        "ro": false,
        "rq": null
      }
    },
    "services": {
      "card": {
        "acceptance": {
          "visa": {
            "value": "<string>",
            "validator": null,
            "ro": false,
            "rq": null
          },
          "mastercard": {
            "value": "<string>",
            "validator": null,
            "ro": false,
            "rq": null
          },
          "discover": {
            "value": "<string>",
            "validator": null,
            "ro": false,
            "rq": null
          },
          "amex": {
            "value": "<string>",
            "validator": null,
            "ro": false,
            "rq": null
          }
        },
        "price": {
          "header": {
            "columns": [
              {
                "value": "<string>",
                "validator": null,
                "ro": null,
                "rq": null
              }
            ]
          },
          "body": [
            {
              "columns": [
                {
                  "value": "<string>",
                  "validator": null,
                  "ro": null,
                  "rq": null
                }
              ]
            }
          ]
        },
        "fees": {
          "header": {
            "columns": [
              {
                "value": "<string>",
                "validator": null,
                "ro": null,
                "rq": null
              }
            ]
          },
          "body": [
            {
              "columns": [
                {
                  "value": "<string>",
                  "validator": null,
                  "ro": null,
                  "rq": null
                }
              ]
            }
          ]
        }
      },
      "ach": {
        "acceptance": {
          "web": {
            "value": "<string>",
            "validator": null,
            "ro": false,
            "rq": null
          },
          "ppd": {
            "value": "<string>",
            "validator": null,
            "ro": false,
            "rq": null
          },
          "ccd": {
            "value": "<string>",
            "validator": null,
            "ro": false,
            "rq": null
          }
        },
        "price": {
          "header": {
            "columns": [
              {
                "value": "<string>",
                "validator": null,
                "ro": null,
                "rq": null
              }
            ]
          },
          "body": [
            {
              "columns": [
                {
                  "value": "<string>",
                  "validator": null,
                  "ro": null,
                  "rq": null
                }
              ]
            }
          ]
        },
        "fees": {
          "header": {
            "columns": [
              {
                "value": "<string>",
                "validator": null,
                "ro": null,
                "rq": null
              }
            ]
          },
          "body": [
            {
              "columns": [
                {
                  "value": "<string>",
                  "validator": null,
                  "ro": null,
                  "rq": null
                }
              ]
            }
          ]
        }
      }
    },
    "banking": {
      "depositAccount": {
        "bankName": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "routingAccount": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "accountNumber": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "typeAccount": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        }
      },
      "withdrawalAccount": {
        "bankName": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "routingAccount": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "accountNumber": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        },
        "typeAccount": {
          "value": "<string>",
          "validator": null,
          "ro": false,
          "rq": null
        }
      }
    },
    "attributes": {
      "multipleOwners": true,
      "multipleContacts": true,
      "minimumDocuments": 1
    }
  },
  "signer": {
    "signerUuid": "54455d5d-34ff-416c-91e0-5bc87199999",
    "name": "John Smith",
    "ssn": "123456789",
    "dob": "01/01/1990",
    "phone": "555888111",
    "email": "test@email.com",
    "address": "33 North St",
    "address1": "STE 900",
    "state": "TN",
    "country": "US",
    "city": "Bristol",
    "zip": "55555",
    "acceptance": "<string>",
    "signedDocumentReference": "<string>"
  },
  "generalEvents": [
    {
      "description": "Created",
      "eventTime": "2022-06-17T16:35:21.1539528+00:00",
      "refData": null,
      "extraData": null,
      "source": null
    },
    {
      "description": "Updated Status",
      "eventTime": "2022-06-17T16:35:22.0854265+00:00",
      "refData": "1",
      "extraData": null,
      "source": null
    }
  ],
  "messages": [
    {
      "id": 261,
      "roomId": 6,
      "userId": 104,
      "userName": "admin",
      "content": "Requested business license and bank statements.",
      "createdAt": "2023-10-30T19:37:20.997",
      "messageType": 1,
      "originalApplicationStatus": -99,
      "currentApplicationStatus": 3,
      "originalApplicationSubStatus": 0,
      "currentApplicationSubStatus": 2
    },
    {
      "id": 231,
      "roomId": 6,
      "userId": 104,
      "userName": "admin",
      "content": "TIN Failed, Need to reach out to merchant",
      "createdAt": "2023-10-25T18:41:55.94",
      "messageType": 1,
      "originalApplicationStatus": -99,
      "currentApplicationStatus": 3,
      "originalApplicationSubStatus": 0,
      "currentApplicationSubStatus": 3
    },
    {
      "id": 3,
      "roomId": 6,
      "userId": 5,
      "userName": "admin",
      "content": "Application approved, finalizing agreement.",
      "createdAt": "2023-09-09T00:00:00",
      "messageType": 1,
      "originalApplicationStatus": -99,
      "currentApplicationStatus": 7,
      "originalApplicationSubStatus": 0,
      "currentApplicationSubStatus": 5
    }
  ],
  "pageidentifier": "<string>",
  "recipientEmailNotification": true,
  "resumable": true
}

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
appId
integer
required

Boarding application ID.

Example:

352

Response

200 - application/json
Success
​
idApplication
integer

Boarding application ID.

Example:

352

​
orgId
integer | null

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

Example:

123

​
orgParentName
string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

​
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"

​
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"

​
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"

​
whenrefund
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"

​
licenseState
string | null

Business license issuing state or province.

Example:

"CA"

​
license
string | null

Business license ID or state ID number.

Example:

"2222222FFG"

​
bAddress1
string | null

Business address.

Example:

"123 Walnut Street"

​
bAddress2
string | null

Business address additional line.

Example:

"Suite 103"

​
bCity
string | null

Business city

Example:

"New Vegas"

​
bZip
string | null

Business ZIP.

Example:

"33000"

​
bState
string | null

Business state.

Example:

"FL"

​
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"

​
websiteAddress
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"

​
bPhone
string | null

Business phone number.

Example:

"5551234567"

​
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"

​
bFax
string | null

The business's fax number.

Example:

"5551234567"

​
mAddress1
string | null

The business's mailing address.

Example:

"123 Walnut Street"

​
mAddress2
string | null

Additional line for the business's mailing address.

Example:

"STE 900"

​
mCity
string | null

The business's mailing address state.

Example:

"TN"

​
mZip
string | null

Business mailing ZIP.

Example:

"37615"

​
mState
string | null

The business's mailing address state.

Example:

"TN"

​
mCountry
string | null

Business mailing country.

Example:

"US"

​
bStartdate
string | null

Business start date.
Accepted formats:

  • YYYY-MM-DD
  • MM/DD/YYYY
Example:

"01/01/1990"

​
ownType
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"

​
salesCode
string | null
​
averageMonthlyVolume
number | null

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

Example:

1000

​
highTicketAmount
number | null

High ticket amount.

Example:

1000

​
averageTicketAmount
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

​
annualRevenue
number | null

Annual revenue amount.

Example:

1000

​
mccid
string | null
​
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

​
boardingStatus
integer

The application's status in the merchant boarding process. See Boarding Status Reference for more.

​
boardingSubStatus
integer

The application's status in the merchant boarding process. See Boarding Status Reference for more.

​
templateId
integer | null

The associated boarding template's ID in Payabli.

Example:

22

​
boardingLinkId
integer

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.

Example:

91

Object containing logo file.

​
documentsRef
object
​
contactData
object[] | null

List of contacts.

​
ownerData
object[] | null

List of Owners with at least a 25% ownership.

​
serviceData
object

Controls which services will be enabled for the merchant.

​
bankData
object[] | null

Information about associated bank accounts.

Object that contains bank account details.

​
createdAt
string

Timestamp of when record was created, in UTC.

Example:

"2022-07-01 15:00:01"

​
lastModified
string | null

Timestamp of when record was last updated, in UTC.

Example:

"2022-07-01 15:00:01"

​
builderData
object
​
signer
object

Information about the application's signer.

​
generalEvents
object[] | null

Events associated with the application.

​
pageidentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

​
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

​
messages
object[]

Was this page helpful?