> 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 payment page PUT https://api-sandbox.payabli.com/api/Paypoint/{entry}/{subdomain} Content-Type: application/json Updates a payment page in a paypoint. Reference: https://beta-docs.payabli.com/api-reference/hostedpaymentpages/update-a-payment-page ## 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 - `entry` (string, required) — The paypoint's entrypoint identifier. [Learn more](/api-reference/api-overview#entrypoint-vs-entry) - `subdomain` (string, required) — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`. ### Body (application/json) This endpoint expects a PayabliPages. - `AdditionalData` (map from string to map from string to any, optional) — Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](/developer-guides/entities-custom-identifiers), pass those in this object. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ``` - `credentials` (list of PayabliCredentials, optional) — Array of credential objects with active services for the page - `lastAccess` (datetime, optional) — Timestamp of last access to page structure - `pageContent` (PageContent, optional) — Sections of page - `pageIdentifier` (string, optional) — Auxiliary validation used internally by payment pages and components. - `pageSettings` (PageSetting, optional) — Settings of page - `published` (integer, optional) — Flag indicating if page is active to accept payments. `0` for false, `1` for true. - `receiptContent` (ReceiptContent, optional) — Sections of payment receipt - `subdomain` (string, optional) — Page identifier. Must be unique in platform. - `totalAmount` (double, optional) — Total amount to pay in this page - `validationCode` (string, optional) — Base64 encoded image of Captcha associated to this page load ## 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 ### PayabliCredentials - `accountId` (string, optional) - `cfeeFix` (double, optional) - `cfeeFloat` (double, optional) - `cfeeMax` (double, optional) - `cfeeMin` (double, optional) - `maxticket` (double, optional) - `minticket` (double, optional) - `mode` (integer, optional) - `referenceId` (long, optional) - `service` (string, optional) ### PageContent - `amount` (AmountElement, optional) — Amount section of payment page - `autopay` (AutoElement, optional) — Autopay section of payment page - `contactUs` (ContactElement, optional) — ContactUs section of payment page - `entry` (string, optional) — Identifier of entry point owner of page - `invoices` (InvoiceElement, optional) — Invoices section of payment page - `logo` (Element, optional) — Logo section of payment page - `messageBeforePaying` (LabelElement, optional) — Message section of payment page - `name` (string, optional) — Descriptor of page - `notes` (NoteElement, optional) — Notes section of payment page - `page` (PageElement, optional) — Page header section of payment page - `paymentButton` (LabelElement, optional) — Payment button section of payment page - `paymentMethods` (MethodElement, optional) — Payment methods section of payment page - `payor` (PayorElement, optional) — Customer/Payor section of payment page - `review` (HeaderElement, optional) — Review section of payment page - `subdomain` (string, optional) — Unique identifier assigned to the page. ### PageSetting - `color` (string, optional) — An HTML color code in format #RRGGBB - `customCssUrl` (string, optional) — Complete URL to a custom CSS file to be loaded with the page - `language` (string, optional) — Two-letter code following ISO 639-1 - `pageLogo` (FileContent, optional) — Object containing logo file to upload/ use in page - `paymentButton` (ButtomElement, optional) - `redirectAfterApprove` (boolean, optional) — Flag indicating if the capability for redirection in the page will be activated - `redirectAfterApproveUrl` (string, optional) — Complete URL where the page will be redirected after completion ### ReceiptContent Object containing receipt body configuration - `amount` (Element, optional) — Section amount of payment receipt - `contactUs` (Element, optional) — Section contactUs of payment receipt - `details` (Element, optional) — Section payment details of payment receipt - `logo` (Element, optional) — Section logo of payment receipt - `messageBeforeButton` (LabelElement, optional) — Section message of payment receipt - `page` (PageElement, optional) — Section page of payment receipt - `paymentButton` (LabelElement, optional) — Section payment button of payment receipt - `paymentInformation` (Element, optional) — Section payment information of payment receipt - `settings` (SettingElement, optional) — The receipt's settings. ### Responsedatanonobject The response data. ### AmountElement - `categories` (list of PayCategory, optional) - `enabled` (boolean, optional) — Toggles whether the section or element is enabled. - `order` (integer, optional) — Order of element or section in container. ### AutoElement - `enabled` (boolean, optional) — Toggles whether the section or element is enabled. - `finish` (Finishtype, optional) — Type of end date - `frequency` (FrequencyList, optional) — accepted frequencies for autopay - `frequencySelected` (string, optional) — Value of pre-selected frequency - `header` (string, optional) — Header text for section - `order` (integer, optional) — Order of element or section in container. - `startDate` (string, optional) — Range of days enabled in calendar Leave empty to enable all days. ### ContactElement - `emailLabel` (string, optional) — Custom content for email - `enabled` (boolean, optional) — Toggles whether the section or element is enabled. - `header` (string, optional) — Header text for section - `order` (integer, optional) — Order of element or section in container. - `paymentIcons` (boolean, optional) — Flag indicating if icons for accepted card brands will be shown - `phoneLabel` (string, optional) — Custom content for phone number ### InvoiceElement - `enabled` (boolean, optional) — Toggles whether the section or element is enabled. - `invoiceLink` (LabelElement, optional) — Link to invoice - `order` (integer, optional) — Order of element or section in container. - `viewInvoiceDetails` (LabelElement, optional) — Link to view invoice details ### Element - `enabled` (boolean, optional) — Toggles whether the section or element is enabled. - `order` (integer, optional) — Order of element or section in container. ### LabelElement - `enabled` (boolean, optional) — Toggles whether the section or element is enabled. - `label` (string, optional) — Label to display for section or element - `order` (integer, optional) — Order of element or section in container. ### NoteElement - `enabled` (boolean, optional) — Toggles whether the section or element is enabled. - `header` (string, optional) — Header text for section - `order` (integer, optional) — Order of element or section in container. - `placeholder` (string, optional) — Placeholder text for input field - `value` (string, optional) — Pre-populated value for input field ### PageElement - `description` (string, optional) — Page description in header - `enabled` (boolean, optional) — Toggles whether the section or element is enabled. - `header` (string, optional) — Page header - `order` (integer, optional) — Order of element or section in container. ### MethodElement - `allMethodsChecked` (boolean, optional) — Flag indicating if all allowed payment methods will be pre-selected. - `enabled` (boolean, optional) — Toggles whether the section or element is enabled. - `header` (string, optional) — Header text for section - `methods` (MethodsList, optional) - `order` (integer, optional) — Order of element or section in container. - `settings` (MethodElementSettings, optional) — Settings for wallet payment methods. ### PayorElement - `enabled` (boolean, optional) — Toggles whether the section or element is enabled. - `fields` (list of PayorFields, optional) — Array of Customer/Payor fields to show in section - `header` (string, optional) — Custom header text for section - `order` (integer, optional) — Order of element or section in container. ### HeaderElement - `enabled` (boolean, optional) — Toggles whether the section or element is enabled. - `header` (string, optional) — Header text for section - `order` (integer, optional) — Order of element or section in container. ### 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 ### ButtomElement - `label` (string, optional) — Label for custom payment button - `size` (enum, optional) — Specify size of custom payment button - Allowed values: `sm`, `md`, `lg` ### SettingElement - `enabled` (boolean, optional) — Toggles whether the section or element is enabled. - `fields` (list of DisplayProperty, optional) — Fields to display on the reciept. - `order` (integer, optional) — Order of element or section in container. - `sendAuto` (boolean, optional, default: true) — When `true`, Payabli automatically sends the receipt to the payor email address. - `sendManual` (boolean, optional, default: false) — When `true`, you must send the reciept to the payor manually using the [/MoneyIn/sendreceipt/\{transId}](/api-reference/moneyin/send-receipt-for-transaction) endpoint. ### PayCategory - `description` (string, optional) - `label` (string, optional) - `name` (string, optional) - `optionalPay` (boolean, optional) - `order` (integer, optional) — Order of element or section in container. - `quantity` (integer, optional) - `showDescription` (boolean, optional) - `type` (string, optional) - `value` (string, optional) ### Finishtype - `calendar` (boolean, optional) — Flag to enable 'calendar' option - `untilCancelled` (boolean, optional) — Flag to enable 'untilCancelled' option ### FrequencyList - `annually` (boolean, optional) — Enable or disable frequency - `every2Weeks` (boolean, optional) — Enable or disable frequency - `every3Months` (boolean, optional) — Enable or disable frequency - `every6Months` (boolean, optional) — Enable or disable frequency - `monthly` (boolean, optional) — Enable or disable frequency - `one-time` (boolean, optional) — Enable or disable frequency - `weekly` (boolean, optional) — Enable or disable frequency ### MethodsList - `amex` (boolean, optional) — When `true`, American Express is accepted. - `applePay` (boolean, optional) — When `true`, Apple Pay is accepted. - `discover` (boolean, optional) — When `true`, Discover is accepted. - `eCheck` (boolean, optional) — When `true`, ACH is accepted. - `mastercard` (boolean, optional) — When `true`, Mastercard is accepted. - `visa` (boolean, optional) — When `true`, Visa is accepted. ### MethodElementSettings Settings for wallet payment methods. - `applePay` (MethodElementSettingsApplePay, optional) ### PayorFields - `display` (boolean, optional) — Flag indicating if the input field will show in container - `fixed` (boolean, optional) — Flag indicating if the value in input field is readonly or not - `identifier` (boolean, optional) — Flag indicating if the input field is a customer identifier - `label` (string, optional) — Label to display for field - `name` (string, optional) — Name of field to show Should be one of the standard customer fields or a custom field name - `order` (integer, optional) — Order of element or section in container. - `required` (boolean, optional) — Flag indicating if the input field is required for validation - `validation` (string, optional) — Type of validation to apply to the input field Accepted values: - alpha for alphabetic, - numbers for numeric, - text for alphanumeric, - email for masked email address input, - phone for US phone numbers - `value` (string, optional) — Pre-populated value for field - `width` (integer, optional) — Numeric value indicating the size of input relative to the container Accepted values: - 4 = 1/3, - 6 = 1/2, - 8 = 2/3, - 12 = 3/3 ### DisplayProperty - `display` (boolean, optional) — When `true`, the field is displayed on the receipt. - `Fixed` (boolean, optional) — This field is unused. - `name` (string, optional) — The field's name. ### MethodElementSettingsApplePay - `buttonStyle` (enum, optional, default: black) — The Apple Pay button style. See [Apple Pay Button Style](/developer-guides/hosted-payment-page-apple-pay#param-applepay-button-style) for more information. - Allowed values: `black`, `white-outline`, `white` - `buttonType` (enum, optional, default: pay) — The text on Apple Pay button. See [Apple Pay Button Type](/developer-guides/hosted-payment-page-apple-pay#param-applepay-button-type) for more information. - Allowed values: `plain`, `buy`, `donate`, `check-out`, `book`, `continue`, `top-up`, `order`, `rent`, `support`, `contribute`, `tip`, `pay` - `language` (enum, optional, default: en-US) — The Apple Pay button locale. See [Apple Pay Button Language](/developer-guides/hosted-payment-page-apple-pay#param-applepay-language) for more information. - Allowed values: `en-US`, `ar-AB`, `ca-ES`, `zh-CN`, `zh-HK`, `zh-TW`, `hr-HR`, `cs-CZ`, `da-DK`, `de-DE`, `nl-NL`, `en-AU`, `en-GB`, `fi-FI`, `fr-CA`, `fr-FR`, `el-GR`, `he-IL`, `hi-IN`, `hu-HU`, `id-ID`, `it-IT`, `ja-JP`, `ko-KR`, `ms-MY`, `nb-NO`, `pl-PL`, `pt-BR`, `pt-PT`, `ro-RO`, `ru-RU`, `sk-SK`, `es-MX`, `es-ES`, `sv-SE`, `th-TH`, `tr-TR`, `uk-UA`, `vi-VN` ## Examples **Request** ```json {} ``` **Response** ```json { "isSuccess": true, "responseCode": 1, "responseData": "string", "responseText": "Updated" } ``` **SDK Code** ```python Example import requests url = "https://api-sandbox.payabli.com/api/Paypoint/8cfec329267/pay-your-fees-1" payload = {} headers = { "requestToken": "", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Example const url = 'https://api-sandbox.payabli.com/api/Paypoint/8cfec329267/pay-your-fees-1'; 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 Example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Paypoint/8cfec329267/pay-your-fees-1" 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 Example require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Paypoint/8cfec329267/pay-your-fees-1") 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 Example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://api-sandbox.payabli.com/api/Paypoint/8cfec329267/pay-your-fees-1") .header("requestToken", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php Example request('PUT', 'https://api-sandbox.payabli.com/api/Paypoint/8cfec329267/pay-your-fees-1', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```csharp Example using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/Paypoint/8cfec329267/pay-your-fees-1"); 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 Example 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/Paypoint/8cfec329267/pay-your-fees-1")! 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() ```