> 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. # List paypoints by organization GET https://api-sandbox.payabli.com/api/Query/paypoints/{orgId} Returns a list of paypoints in an organization. Use filters to limit results. Reference: https://beta-docs.payabli.com/api-reference/paypoint/get-list-of-paypoints-for-an-organization ## 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 - `orgId` (integer, required) — The numeric identifier for organization, assigned by Payabli. ### Query parameters - `fromRecord` (integer, optional, default: 0) — The number of records to skip before starting to collect the result set. - `limitRecord` (integer, optional, default: 20) — Max number of records to return for the query. Use `0` or negative value to return all records. - `parameters` (map from string to string, optional) — Collection of field names, conditions, and values used to filter the query **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.** Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client. For example: \--url [https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000\&limitRecord=20](https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount\(gt\)=1000\&limitRecord=20) should become: \--url [https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000\&limitRecord=20](https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount\(gt\)=1000\&limitRecord=20) **List of field names accepted:** * `createdAt` (gt, ge, lt, le, eq, ne) * `lastModified` (gt, ge, lt, le, eq, ne) * `startDate` (gt, ge, lt, le, eq, ne) * `dbaname` (ct, nct) * `status` (eq, ne) * `legalname` (ct, nct) * `externalPaypointID` (ct, nct) * `ein` (ct, nct) * `address` (ct, nct) * `city` (ct, nct) * `state` (ct, nct) * `phone` (ct, nct) * `mcc` (ct, nct) * `owntype` (ct, nct) * `ownerName` (ct, nct) * `contactName` (ct, nct) * `paypointId` (eq, ne) * `orgParentname` (ct, nct, in, nin) * `boardingId` (eq, ne) * `entryName` (ct, nct) * `externalOrgID` (ct, nct) **List of comparison accepted - enclosed between parentheses:** * `eq` or empty => equal * `gt` => greater than * `ge` => greater or equal * `lt` => less than * `le` => less or equal * `ne` => not equal * `ct` => contains * `nct` => not contains * `in` => inside array * `nin` => not inside array **List of parameters accepted:** * `limitRecord` : max number of records for query (default="20", "0" or negative value for all) * `fromRecord` : initial record in query Example: `dbaname(ct)=hoa` return all records with dbname containing "hoa" - `sortBy` (string, optional) — The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`. ## Response ### 200 Success - `Records` (list of QueryEntrypointResponseRecordsItem, optional) - `Summary` (QuerySummary, optional) ## 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 ### QueryEntrypointResponseRecordsItem - `AverageMonthlyVolume` (double, optional) — Average total amount of transactions in your local currency that are processed each month. - `AverageTicketAmount` (double, optional) — Average ticket amount. - `BAddress1` (string, optional) — Business address. - `BAddress2` (string, optional) — Business address additional line. - `BankData` (list of Bank, optional) — Information about associated bank accounts. - `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 - `BFax` (string, optional) — The business's fax number. - `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. - `BoardingId` (long, optional) — The Payabli-assigned ID of the boarding application linked to this paypoint. - `BPhone` (string, optional) — Business phone number. - `BStartdate` (string, optional) — Business start date. Accepted formats: - YYYY-MM-DD - MM/DD/YYYY - `BState` (string, optional) — Business state. - `BSummary` (string, optional) — A summary of what the business sells in terms of goods or services. - `BTimeZone` (integer, optional) — Timezone, in UTC offset. For example, -5 is Eastern time. - `BZip` (string, optional) — Business ZIP. - `ContactData` (list of Contacts, optional) — List of contacts. - `CreatedAt` (datetime, optional) — Timestamp of when record was created, in UTC. - `DbaName` (string, optional) — The alternate or common name that this business is doing business under usually referred to as a DBA name. - `DocumentsRef` (string, optional) - `Ein` (string, optional) — Business EIN or tax ID. This value is masked in API responses, for example `XXXX6789`. - `EntryPoints` (list of PaypointEntryConfig, optional) - `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. - `ExternalProcessorInformation` (string, optional) — Processor information, used for troubleshooting and reporting. This field contains a value when the API key used to make the request has management permissions. - `HighTicketAmount` (double, optional) — High ticket amount. - `IdPaypoint` (long, optional) — Paypoint ID. - `LastModified` (datetime, optional) — Timestamp of when record was last updated, in UTC. - `LegalName` (string, optional) — Business legal name. - `License` (string, optional) — Business license ID or state ID number. - `LicenseState` (string, optional) — Business license issuing state or province. - `MAddress1` (string, optional) — The business's mailing address. - `MAddress2` (string, optional) — Additional line for the business's mailing address. - `Mccid` (string, optional) - `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. - `OrgParentName` (string, optional) — The name of the parent organization. - `OwnerData` (list of Owners, optional) — List of Owners with at least a 25% ownership. - `OwnType` (enum, optional) — The business ownership type. - Allowed values: `Limited Liability Company`, `Non-Profit Org`, `Partnership`, `Private Corp`, `Public Corp`, `Tax Exempt`, `Government`, `Sole Proprietor` - `PaypointStatus` (integer, optional) — The paypoint's status. Active - `1` Inactive - 0 - `SalesCode` (string, optional) - `ServiceData` (Services, optional) — Controls which services will be enabled for the merchant. - `summary` (PaypointSummary, optional) - `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. - `WebsiteAddress` (string, optional) — Business website. - `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` - `Whenrefund` (enum, optional) — Describes the business refund policy. - Allowed values: `Exchange Only`, `No Refund or Exchange`, `More than 30 days`, `30 Days or Less` ### QuerySummary - `pageIdentifier` (string, optional) — Auxiliary validation used internally by payment pages and components. - `pageSize` (integer, optional) — Number of records on each response page. - `totalAmount` (double, optional) — Total amount for the records. - `totalNetAmount` (double, optional) — Total net amount for the records. - `totalPages` (integer, optional) — Total number of records in response. - `totalRecords` (integer, optional) — Total number of records in response. ### 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. ### PaypointEntryConfig - `EntryComment` (string, optional) - `EntryLogo` (string, optional) - `EntryName` (string, optional) - `EntryPages` (list of PayabliPages, optional) - `EntrySubtitle` (string, optional) - `EntryTitle` (string, optional) - `IdEntry` (long, optional) - `Paypoint` (PaypointData, optional) ### 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. ### Services Controls which services will be enabled for the merchant. - `ach` (AchSetup, optional) - `card` (CardSetup, optional) - `odp` (OdpSetup, optional) ### PaypointSummary - `amountSubs` (double, optional) - `amountTx` (double, optional) - `countSubs` (integer, optional) - `countTx` (integer, optional) - `customers` (integer, optional) ### 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 ### PaypointData - `address1` (string, optional) — The address. - `address2` (string, optional) — Additional line for the address. - `bankData` (list of Bank, optional) — Information about associated bank accounts. - `boardingId` (long, optional) — The Payabli-assigned ID of the boarding application linked to this paypoint. - `city` (string, optional) — The city. - `contacts` (list of Contacts, optional) — List of contacts. - `country` (string, optional) — The country in ISO-3166-1 alpha 2 format. See https://en.wikipedia.org/wiki/ISO_3166-1 for reference. - `credentials` (list of PayabliCredentials, optional) - `dbaName` (string, optional) — The alternate or common name that this business is doing business under usually referred to as a DBA name. - `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. - `fax` (string, optional) — Fax number - `idPaypoint` (long, optional) — Paypoint ID. - `legalName` (string, optional) — Business legal name. - `parentOrg` (OrgData, optional) - `paypointStatus` (integer, optional) — The paypoint's status. Active - `1` Inactive - 0 - `phone` (string, optional) — Phone number. - `serviceData` (Services, optional) — Controls which services will be enabled for the merchant. - `state` (string, optional) — The state or province. - `summary` (PaypointSummary, optional) - `timeZone` (integer, optional) — Timezone, in UTC offset. For example, -5 is Eastern time. - `websiteAddress` (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. - `zip` (string, optional) — ZIP code for address. ### 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 ### 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. ### OrgData - `idOrg` (long, optional) — Organization ID. Unique identifier assigned to an org by Payabli. - `orgAddress` (string, optional) — The organization's address. - `orgLogo` (FileContent, optional) — Contains details about a file. See See [fileObject Object Model](/api-reference/schemas/filecontent) for a complete reference. Max upload size is 30 MB. - `orgName` (string, optional) — The name of the organization. - `orgStatus` (integer, optional) — The paypoint's status. Active - `1` Inactive - 0 - `orgType` (integer, optional) — The organization type. Currently, this must be `0`. ### 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 **Response** ```json { "Records": [ { "AverageMonthlyVolume": 1000, "AverageTicketAmount": 1000, "BAddress1": "123 Walnut Street", "BAddress2": "Suite 103", "BankData": [ { "bankAccountFunction": 0, "bankAccountHolderName": "Gruzya Adventure Outfitters LLC", "nickname": "Business Checking 1234" } ], "BCity": "New Vegas", "BCountry": "US", "BFax": "5551234567", "BinPerson": 60, "BinPhone": 20, "BinWeb": 20, "BoardingId": 340, "BPhone": "5551234567", "BStartdate": "01/01/1990", "BState": "FL", "BSummary": "Brick and mortar store that sells office supplies", "BTimeZone": -5, "BZip": "33000", "ContactData": [ {} ], "CreatedAt": "2022-07-01T15:00:01Z", "DbaName": "Sunshine Gutters", "DocumentsRef": "DocumentsRef", "Ein": "123456789", "EntryPoints": [ {} ], "externalPaypointID": "Paypoint-100", "ExternalProcessorInformation": "[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]", "HighTicketAmount": 1000, "IdPaypoint": 1000000, "LastModified": "2022-07-01T15:00:01Z", "LegalName": "Sunshine Services, LLC", "License": "2222222FFG", "LicenseState": "CA", "MAddress1": "123 Walnut Street", "MAddress2": "STE 900", "Mccid": "Mccid", "MCity": "Johnson City", "MCountry": "US", "MState": "TN", "MZip": "37615", "OrgId": 123, "OrgParentName": "PropertyManager Pro", "OwnerData": [ {} ], "OwnType": "Limited Liability Company", "PaypointStatus": 1, "SalesCode": "SalesCode", "Taxfillname": "Sunshine LLC", "TemplateId": 22, "WebsiteAddress": "www.example.com", "Whencharged": "When Service Provided", "Whendelivered": "0-7 Days", "Whenprovided": "30 Days or Less", "Whenrefund": "Exchange Only" } ], "Summary": { "pageIdentifier": "null", "pageSize": 20, "totalAmount": 77.22, "totalNetAmount": 77.22, "totalPages": 2, "totalRecords": 2 } } ``` **SDK Code** ```python import requests url = "https://api-sandbox.payabli.com/api/Query/paypoints/123" querystring = {"fromRecord":"251","limitRecord":"0","sortBy":"desc(field_name)"} headers = {"requestToken": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api-sandbox.payabli.com/api/Query/paypoints/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29'; const options = {method: 'GET', headers: {requestToken: ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Query/paypoints/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("requestToken", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Query/paypoints/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/paypoints/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") .header("requestToken", "") .asString(); ``` ```php request('GET', 'https://api-sandbox.payabli.com/api/Query/paypoints/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/Query/paypoints/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29"); var request = new RestRequest(Method.GET); request.AddHeader("requestToken", ""); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/paypoints/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers 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() ```