# 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. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.

Reference: https://docs.payabli.com/developers/api-reference/paypoint/get-list-of-paypoints-for-an-organization

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get list of paypoints for an organization
  version: endpoint_query.ListPaypoints
paths:
  /Query/paypoints/{orgId}:
    get:
      operationId: list-paypoints
      summary: Get list of paypoints for an organization
      description: >-
        Returns a list of paypoints in an organization. Use filters to limit
        results. Include the `exportFormat` query parameter to return the
        results as a file instead of a JSON response.
      tags:
        - - subpackage_query
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
        - name: exportFormat
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/type_:ExportFormat'
        - name: fromRecord
          in: query
          description: >-
            The number of records to skip before starting to collect the result
            set.
          required: false
          schema:
            type: integer
            default: 0
        - name: limitRecord
          in: query
          description: >-
            Max number of records to return for the query. Use `0` or negative
            value to return all records.
          required: false
          schema:
            type: integer
            default: 20
        - name: parameters
          in: query
          description: >-
            Collection of field names, conditions, and values used to filter the
            query

            <Info>
              **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

              should become:

              --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
            </Info>

            **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` returns all records with a `dbaname`
            containing "hoa"
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
        - name: sortBy
          in: query
          description: >-
            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`.
          required: false
          schema:
            type: string
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_:QueryEntrypointResponse'
        '400':
          description: Bad request/ invalid data
          content: {}
        '401':
          description: Unauthorized request.
          content: {}
        '500':
          description: Internal API Error
          content: {}
        '503':
          description: Database connection error
          content: {}
