> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://beta-docs.payabli.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server. # Update app PUT https://api-sandbox.payabli.com/api/Boarding/app/{appId} Content-Type: application/json Updates a boarding application by ID. This endpoint requires an application API token. Reference: https://beta-docs.payabli.com/api-reference/boarding/update-boarding-application ## Authentication - `requestToken` header (required) — API Key authentication via header ## Servers - `https://api-sandbox.payabli.com/api` (Sandbox, default) - `https://api.payabli.com/api` (Production) ## Request ### Path parameters - `appId` (integer, required) — Boarding application ID. ### Body (application/json) This endpoint expects an ApplicationData. - `services` (Services, optional) — Controls which services will be enabled for the merchant. - `annualRevenue` (double, optional) — Annual revenue amount. - `attachments` (list of FileContent, optional) — Array of `fileContent` objects with attached documents. Max upload size is 30 MB. - `avgmonthly` (double, optional) — Average total amount of transactions in your local currency that are processed each month. - `baddress` (string, optional) — Business address. - `baddress1` (string, optional) — Business address additional line. - `bankData` (Bank, optional) — Object that contains bank account details. - `bcity` (string, optional) — Business city - `bcountry` (string, optional) — Business country in ISO-3166-1 alpha 2 format Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference - `binperson` (integer, optional) — Numeric percent of volume processed in person. To pass validation, `binperson`, `binweb`, and `binphone` must total 100 together. - `binphone` (integer, optional) — Numeric percent of volume processed by phone. To pass validation, `binperson`, `binweb`, and `binphone` must total 100 together. - `binweb` (integer, optional) — Numeric percent of volume processed on web. To pass validation, `binperson`, `binweb`, and `binphone` must total 100 together. - `bstate` (string, optional) — Business state. - `bsummary` (string, optional) — A summary of what the business sells in terms of goods or services. - `btype` (enum, optional) — The business ownership type. - Allowed values: `Limited Liability Company`, `Non-Profit Org`, `Partnership`, `Private Corp`, `Public Corp`, `Tax Exempt`, `Government`, `Sole Proprietor` - `bzip` (string, optional) — Business ZIP. - `contacts` (list of Contacts, optional) — List of contacts. - `dbaname` (string, optional) — The alternate or common name that this business is doing business under usually referred to as a DBA name. - `ein` (string, optional) — Business EIN or tax ID. This value is masked in API responses, for example `XXXX6789`. - `externalPaypointId` (string, optional) — 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. - `faxnumber` (string, optional) — The business's fax number. - `highticketamt` (double, optional) — High ticket amount. - `legalname` (string, optional) — Business legal name. - `license` (string, optional) — Business license ID or state ID number. - `licstate` (string, optional) — Business license issuing state or province. - `maddress` (string, optional) — The business's mailing address. - `maddress1` (string, optional) — Additional line for the business's mailing address. - `mcc` (string, optional) — Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcc_codes.csv) lists MCC codes. - `mcity` (string, optional) — The business's mail city. - `mcountry` (string, optional) — Business mailing country. - `mstate` (string, optional) — The business's mailing address state. - `mzip` (string, optional) — Business mailing ZIP. - `orgId` (long, optional) — Organization ID. Unique identifier assigned to an org by Payabli. - `ownership` (list of Owners, optional) — List of Owners with at least a 25% ownership. - `payoutAverageMonthlyVolume` (double, optional) — 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. - `payoutAverageTicketLimit` (double, optional) — 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. - `payoutCreditLimit` (double, optional) — 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. - `payoutHighTicketAmount` (double, optional) — 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. - `phonenumber` (string, optional) — The business's phone number. - `recipientEmail` (string, optional) — Email address for the applicant. This is used to send the applicant a boarding link. - `recipientEmailNotification` (boolean, optional) — 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. - `resumable` (boolean, optional) — 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. - `signer` (SignerDataRequest, optional) — Information about the application's signer. - `startdate` (string, optional) — Business start date. Accepted formats: - YYYY-MM-DD - MM/DD/YYYY - `taxfillname` (string, optional) — Business name in tax document. This is only relevant if a government entity has given you an alternative name to file tax documents with. - `templateId` (long, optional) — The associated boarding template's ID in Payabli. - `ticketamt` (double, optional) — 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. - `website` (string, optional) — The business website address. Include only the domain and TLD, do not enter the protocol (http/https). For example: `www.example.com` is acceptable. - `whenCharged` (enum, optional) — Describes when customers are charged for goods or services. Accepted values: - Allowed values: `When Service Provided`, `In Advance` - `whenDelivered` (enum, optional) — When goods and services are delivered. - Allowed values: `0-7 Days`, `8-14 Days`, `15-30 Days`, `Over 30 Days` - `whenProvided` (enum, optional) — Describes when goods or services are provided, from time of transaction. - Allowed values: `30 Days or Less`, `31 to 60 Days`, `60+ Days` - `whenRefunded` (enum, optional) — Describes the business refund policy. - Allowed values: `Exchange Only`, `No Refund or Exchange`, `More than 30 days`, `30 Days or Less` ## Response ### 200 Success - `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure. - `pageIdentifier` (string, optional) — Auxiliary validation used internally by payment pages and components. - `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/api-reference/api-responses). - `responseData` (Responsedatanonobject, optional) — The response data. - `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'. ## Errors ### 400 Bad Request Error Bad request/ invalid data - `any` ### 401 Unauthorized Error Unauthorized request. - `any` ### 500 Internal Server Error Internal API Error - `any` ### 503 Service Unavailable Error Database connection error - `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure. - `responseData` (map from string to any, optional) — The object containing the response data. - `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'. ## Types ### Services Controls which services will be enabled for the merchant. - `ach` (AchSetup, optional) - `card` (CardSetup, optional) - `odp` (OdpSetup, optional) ### FileContent Contains details about a file. See See [fileObject Object Model](/api-reference/schemas/filecontent) for a complete reference. Max upload size is 30 MB. - `fContent` (string, optional) — Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB. - `filename` (string, optional) — The name of the attached file. - `ftype` (enum, optional) — The MIME type of the file (if content is provided) - Allowed values: `pdf`, `doc`, `docx`, `jpg`, `jpeg`, `png`, `gif`, `txt` - `furl` (string, optional) — Optional url provided to show or download the file remotely ### Bank Object that contains bank account details. - `accountNumber` (string, optional) — Masked account number for bank account. - `bankAccountFunction` (integer, optional) — 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). - `bankAccountHolderName` (string, optional) — The accountholder's name. - `bankAccountHolderType` (enum, optional) — Describes whether the bank is a personal or business account. - Allowed values: `Personal`, `Business` - `bankName` (string, optional) — Name of bank for account. - `id` (integer, optional) — The bank's ID in Payabli. - `nickname` (string, optional) — User-defined name for the bank account. - `routingAccount` (string, optional) — Routing number of bank account. - `typeAccount` (enum, optional) — Type of bank account: Checking or Savings. - Allowed values: `Checking`, `Savings` ### Contacts - `contactEmail` (string, optional) — Contact email address. - `contactName` (string, optional) — Contact name. - `contactPhone` (string, optional) — Contact phone number. - `contactTitle` (string, optional) — Contact title. ### Owners - `oaddress` (string, optional) — Owner street address. - `ocity` (string, optional) — Owner address city. - `ocountry` (string, optional) — Owner address country in ISO-3166-1 alpha 2 format Check out https://en.wikipedia.org/wiki/ISO_3166-1 for reference - `odriverstate` (string, optional) — Owner driver's license State. Payabli strongly recommends including this. - `ostate` (string, optional) — Owner address state. - `ownerdob` (string, optional) — Owner's date of birth. - `ownerdriver` (string, optional) — Owner driver's License. Payabli strongly recommends including this. - `owneremail` (string, optional) — Owner email. - `ownername` (string, optional) — Person who is registered as the beneficial owner of the business. This is a combination of first and last name. - `ownerpercent` (integer, optional) — Percentage of ownership the person holds, in integer format. - `ownerphone1` (string, optional) — Owner phone 1. - `ownerphone2` (string, optional) — Owner phone 2. - `ownerssn` (string, optional) — The relevant identifier for the person such as a Social Security Number. - `ownertitle` (string, optional) — The job title of the person such as CEO or director. - `ozip` (string, optional) — Owner address ZIP. ### SignerDataRequest Information about the application's signer. - `acceptance` (boolean, optional) — The signer's acceptance status. A true or false indicating an acceptance to the terms of service with the root org or provider. - `address` (string, optional) — The signer's address. - `address1` (string, optional) — Additional line for the signer's address. - `city` (string, optional) — The signer's city. - `country` (string, optional) — The signer's country in ISO-3166-1 alpha 2 format. \r\nCheck out https://en.wikipedia.org/wiki/ISO_3166-1 for reference. - `dob` (string, optional) — The signer's date of birth. - `email` (string, optional) — The signer's email address. - `name` (string, optional) — The signer's name. - `phone` (string, optional) — The signer's phone number. - `ssn` (string, optional) — The signer's SSN. - `state` (string, optional) — The signer's state. - `zip` (string, optional) — The signer's zip code. ### Responsedatanonobject The response data. ### AchSetup - `acceptCCD` (boolean, optional) — 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` - `acceptPPD` (boolean, optional) — 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. - `acceptWeb` (boolean, optional) — 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`. ### CardSetup - `acceptAmex` (boolean, optional) — Determines whether American Express is accepted. - `acceptDiscover` (boolean, optional) — Determines whether Discover is accepted. - `acceptMastercard` (boolean, optional) — Determines whether Mastercard is accepted. - `acceptVisa` (boolean, optional) — Determines whether Visa is accepted. ### OdpSetup - `allowAch` (boolean, optional) — Enables or disables ACH payout functionality - `allowChecks` (boolean, optional) — Enables or disables check printing payout functionality - `allowVCard` (boolean, optional) — Enables or disables vCard payout functionality - `processing_region` (enum, optional) — Region where payment processing occurs - Allowed values: `US`, `CA` - `processor` (string, optional) — Payment processor identifier - `programId` (string, optional) — Reference ID for the program enabled for ODP issuance ## Examples **Request** ```json {} ``` **Response** ```json { "isSuccess": true, "responseCode": 1, "responseData": 3625, "responseText": "Success" } ``` **SDK Code** ```python General success response example for some boarding operations. import requests url = "https://api-sandbox.payabli.com/api/Boarding/app/352" payload = {} headers = { "requestToken": "", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript General success response example for some boarding operations. const url = 'https://api-sandbox.payabli.com/api/Boarding/app/352'; const options = { method: 'PUT', headers: {requestToken: '', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go General success response example for some boarding operations. package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Boarding/app/352" payload := strings.NewReader("{}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("requestToken", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby General success response example for some boarding operations. require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Boarding/app/352") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["requestToken"] = '' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java General success response example for some boarding operations. import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://api-sandbox.payabli.com/api/Boarding/app/352") .header("requestToken", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php General success response example for some boarding operations. request('PUT', 'https://api-sandbox.payabli.com/api/Boarding/app/352', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```csharp General success response example for some boarding operations. using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/Boarding/app/352"); var request = new RestRequest(Method.PUT); request.AddHeader("requestToken", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift General success response example for some boarding operations. import Foundation let headers = [ "requestToken": "", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Boarding/app/352")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```