Update Boarding Application
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
Update Boarding Application
Updates a boarding application by ID. This endpoint requires an application API token.
PUT
/
Boarding
/
app
/
{appId}
curl --request PUT \
--url https://api-sandbox.payabli.com/api/Boarding/app/{appId} \
--header 'Content-Type: application/json' \
--header 'requestToken: <api-key>' \
--data '{
"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": {
"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
}
}'
{
"isSuccess": true,
"responseText": "Success",
"responseCode": 1,
"responseData": 3625,
"pageIdentifier": null
}
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
Boarding application ID.
Example:
352
Body
ApplicationData object to add.
The body is of type object
.
Response
200 - application/json
Success
The response is of type object
.
Was this page helpful?
curl --request PUT \
--url https://api-sandbox.payabli.com/api/Boarding/app/{appId} \
--header 'Content-Type: application/json' \
--header 'requestToken: <api-key>' \
--data '{
"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": {
"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
}
}'
{
"isSuccess": true,
"responseText": "Success",
"responseCode": 1,
"responseData": 3625,
"pageIdentifier": null
}