components:
  schemas:
    type_:ExportFormat:
      type: string
      enum:
        - description: Comma-separated values file
          value: csv
        - description: Excel spreadsheet file
          value: xlsx
    type_:Avgmonthly:
      type: number
      format: double
    type_:Avgticketamt:
      type: number
      format: double
    type_:Baddress1:
      type: string
    type_:Baddress2:
      type: string
    type_:BankNickname:
      type: string
    type_:BankName:
      type: string
    type_:RoutingAccount:
      type: string
    type_:AccountNumber:
      type: string
    type_:TypeAccount:
      type: string
      enum:
        - value: Checking
        - value: Savings
    type_:BankAccountHolderName:
      type: string
    type_:BankAccountHolderType:
      type: string
      enum:
        - value: Personal
        - value: Business
    type_:BankAccountFunction:
      type: integer
    type_:Bank:
      type: object
      properties:
        id:
          type: integer
          description: The Payabli-assigned internal identifier for the bank account.
        accountId:
          type: string
          description: >-
            A user-defined internal identifier for the bank account. This allows
            you to specify which bank account should be used for payments in
            cases where multiple accounts are configured.
        nickname:
          $ref: '#/components/schemas/type_:BankNickname'
        bankName:
          $ref: '#/components/schemas/type_:BankName'
        routingAccount:
          $ref: '#/components/schemas/type_:RoutingAccount'
        accountNumber:
          $ref: '#/components/schemas/type_:AccountNumber'
        typeAccount:
          $ref: '#/components/schemas/type_:TypeAccount'
        bankAccountHolderName:
          $ref: '#/components/schemas/type_:BankAccountHolderName'
        bankAccountHolderType:
          $ref: '#/components/schemas/type_:BankAccountHolderType'
        bankAccountFunction:
          $ref: '#/components/schemas/type_:BankAccountFunction'
        verified:
          type: boolean
          description: >-
            Bank account verification status. When `true`, the account has been
            verified to exist and be in good standing based on vendor checks or
            previous processing histories.
        status:
          type: integer
          description: Bank account status
        services:
          type: array
          items:
            type: string
          description: Array of services associated with this bank account
    type_:BankData:
      type: array
      items:
        $ref: '#/components/schemas/type_:Bank'
    type_:Bcity:
      type: string
    type_:Bcountry:
      type: string
    type_:Bphone:
      type: string
    type_:Binperson:
      type: integer
    type_:Binphone:
      type: integer
    type_:Binweb:
      type: integer
    type_:BoardingId:
      type: integer
      format: int64
    type_:Busstartdate:
      type: string
    type_:Bstate:
      type: string
    type_:Bsummary:
      type: string
    type_:Timezone:
      type: integer
    type_:Bzip:
      type: string
    type_:Email:
      type: string
      format: email
    type_:AdditionalDataString:
      type: string
    type_:Contacts:
      type: object
      properties:
        contactEmail:
          $ref: '#/components/schemas/type_:Email'
          description: Contact email address.
        contactName:
          type: string
          description: Contact name.
        contactPhone:
          type: string
          description: Contact phone number.
        contactTitle:
          type: string
          description: Contact title.
        additionalData:
          $ref: '#/components/schemas/type_:AdditionalDataString'
    type_:ContactsField:
      type: array
      items:
        $ref: '#/components/schemas/type_:Contacts'
    type_:CreatedAt:
      type: string
      format: date-time
    type_:Dbaname:
      type: string
    type_:Ein:
      type: string
    type_:AdditionalData:
      type: object
      additionalProperties:
        type: object
        additionalProperties:
          description: Any type
    type_:PayabliCredentials:
      type: object
      properties:
        accountId:
          type: string
        cfeeFix:
          type: number
          format: double
        cfeeFloat:
          type: number
          format: double
        cfeeMax:
          type: number
          format: double
        cfeeMin:
          type: number
          format: double
        maxticket:
          type: number
          format: double
        minticket:
          type: number
          format: double
        mode:
          type: integer
          description: >-
            The payment mode supported by this service. `0` for one-time
            payments, `1` for recurring payments, `2` for both.
        referenceId:
          type: integer
          format: int64
        service:
          type: string
          description: >-
            The payment service that this credential applies to. A paypoint can
            support multiple services, each represented by its own credential
            object in the array. Possible values are `card` (credit/debit card),
            `ach` (ACH bank transfer), `check` (paper check), `vcard` (virtual
            card), `cloud` (card-present), `cash`, `managed` (managed payment
            service), and `wallet`.
    type_:Order:
      type: integer
    type_:PayCategory:
      type: object
      properties:
        description:
          type: string
        label:
          type: string
        name:
          type: string
        optionalPay:
          type: boolean
        order:
          $ref: '#/components/schemas/type_:Order'
        quantity:
          type: integer
        showDescription:
          type: boolean
        type:
          type: string
        value:
          type: string
    type_:Enabled:
      type: boolean
    type_:AmountElement:
      type: object
      properties:
        categories:
          type: array
          items:
            $ref: '#/components/schemas/type_:PayCategory'
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        order:
          $ref: '#/components/schemas/type_:Order'
    type_:Finishtype:
      type: object
      properties:
        calendar:
          type: boolean
          description: Flag to enable 'calendar' option
        untilCancelled:
          type: boolean
          description: Flag to enable 'untilCancelled' option
    type_:FrequencyList:
      type: object
      properties:
        annually:
          type: boolean
          description: Enable or disable frequency
        every2Weeks:
          type: boolean
          description: Enable or disable frequency
        every3Months:
          type: boolean
          description: Enable or disable frequency
        every6Months:
          type: boolean
          description: Enable or disable frequency
        monthly:
          type: boolean
          description: Enable or disable frequency
        onetime:
          type: boolean
          description: Enable or disable frequency
        weekly:
          type: boolean
          description: Enable or disable frequency
    type_:AutoElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        finish:
          $ref: '#/components/schemas/type_:Finishtype'
          description: Type of end date
        frequency:
          $ref: '#/components/schemas/type_:FrequencyList'
          description: accepted frequencies for autopay
        frequencySelected:
          type: string
          description: Value of pre-selected frequency
        header:
          type: string
          description: Header text for section
        order:
          $ref: '#/components/schemas/type_:Order'
        startDate:
          type: string
          description: Range of days enabled in calendar. Leave empty to enable all days.
    type_:ContactElement:
      type: object
      properties:
        emailLabel:
          type: string
          description: Custom content for email
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        header:
          type: string
          description: Header text for section
        order:
          $ref: '#/components/schemas/type_:Order'
        paymentIcons:
          type: boolean
          description: Flag indicating if icons for accepted card brands will be shown
        phoneLabel:
          type: string
          description: Custom content for phone number
    type_:LabelElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        label:
          type: string
          description: Label to display for section or element
        order:
          $ref: '#/components/schemas/type_:Order'
    type_:InvoiceElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        invoiceLink:
          $ref: '#/components/schemas/type_:LabelElement'
          description: Link to invoice
        order:
          $ref: '#/components/schemas/type_:Order'
        viewInvoiceDetails:
          $ref: '#/components/schemas/type_:LabelElement'
          description: Link to view invoice details
    type_:Element:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        order:
          $ref: '#/components/schemas/type_:Order'
    type_:NoteElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        header:
          type: string
          description: Header text for section
        order:
          $ref: '#/components/schemas/type_:Order'
        placeholder:
          type: string
          description: Placeholder text for input field
        value:
          type: string
          description: Pre-populated value for input field
    type_:PageElement:
      type: object
      properties:
        description:
          type: string
          description: Page description in header
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        header:
          type: string
          description: Page header
        order:
          $ref: '#/components/schemas/type_:Order'
    type_:MethodsList:
      type: object
      properties:
        amex:
          type: boolean
          description: When `true`, American Express is accepted.
        applePay:
          type: boolean
          description: When `true`, Apple Pay is accepted.
        googlePay:
          type: boolean
          description: When `true`, Google Pay is accepted.
        discover:
          type: boolean
          description: When `true`, Discover is accepted.
        eCheck:
          type: boolean
          description: When `true`, ACH is accepted.
        mastercard:
          type: boolean
          description: When `true`, Mastercard is accepted.
        visa:
          type: boolean
          description: When `true`, Visa is accepted.
    type_:MethodElementSettingsApplePayButtonStyle:
      type: string
      enum:
        - value: black
        - value: white-outline
        - value: white
      default: black
    type_:MethodElementSettingsApplePayButtonType:
      type: string
      enum:
        - value: plain
        - value: buy
        - value: donate
        - value: check-out
        - value: book
        - value: continue
        - value: top-up
        - value: order
        - value: rent
        - value: support
        - value: contribute
        - value: tip
        - value: pay
      default: pay
    type_:MethodElementSettingsApplePayLanguage:
      type: string
      enum:
        - value: en-US
        - value: ar-AB
        - value: ca-ES
        - value: zh-CN
        - value: zh-HK
        - value: zh-TW
        - value: hr-HR
        - value: cs-CZ
        - value: da-DK
        - value: de-DE
        - value: nl-NL
        - value: en-AU
        - value: en-GB
        - value: fi-FI
        - value: fr-CA
        - value: fr-FR
        - value: el-GR
        - value: he-IL
        - value: hi-IN
        - value: hu-HU
        - value: id-ID
        - value: it-IT
        - value: ja-JP
        - value: ko-KR
        - value: ms-MY
        - value: nb-NO
        - value: pl-PL
        - value: pt-BR
        - value: pt-PT
        - value: ro-RO
        - value: ru-RU
        - value: sk-SK
        - value: es-MX
        - value: es-ES
        - value: sv-SE
        - value: th-TH
        - value: tr-TR
        - value: uk-UA
        - value: vi-VN
      default: en-US
    type_:MethodElementSettingsApplePay:
      type: object
      properties:
        buttonStyle:
          $ref: '#/components/schemas/type_:MethodElementSettingsApplePayButtonStyle'
          description: >-
            The Apple Pay button style. See [Apple Pay Button
            Style](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-button-style)
            for more information.
        buttonType:
          $ref: '#/components/schemas/type_:MethodElementSettingsApplePayButtonType'
          description: >-
            The text on Apple Pay button. See [Apple Pay Button
            Type](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-button-type)
            for more information.
        language:
          $ref: '#/components/schemas/type_:MethodElementSettingsApplePayLanguage'
          description: >-
            The Apple Pay button locale. See [Apple Pay Button
            Language](/developers/developer-guides/hosted-payment-page-apple-pay#param-applepay-language)
            for more information.
    type_:MethodElementSettings:
      type: object
      properties:
        applePay:
          $ref: '#/components/schemas/type_:MethodElementSettingsApplePay'
    type_:MethodElement:
      type: object
      properties:
        allMethodsChecked:
          type: boolean
          description: Flag indicating if all allowed payment methods will be pre-selected.
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        header:
          type: string
          description: Header text for section
        methods:
          $ref: '#/components/schemas/type_:MethodsList'
        order:
          $ref: '#/components/schemas/type_:Order'
        settings:
          $ref: '#/components/schemas/type_:MethodElementSettings'
          description: Settings for wallet payment methods.
    type_:PayorFields:
      type: object
      properties:
        display:
          type: boolean
          description: Flag indicating if the input field will show in container
        fixed:
          type: boolean
          description: Flag indicating if the value in input field is read-only or not.
        identifier:
          type: boolean
          description: Flag indicating if the input field is a customer identifier
        label:
          type: string
          description: Label to display for field
        name:
          type: string
          description: >-
            Name of field to show. Should be one of the standard customer fields
            or a custom field name
        order:
          $ref: '#/components/schemas/type_:Order'
        required:
          type: boolean
          description: Flag indicating if the input field is required for validation
        validation:
          type: string
          description: |-
            Type of validation to apply to the input field Accepted values:

              - alpha for alphabetical

              - numbers for numeric

              - text for alphanumeric

              - email for masked email address input

              - phone for US phone numbers
        value:
          type: string
          description: Pre-populated value for field
        width:
          type: integer
          description: >-
            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
    type_:PayorElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/type_:PayorFields'
          description: Array of Customer/Payor fields to show in section
        header:
          type: string
          description: Custom header text for section
        order:
          $ref: '#/components/schemas/type_:Order'
    type_:HeaderElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        header:
          type: string
          description: Header text for section
        order:
          $ref: '#/components/schemas/type_:Order'
    type_:Subdomain:
      type: string
    type_:PageContent:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/type_:AmountElement'
          description: Amount section of payment page
        autopay:
          $ref: '#/components/schemas/type_:AutoElement'
          description: Autopay section of payment page
        contactUs:
          $ref: '#/components/schemas/type_:ContactElement'
          description: ContactUs section of payment page
        entry:
          type: string
          description: Identifier of entry point owner of page
        invoices:
          $ref: '#/components/schemas/type_:InvoiceElement'
          description: Invoices section of payment page
        logo:
          $ref: '#/components/schemas/type_:Element'
          description: Logo section of payment page
        messageBeforePaying:
          $ref: '#/components/schemas/type_:LabelElement'
          description: Message section of payment page
        name:
          type: string
          description: Descriptor of page
        notes:
          $ref: '#/components/schemas/type_:NoteElement'
          description: Notes section of payment page
        page:
          $ref: '#/components/schemas/type_:PageElement'
          description: Page header section of payment page
        paymentButton:
          $ref: '#/components/schemas/type_:LabelElement'
          description: Payment button section of payment page
        paymentMethods:
          $ref: '#/components/schemas/type_:MethodElement'
          description: Payment methods section of payment page
        payor:
          $ref: '#/components/schemas/type_:PayorElement'
          description: Customer/Payor section of payment page
        review:
          $ref: '#/components/schemas/type_:HeaderElement'
          description: Review section of payment page
        subdomain:
          $ref: '#/components/schemas/type_:Subdomain'
          description: Unique identifier assigned to the page.
    type_:PageIdentifier:
      type: string
    type_:FileContentFtype:
      type: string
      enum:
        - value: pdf
        - value: doc
        - value: docx
        - value: jpg
        - value: jpeg
        - value: png
        - value: gif
        - value: txt
    type_:FileContent:
      type: object
      properties:
        fContent:
          type: string
          description: >-
            Content of file, Base64-encoded. Ignored if furl is specified. Max
            upload size is 30 MB.
        filename:
          type: string
          description: The name of the attached file.
        ftype:
          $ref: '#/components/schemas/type_:FileContentFtype'
          description: The MIME type of the file (if content is provided)
        furl:
          type: string
          description: Optional URL provided to show or download the file remotely
    type_:ButtonElementSize:
      type: string
      enum:
        - value: sm
        - value: md
        - value: lg
    type_:ButtonElement:
      type: object
      properties:
        label:
          type: string
          description: Label for custom payment button
        size:
          $ref: '#/components/schemas/type_:ButtonElementSize'
          description: Specify size of custom payment button
      required:
        - label
    type_:PageSetting:
      type: object
      properties:
        color:
          type: string
          description: 'An HTML color code in format #RRGGBB'
        customCssUrl:
          type: string
          description: Complete URL to a custom CSS file to be loaded with the page
        language:
          type: string
          description: Two-letter code following ISO 639-1
        pageLogo:
          $ref: '#/components/schemas/type_:FileContent'
          description: Object containing logo file to upload/ use in page
        paymentButton:
          $ref: '#/components/schemas/type_:ButtonElement'
        redirectAfterApprove:
          type: boolean
          description: >-
            Flag indicating if the capability for redirection in the page will
            be activated
        redirectAfterApproveUrl:
          type: string
          description: Complete URL where the page will be redirected after completion
    type_:DisplayProperty:
      type: object
      properties:
        display:
          type: boolean
          description: When `true`, the field is displayed on the receipt.
        Fixed:
          type: boolean
          description: This field is unused.
        name:
          type: string
          description: The field's name.
    type_:SettingElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/type_:DisplayProperty'
          description: Fields to display on the reciept.
        order:
          $ref: '#/components/schemas/type_:Order'
        sendAuto:
          type: boolean
          default: true
          description: >-
            When `true`, Payabli automatically sends the receipt to the payor
            email address.
        sendManual:
          type: boolean
          default: false
          description: >-
            When `true`, you must send the reciept to the payor manually using
            the
            [/MoneyIn/sendreceipt/\{transId\}](/developers/api-reference/moneyin/send-receipt-for-transaction)
            endpoint.
    type_:ReceiptContent:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/type_:Element'
          description: Section amount of payment receipt
        contactUs:
          $ref: '#/components/schemas/type_:Element'
          description: Section contactUs of payment receipt
        details:
          $ref: '#/components/schemas/type_:Element'
          description: Section payment details of payment receipt
        logo:
          $ref: '#/components/schemas/type_:Element'
          description: Section logo of payment receipt
        messageBeforeButton:
          $ref: '#/components/schemas/type_:LabelElement'
          description: Section message of payment receipt
        page:
          $ref: '#/components/schemas/type_:PageElement'
          description: Section page of payment receipt
        paymentButton:
          $ref: '#/components/schemas/type_:LabelElement'
          description: Section payment button of payment receipt
        paymentInformation:
          $ref: '#/components/schemas/type_:Element'
          description: Section payment information of payment receipt
        settings:
          $ref: '#/components/schemas/type_:SettingElement'
          description: The receipt's settings.
    type_:PayabliPages:
      type: object
      properties:
        AdditionalData:
          $ref: '#/components/schemas/type_:AdditionalData'
        credentials:
          type: array
          items:
            $ref: '#/components/schemas/type_:PayabliCredentials'
          description: Array of credential objects with active services for the page
        lastAccess:
          type: string
          format: date-time
          description: Timestamp of last access to page structure
        pageContent:
          $ref: '#/components/schemas/type_:PageContent'
          description: Sections of page
        pageIdentifier:
          $ref: '#/components/schemas/type_:PageIdentifier'
        pageSettings:
          $ref: '#/components/schemas/type_:PageSetting'
          description: Settings of page
        published:
          type: integer
          description: >-
            Flag indicating if page is active to accept payments. `0` for false,
            `1` for true.
        receiptContent:
          $ref: '#/components/schemas/type_:ReceiptContent'
          description: Sections of payment receipt
        subdomain:
          $ref: '#/components/schemas/type_:Subdomain'
          description: Page identifier. Must be unique in platform.
        totalAmount:
          type: number
          format: double
          description: Total amount to pay in this page
        validationCode:
          type: string
          description: Base64 encoded image of CAPTCHA associated to this page load
    type_:AddressNullable:
      type: string
    type_:AddressAddtlNullable:
      type: string
    type_:CityNullable:
      type: string
    type_:CountryNullable:
      type: string
    type_:MinTicket:
      type: number
      format: double
    type_:MaxTicket:
      type: number
      format: double
    type_:PayabliCredentialsPascal:
      type: object
      properties:
        Service:
          type: string
          description: >-
            The payment service that this credential applies to. A paypoint can
            support multiple services, each represented by its own credential
            object in the array. Possible values are `card` (credit/debit card),
            `ach` (ACH bank transfer), `check` (paper check), `vcard` (virtual
            card), `cloud` (card-present), `cash`, `managed` (managed payment
            service), and `wallet`.
        Mode:
          type: integer
          description: >-
            The payment mode supported by this service. `0` for one-time
            payments, `1` for recurring payments, `2` for both.
        MinTicket:
          $ref: '#/components/schemas/type_:MinTicket'
        MaxTicket:
          $ref: '#/components/schemas/type_:MaxTicket'
        CfeeFix:
          type: number
          format: double
        CfeeFloat:
          type: number
          format: double
        CfeeMin:
          type: number
          format: double
        CfeeMax:
          type: number
          format: double
        AccountId:
          type: string
        ReferenceId:
          type: integer
          format: int64
        acceptSameDayACH:
          type: boolean
        Currency:
          type: string
          description: The default currency for the paypoint, either `USD` or `CAD`.
    type_:ExternalPaypointId:
      type: string
    type_:PhoneNumber:
      type: string
    type_:Idpaypoint:
      type: integer
      format: int64
    type_:Legalname:
      type: string
    type_:Orgid:
      type: integer
      format: int64
    type_:Orgaddress:
      type: string
    type_:Orgname:
      type: string
    type_:Orgtype:
      type: integer
    type_:OrgData:
      type: object
      properties:
        idOrg:
          $ref: '#/components/schemas/type_:Orgid'
        orgAddress:
          $ref: '#/components/schemas/type_:Orgaddress'
        orgLogo:
          $ref: '#/components/schemas/type_:FileContent'
        orgName:
          $ref: '#/components/schemas/type_:Orgname'
        orgStatus:
          type: integer
          description: |-
            The paypoint's status. 

            Active - `1`

            Inactive - 0
        orgType:
          $ref: '#/components/schemas/type_:Orgtype'
    type_:Paypointstatus:
      type: integer
    type_:AchSetup:
      type: object
      properties:
        acceptCCD:
          type: boolean
          description: >-
            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:
          type: boolean
          description: >-
            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:
          type: boolean
          description: >-
            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`.
    type_:CardSetup:
      type: object
      properties:
        acceptAmex:
          type: boolean
          description: Determines whether American Express is accepted.
        acceptDiscover:
          type: boolean
          description: Determines whether Discover is accepted.
        acceptMastercard:
          type: boolean
          description: Determines whether Mastercard is accepted.
        acceptVisa:
          type: boolean
          description: Determines whether Visa is accepted.
    type_:OdpSetupProcessingRegion:
      type: string
      enum:
        - value: US
        - value: CA
    type_:OdpSetup:
      type: object
      properties:
        allowAch:
          type: boolean
          description: Enables or disables ACH payout functionality
        allowChecks:
          type: boolean
          description: Enables or disables check printing payout functionality
        allowVCard:
          type: boolean
          description: Enables or disables vCard payout functionality
        processing_region:
          $ref: '#/components/schemas/type_:OdpSetupProcessingRegion'
          description: Region where payment processing occurs
        processor:
          type: string
          description: Payment processor identifier
        issuerNetworkSettingsId:
          type: string
          description: Reference ID for the program enabled for ODP issuance
    type_:Services:
      type: object
      properties:
        ach:
          $ref: '#/components/schemas/type_:AchSetup'
        card:
          $ref: '#/components/schemas/type_:CardSetup'
        odp:
          $ref: '#/components/schemas/type_:OdpSetup'
    type_:StateNullable:
      type: string
    type_:PaypointSummary:
      type: object
      properties:
        amountSubs:
          type: number
          format: double
        amountTx:
          type: number
          format: double
        countSubs:
          type: integer
        countTx:
          type: integer
        customers:
          type: integer
    type_:Website:
      type: string
    type_:Zip:
      type: string
    type_:PaypointData:
      type: object
      properties:
        address1:
          $ref: '#/components/schemas/type_:AddressNullable'
        address2:
          $ref: '#/components/schemas/type_:AddressAddtlNullable'
        bankData:
          $ref: '#/components/schemas/type_:BankData'
        boardingId:
          $ref: '#/components/schemas/type_:BoardingId'
        city:
          $ref: '#/components/schemas/type_:CityNullable'
        contacts:
          $ref: '#/components/schemas/type_:ContactsField'
        country:
          $ref: '#/components/schemas/type_:CountryNullable'
        credentials:
          type: array
          items:
            $ref: '#/components/schemas/type_:PayabliCredentialsPascal'
        dbaName:
          $ref: '#/components/schemas/type_:Dbaname'
        externalPaypointID:
          $ref: '#/components/schemas/type_:ExternalPaypointId'
        fax:
          $ref: '#/components/schemas/type_:PhoneNumber'
          description: Fax number
        idPaypoint:
          $ref: '#/components/schemas/type_:Idpaypoint'
        legalName:
          $ref: '#/components/schemas/type_:Legalname'
        parentOrg:
          $ref: '#/components/schemas/type_:OrgData'
        paypointStatus:
          $ref: '#/components/schemas/type_:Paypointstatus'
        phone:
          $ref: '#/components/schemas/type_:PhoneNumber'
        serviceData:
          $ref: '#/components/schemas/type_:Services'
        state:
          $ref: '#/components/schemas/type_:StateNullable'
        summary:
          $ref: '#/components/schemas/type_:PaypointSummary'
        timeZone:
          $ref: '#/components/schemas/type_:Timezone'
        websiteAddress:
          $ref: '#/components/schemas/type_:Website'
        zip:
          $ref: '#/components/schemas/type_:Zip'
    type_:PaypointEntryConfig:
      type: object
      properties:
        EntryComment:
          type: string
        EntryLogo:
          type: string
        EntryName:
          type: string
        EntryPages:
          type: array
          items:
            $ref: '#/components/schemas/type_:PayabliPages'
        EntrySubtitle:
          type: string
        EntryTitle:
          type: string
        IdEntry:
          type: integer
          format: int64
        Paypoint:
          $ref: '#/components/schemas/type_:PaypointData'
    type_:ExternalProcessorInformation:
      type: string
    type_:Highticketamt:
      type: number
      format: double
    type_:LastModified:
      type: string
      format: date-time
    type_:License:
      type: string
    type_:Licensestate:
      type: string
    type_:Maddress:
      type: string
    type_:Maddress1:
      type: string
    type_:Mcity:
      type: string
    type_:Mcountry:
      type: string
    type_:Mstate:
      type: string
    type_:Mzip:
      type: string
    type_:OrgParentName:
      type: string
    type_:Owners:
      type: object
      properties:
        ownername:
          type: string
          description: >-
            Person who is registered as the beneficial owner of the business.
            This is a combination of first and last name.
        ownertitle:
          type: string
          description: The job title of the person such as CEO or director.
        ownerpercent:
          type: integer
          description: Percentage of ownership the person holds, in integer format.
        ownerssn:
          type: string
          description: >-
            The relevant identifier for the person such as a Social Security
            Number.
        ownerdob:
          type: string
          description: Owner's date of birth.
        ownerphone1:
          type: string
          description: Owner phone 1.
        ownerphone2:
          type: string
          description: Owner phone 2.
        owneremail:
          $ref: '#/components/schemas/type_:Email'
          description: Owner email.
        ownerdriver:
          type: string
          description: >-
            Owner driver's license ID number. Payabli strongly recommends
            including this.
        oaddress:
          type: string
          description: >-
            Owner street address. This must be the physical address of the
            owner, not a P.O. box.
        ocity:
          type: string
          description: Owner address city.
        ocountry:
          type: string
          description: >-
            Owner address country in ISO-3166-1 alpha 2 format. Check out
            https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
        odriverstate:
          type: string
          description: >-
            Owner driver's license State. Payabli strongly recommends including
            this.
        ostate:
          type: string
          description: Owner address state.
        ozip:
          type: string
          description: Owner address ZIP.
        additionalData:
          $ref: '#/components/schemas/type_:AdditionalDataString'
    type_:Ownership:
      type: array
      items:
        $ref: '#/components/schemas/type_:Owners'
    type_:OwnType:
      type: string
      enum:
        - value: Limited Liability Company
        - value: Non-Profit Org
        - value: Partnership
        - value: Private Corp
        - value: Public Corp
        - value: Tax Exempt
        - value: Government
        - value: Sole Proprietor
    type_:SalesCode:
      type: string
    type_:Taxfillname:
      type: string
    type_:TemplateId:
      type: integer
      format: int64
    type_:Whencharged:
      type: string
      enum:
        - value: When Service Provided
        - value: In Advance
    type_:Whendelivered:
      type: string
      enum:
        - value: 0-7 Days
        - value: 8-14 Days
        - value: 15-30 Days
        - value: Over 30 Days
    type_:Whenprovided:
      type: string
      enum:
        - value: 30 Days or Less
        - value: 31 to 60 Days
        - value: 60+ Days
    type_:Whenrefunded:
      type: string
      enum:
        - value: Exchange Only
        - value: No Refund or Exchange
        - value: More than 30 days
        - value: 30 Days or Less
    type_:QueryEntrypointResponseRecordsItem:
      type: object
      properties:
        AverageMonthlyVolume:
          $ref: '#/components/schemas/type_:Avgmonthly'
        AverageTicketAmount:
          $ref: '#/components/schemas/type_:Avgticketamt'
        BAddress1:
          $ref: '#/components/schemas/type_:Baddress1'
        BAddress2:
          $ref: '#/components/schemas/type_:Baddress2'
        BankData:
          $ref: '#/components/schemas/type_:BankData'
        BCity:
          $ref: '#/components/schemas/type_:Bcity'
        BCountry:
          $ref: '#/components/schemas/type_:Bcountry'
        BFax:
          $ref: '#/components/schemas/type_:Bphone'
          description: The business's fax number.
        BinPerson:
          $ref: '#/components/schemas/type_:Binperson'
        BinPhone:
          $ref: '#/components/schemas/type_:Binphone'
        BinWeb:
          $ref: '#/components/schemas/type_:Binweb'
        BoardingId:
          $ref: '#/components/schemas/type_:BoardingId'
        BPhone:
          $ref: '#/components/schemas/type_:Bphone'
        BStartdate:
          $ref: '#/components/schemas/type_:Busstartdate'
        BState:
          $ref: '#/components/schemas/type_:Bstate'
        BSummary:
          $ref: '#/components/schemas/type_:Bsummary'
        BTimeZone:
          $ref: '#/components/schemas/type_:Timezone'
        BZip:
          $ref: '#/components/schemas/type_:Bzip'
        ContactData:
          $ref: '#/components/schemas/type_:ContactsField'
        CreatedAt:
          $ref: '#/components/schemas/type_:CreatedAt'
        DbaName:
          $ref: '#/components/schemas/type_:Dbaname'
        DocumentsRef:
          type: string
        Ein:
          $ref: '#/components/schemas/type_:Ein'
        EntryPoints:
          type: array
          items:
            $ref: '#/components/schemas/type_:PaypointEntryConfig'
        externalPaypointID:
          $ref: '#/components/schemas/type_:ExternalPaypointId'
        ExternalProcessorInformation:
          $ref: '#/components/schemas/type_:ExternalProcessorInformation'
        HighTicketAmount:
          $ref: '#/components/schemas/type_:Highticketamt'
        IdPaypoint:
          $ref: '#/components/schemas/type_:Idpaypoint'
        LastModified:
          $ref: '#/components/schemas/type_:LastModified'
        LegalName:
          $ref: '#/components/schemas/type_:Legalname'
        License:
          $ref: '#/components/schemas/type_:License'
        LicenseState:
          $ref: '#/components/schemas/type_:Licensestate'
        MAddress1:
          $ref: '#/components/schemas/type_:Maddress'
        MAddress2:
          $ref: '#/components/schemas/type_:Maddress1'
        Mccid:
          type: string
        MCity:
          $ref: '#/components/schemas/type_:Mcity'
        MCountry:
          $ref: '#/components/schemas/type_:Mcountry'
        MState:
          $ref: '#/components/schemas/type_:Mstate'
        MZip:
          $ref: '#/components/schemas/type_:Mzip'
        OrgId:
          $ref: '#/components/schemas/type_:Orgid'
        OrgParentName:
          $ref: '#/components/schemas/type_:OrgParentName'
        OwnerData:
          $ref: '#/components/schemas/type_:Ownership'
        OwnType:
          $ref: '#/components/schemas/type_:OwnType'
        PaypointStatus:
          $ref: '#/components/schemas/type_:Paypointstatus'
        SalesCode:
          $ref: '#/components/schemas/type_:SalesCode'
        ServiceData:
          $ref: '#/components/schemas/type_:Services'
        summary:
          $ref: '#/components/schemas/type_:PaypointSummary'
        Taxfillname:
          $ref: '#/components/schemas/type_:Taxfillname'
        TemplateId:
          $ref: '#/components/schemas/type_:TemplateId'
        WebsiteAddress:
          $ref: '#/components/schemas/type_:Website'
          description: Business website.
        Whencharged:
          $ref: '#/components/schemas/type_:Whencharged'
        Whendelivered:
          $ref: '#/components/schemas/type_:Whendelivered'
        Whenprovided:
          $ref: '#/components/schemas/type_:Whenprovided'
        Whenrefund:
          $ref: '#/components/schemas/type_:Whenrefunded'
    type_:Pagesize:
      type: integer
    type_:Totalrecords:
      type: integer
    type_:QuerySummary:
      type: object
      properties:
        pageIdentifier:
          $ref: '#/components/schemas/type_:PageIdentifier'
        pageSize:
          $ref: '#/components/schemas/type_:Pagesize'
        totalAmount:
          type: number
          format: double
          description: Total amount for the records.
        totalNetAmount:
          type: number
          format: double
          description: Total net amount for the records.
        totalPages:
          $ref: '#/components/schemas/type_:Totalrecords'
        totalRecords:
          $ref: '#/components/schemas/type_:Totalrecords'
    type_:QueryEntrypointResponse:
      type: object
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/type_:QueryEntrypointResponseRecordsItem'
        Summary:
          $ref: '#/components/schemas/type_:QuerySummary'

```

## SDK Code Examples

```typescript
import { PayabliClient, PayabliEnvironment } from "@payabli/sdk-node";

async function main() {
    const client = new PayabliClient({
        environment: PayabliEnvironment.Sandbox,
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.query.listPaypoints(123, {
        fromRecord: 251,
        limitRecord: 0,
        sortBy: "desc(field_name)",
    });
}
main();

```

```python
from payabli import payabli
from payabli.environment import payabliEnvironment

client = payabli(
    environment=payabliEnvironment.SANDBOX,
    api_key="YOUR_API_KEY_HERE"
)

client.query.list_paypoints(
    org_id=123,
    from_record=251,
    limit_record=0,
    sort_by="desc(field_name)"
)

```

```csharp
using PayabliApi;
using System.Threading.Tasks;

namespace Usage;

public class Example
{
    public async Task Do() {
        var client = new PayabliApiClient(
            apiKey: "YOUR_API_KEY_HERE",
            clientOptions: new ClientOptions {
                BaseUrl = PayabliApiEnvironment.Sandbox
            }
        );

        await client.Query.ListPaypointsAsync(
            123,
            new ListPaypointsRequest {
                FromRecord = 251,
                LimitRecord = 0,
                SortBy = "desc(field_name)"
            }
        );
    }

}

```

```go
package example

import (
    client "github.com/payabli/sdk-go/v/client"
    option "github.com/payabli/sdk-go/v/option"
    payabli "github.com/payabli/sdk-go/v"
    context "context"
)

func do() {
    client := client.NewClient(
        option.WithBaseURL(
            payabli.Environments.Sandbox,
        ),
        option.WithApiKey(
            "YOUR_API_KEY_HERE",
        ),
    )
    request := &payabli.ListPaypointsRequest{
        FromRecord: payabli.Int(
            251,
        ),
        LimitRecord: payabli.Int(
            0,
        ),
        SortBy: payabli.String(
            "desc(field_name)",
        ),
    }
    client.Query.ListPaypoints(
        context.TODO(),
        123,
        request,
    )
}

```

```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"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Query/paypoints/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Query/paypoints/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```swift
import Foundation

let headers = ["requestToken": "<apiKey>"]

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()
```