Create merchant application

Deprecated

POST

/Boarding/app

POST

/api/Boarding/app

curl -X POST https://api-sandbox.payabli.com/api/Boarding/app \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "annualRevenue": 1000,
  "averageBillSize": "500",
  "averageMonthlyBill": "5650",
  "avgmonthly": 1000,
  "baddress": "123 Walnut Street",
  "baddress1": "Suite 103",
  "bankData": [
    {
      "accountId": "123-456",
      "accountNumber": "123123100",
      "bankAccountFunction": 1,
      "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
      "bankAccountHolderType": "Business",
      "bankName": "Test Bank 1",
      "nickname": "Withdrawal Account",
      "routingAccount": "123123123",
      "typeAccount": "Checking"
    },
    {
      "accountId": "123-789",
      "accountNumber": "123123200",
      "bankAccountFunction": 0,
      "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
      "bankAccountHolderType": "Business",
      "bankName": "Test Bank 2",
      "nickname": "Deposit Account",
      "routingAccount": "321321321",
      "typeAccount": "Checking"
    }
  ],
  "bcity": "New Vegas",
  "bcountry": "US",
  "binperson": 60,
  "binphone": 20,
  "binweb": 20,
  "bstate": "FL",
  "bsummary": "Brick and mortar store that sells office supplies",
  "btype": "Limited Liability Company",
  "bzip": "33000",
  "contacts": [
    {
      "contactEmail": "herman@hermanscoatings.com",
      "contactName": "Herman Martinez",
      "contactPhone": "3055550000",
      "contactTitle": "Owner"
    }
  ],
  "creditLimit": "creditLimit",
  "dbaName": "Sunshine Gutters",
  "ein": "123456789",
  "faxnumber": "1234567890",
  "highticketamt": 1000,
  "legalName": "Sunshine Services, LLC",
  "license": "2222222FFG",
  "licstate": "CA",
  "maddress": "123 Walnut Street",
  "maddress1": "STE 900",
  "mcc": "7777",
  "mcity": "Johnson City",
  "mcountry": "US",
  "mstate": "TN",
  "mzip": "37615",
  "orgId": 123,
  "ownership": [
    {
      "oaddress": "33 North St",
      "ocity": "Any City",
      "ocountry": "US",
      "odriverstate": "CA",
      "ostate": "CA",
      "ownerdob": "01/01/1990",
      "ownerdriver": "CA6677778",
      "owneremail": "test@email.com",
      "ownername": "John Smith",
      "ownerpercent": 100,
      "ownerphone1": "555888111",
      "ownerphone2": "555888111",
      "ownerssn": "123456789",
      "ownertitle": "CEO",
      "ozip": "55555"
    }
  ],
  "phonenumber": "1234567890",
  "processingRegion": "US",
  "recipientEmail": "josephray@example.com",
  "recipientEmailNotification": true,
  "resumable": true,
  "services": {
    "ach": {},
    "card": {
      "acceptAmex": true,
      "acceptDiscover": true,
      "acceptMastercard": true,
      "acceptVisa": true
    }
  },
  "signer": {
    "additionalData": {
      "deviceId": "499585-389fj484-3jcj8hj3",
      "session": "fifji4-fiu443-fn4843",
      "timeWithCompany": "6 Years"
    },
    "address": "33 North St",
    "address1": "STE 900",
    "attestationDate": "04/20/2025",
    "city": "Bristol",
    "country": "US",
    "dob": "01/01/1976",
    "email": "test@email.com",
    "name": "John Smith",
    "pciAttestation": true,
    "phone": "555888111",
    "signDate": "04/20/2025",
    "signedDocumentReference": "https://example.com/signed-document.pdf",
    "ssn": "123456789",
    "state": "TN",
    "zip": "55555"
  },
  "startdate": "01/01/1990",
  "taxFillName": "Sunshine LLC",
  "templateId": 22,
  "ticketamt": 1000,
  "website": "www.example.com",
  "whenCharged": "When Service Provided",
  "whenDelivered": "Over 30 Days",
  "whenProvided": "30 Days or Less",
  "whenRefunded": "30 Days or Less"
}'

{
  "responseText": "Success",
  "responseCode": 1,
  "isSuccess": true,
  "responseData": 3625
}

Legacy boarding is deprecated and will be sunset in Q2 2027. Use Create an application instead. One legacy call becomes several intelligent boarding calls, one for each record. See Map legacy calls to new endpoints.

Creates a boarding application in an organization. This endpoint requires an application API token.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Request

This endpoint expects an object.

Pay InobjectRequired

Fields for Pay In boarding applications.

Managed PayoutobjectRequired

On-Demand PayoutobjectRequired

All FieldsobjectRequired

Response

Success

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseCodeintegerOptional

Code for the response. Learn more in API Response Codes.

pageIdentifierstringOptional

Auxiliary validation used internally by payment pages and components.

roomIdlongOptional

Describes the room ID. Only in use on Boarding endpoints, returns 0 when not applicable.

isSuccessbooleanOptional

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseDatastring or integerOptional

The response data.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error