This is Payabli documentation. For a complete page index, fetch https://docs.payabli.com/llms.txt — append .md to any page URL for lightweight markdown. For section-level indexes, query parameters, and other AI-optimized access methods, see https://docs.payabli.com/ai-agents.md

# Get basic paypoint details by ID

GET https://api-sandbox.payabli.com/api/Paypoint/basicById/{IdPaypoint}

Retrieves the basic details for a paypoint by ID. 

Reference: https://docs.payabli.com/developers/api-reference/paypoint/get-paypoint-details-by-id

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: payabliApi
  version: 1.0.0
paths:
  /Paypoint/basicById/{IdPaypoint}:
    get:
      operationId: get-basic-entry-by-id
      summary: Get paypoint details by ID
      description: 'Retrieves the basic details for a paypoint by ID. '
      tags:
        - subpackage_paypoint
      parameters:
        - name: IdPaypoint
          in: path
          description: >-
            Paypoint ID. You can find this value by querying
            `/api/Query/paypoints/{orgId}`
          required: true
          schema:
            type: string
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_paypoint:GetBasicEntryByIdResponse'
        '400':
          description: Bad request/ invalid data
          content:
            application/json:
              schema:
                description: Any type
        '401':
          description: Unauthorized request.
          content:
            application/json:
              schema:
                description: Any type
        '500':
          description: Internal API Error
          content:
            application/json:
              schema:
                description: Any type
        '503':
          description: Database connection error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_:PayabliApiResponse'
servers:
  - url: https://api-sandbox.payabli.com/api
  - url: https://api.payabli.com/api
components:
  schemas:
    type_:IsSuccess:
      type: boolean
      description: >-
        Boolean indicating whether the operation was successful. A `true` value
        indicates success. A `false` value indicates failure.
      title: IsSuccess
    type_:PageIdentifier:
      type: string
      description: Auxiliary validation used internally by payment pages and components.
      title: PageIdentifier
    type_:Responsecode:
      type: integer
      description: >-
        Code for the response. Learn more in [API Response
        Codes](/developers/api-reference/api-responses).
      title: Responsecode
    type_:AdditionalData:
      type: object
      additionalProperties:
        type: object
        additionalProperties:
          description: Any type
      description: >-
        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](/developers/developer-guides/entities-customers),
        pass those in this object. Max length for a value is 100 characters.
        Example usage: 


        ```json

        {
          "additionalData": {
            "key1": "value1",
            "key2": "value2",
            "key3": "value3"
          }
        }

        ```
      title: AdditionalData
    type_:AccountId:
      type: string
      description: Custom identifier for payment connector.
      title: AccountId
    type_:GreaterValueAllowed:
      type: boolean
      description: >-
        Whether a customer fee greater than the configured service fee is
        allowed for this credential.
      title: GreaterValueAllowed
    type_:AbsorbDifference:
      type: boolean
      description: >-
        Whether the paypoint absorbs the difference between the configured
        service fee and the actual fee charged to the customer.
      title: AbsorbDifference
    type_:AllowOverride:
      type: boolean
      description: >-
        Whether the configured service fee can be overridden at the transaction
        level.
      title: AllowOverride
    type_:PayabliCredentials:
      type: object
      properties:
        accountId:
          $ref: '#/components/schemas/type_:AccountId'
          description: >-
            The identifier for the payment connector, matching the `accountId`
            of the linked bank account.
        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`.
        greaterValueAllowed:
          $ref: '#/components/schemas/type_:GreaterValueAllowed'
        absorbDifference:
          $ref: '#/components/schemas/type_:AbsorbDifference'
        allowOverride:
          $ref: '#/components/schemas/type_:AllowOverride'
      title: PayabliCredentials
    type_:Order:
      type: integer
      description: Order of element or section in container.
      title: Order
    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
      title: PayCategory
    type_:Enabled:
      type: boolean
      description: Toggles whether the section or element is enabled.
      title: Enabled
    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'
      title: AmountElement
    type_:Finishtype:
      type: object
      properties:
        calendar:
          type: boolean
          description: Flag to enable 'calendar' option
        untilCancelled:
          type: boolean
          description: Flag to enable 'untilCancelled' option
      title: Finishtype
    type_:FrequencyList:
      type: object
      properties:
        annually:
          type: boolean
          description: Enable or disable the annual frequency.
        every2Weeks:
          type: boolean
          description: Enable or disable the every-two-weeks frequency.
        every3Months:
          type: boolean
          description: Enable or disable the every-three-months frequency.
        every6Months:
          type: boolean
          description: Enable or disable the every-six-months frequency.
        monthly:
          type: boolean
          description: Enable or disable the monthly frequency.
        onetime:
          type: boolean
          description: Enable or disable the one-time frequency.
        weekly:
          type: boolean
          description: Enable or disable the weekly frequency.
      title: FrequencyList
    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.
      title: AutoElement
    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
      title: ContactElement
    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'
      title: LabelElement
    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
      title: InvoiceElement
    type_:Element:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/type_:Enabled'
        order:
          $ref: '#/components/schemas/type_:Order'
      title: Element
    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
      title: NoteElement
    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'
      title: PageElement
    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.
      title: MethodsList
    type_:MethodElementSettingsApplePayButtonStyle:
      type: string
      enum:
        - black
        - white-outline
        - white
      default: black
      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.
      title: MethodElementSettingsApplePayButtonStyle
    type_:MethodElementSettingsApplePayButtonType:
      type: string
      enum:
        - plain
        - buy
        - donate
        - check-out
        - book
        - continue
        - top-up
        - order
        - rent
        - support
        - contribute
        - tip
        - pay
      default: pay
      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.
      title: MethodElementSettingsApplePayButtonType
    type_:MethodElementSettingsApplePayLanguage:
      type: string
      enum:
        - 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
      default: en-US
      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.
      title: MethodElementSettingsApplePayLanguage
    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.
      title: MethodElementSettingsApplePay
    type_:MethodElementSettings:
      type: object
      properties:
        applePay:
          $ref: '#/components/schemas/type_:MethodElementSettingsApplePay'
      description: Settings for wallet payment methods.
      title: MethodElementSettings
    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.
      title: MethodElement
    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
      title: PayorFields
    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'
      title: PayorElement
    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'
      title: HeaderElement
    type_:Subdomain:
      type: string
      description: >-
        Refers to the payment page identifier. If provided, then the transaction
        is linked to the payment page.
      title: Subdomain
    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.
      title: PageContent
    type_:FileContentFtype:
      type: string
      enum:
        - pdf
        - doc
        - docx
        - jpg
        - jpeg
        - png
        - gif
        - txt
      description: The MIME type of the file (if content is provided)
      title: FileContentFtype
    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
      description: Contains details about a file. Max upload size is 30 MB.
      title: FileContent
    type_:ButtonElementSize:
      type: string
      enum:
        - sm
        - md
        - lg
      description: Specify size of custom payment button
      title: ButtonElementSize
    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
      title: ButtonElement
    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
      title: PageSetting
    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.
      title: DisplayProperty
    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.
      title: SettingElement
    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.
      description: Object containing receipt body configuration
      title: ReceiptContent
    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
      title: PayabliPages
    type_:AddressNullable:
      type: string
      description: The address.
      title: AddressNullable
    type_:AddressAddtlNullable:
      type: string
      description: Additional line for the address.
      title: AddressAddtlNullable
    type_:BankNickname:
      type: string
      description: User-defined name for the bank account.
      title: BankNickname
    type_:BankName:
      type: string
      description: Name of bank for account.
      title: BankName
    type_:RoutingAccount:
      type: string
      description: Routing number of bank account.
      title: RoutingAccount
    type_:AccountNumber:
      type: string
      description: >-
        Account number for bank account. This value is returned masked in
        responses.
      title: AccountNumber
    type_:TypeAccount:
      type: string
      enum:
        - Checking
        - Savings
      description: 'Type of bank account: Checking or Savings.'
      title: TypeAccount
    type_:BankAccountHolderName:
      type: string
      description: The accountholder's name.
      title: BankAccountHolderName
    type_:BankAccountHolderType:
      type: string
      enum:
        - Personal
        - Business
      description: Describes whether the bank is a personal or business account.
      title: BankAccountHolderType
    type_:BankAccountFunction:
      type: integer
      description: >-
        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).
      title: BankAccountFunction
    type_:Bank:
      type: object
      properties:
        id:
          type: integer
          description: The Payabli-assigned internal identifier for the bank account.
        accountId:
          $ref: '#/components/schemas/type_:AccountId'
          description: >-
            An identifier for the bank account, used to specify which account
            handles payments when multiple accounts are configured. If not
            provided during creation or update, the system generates one in the
            format `acct-{first_digit}xxxxx{last_4_digits}` based on the account
            number. The mask always uses five `x` characters regardless of
            account number length. For example, account number `123456789`
            produces `acct-1xxxxx6789`. If a duplicate exists within the same
            service at the paypoint, a numeric suffix is appended, such as
            `acct-1xxxxx6789-2`. This value is also used as the identifier for
            the bank account's associated payment connector.
        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
      description: Object that contains bank account details.
      title: Bank
    type_:BankData:
      type: array
      items:
        $ref: '#/components/schemas/type_:Bank'
      description: Information about associated bank accounts.
      title: BankData
    type_:BoardingId:
      type: integer
      format: int64
      description: >-
        The Payabli-assigned ID of the boarding application linked to this
        paypoint.
      title: BoardingId
    type_:CityNullable:
      type: string
      description: The city.
      title: CityNullable
    type_:Email:
      type: string
      format: email
      description: Email address.
      title: Email
    type_:AdditionalDataString:
      type: string
      description: >-
        Custom dictionary of key:value pairs. You can use this field to store
        any data related to the object or for your system. Example usage: 


        ```json

        {
          "additionalData": {
            "key1": "value1",
            "key2": "value2",
            "key3": "value3"
          }
        }

        ```
      title: AdditionalDataString
    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'
      title: Contacts
    type_:ContactsField:
      type: array
      items:
        $ref: '#/components/schemas/type_:Contacts'
      description: List of contacts.
      title: ContactsField
    type_:CountryNullable:
      type: string
      description: >-
        The country in ISO-3166-1 alpha 2 format. See
        https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
      title: CountryNullable
    type_:MinTicket:
      type: number
      format: double
      description: >-
        Minimum ticket amount for transactions within the paypoint. Contact
        Payabli support to request a change to this value.
      title: MinTicket
    type_:MaxTicket:
      type: number
      format: double
      description: >-
        Maximum ticket amount for transactions within the paypoint. Contact
        Payabli support to request a change to this value.
      title: MaxTicket
    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:
          $ref: '#/components/schemas/type_:AccountId'
          description: >-
            The identifier for the payment connector, matching the `accountId`
            of the linked bank account.
        ReferenceId:
          type: integer
          format: int64
        acceptSameDayACH:
          type: boolean
        Currency:
          type: string
          description: The default currency for the paypoint, either `USD` or `CAD`.
        GreaterValueAllowed:
          $ref: '#/components/schemas/type_:GreaterValueAllowed'
        AbsorbDifference:
          $ref: '#/components/schemas/type_:AbsorbDifference'
        AllowOverride:
          $ref: '#/components/schemas/type_:AllowOverride'
      title: PayabliCredentialsPascal
    type_:Dbaname:
      type: string
      description: >-
        The alternate or common name that this business is doing business under
        usually referred to as a DBA name.
      title: Dbaname
    type_:ExternalPaypointId:
      type: string
      description: >-
        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.
      title: ExternalPaypointId
    type_:PhoneNumber:
      type: string
      description: Phone number.
      title: PhoneNumber
    type_:Idpaypoint:
      type: integer
      format: int64
      description: Paypoint ID.
      title: Idpaypoint
    type_:Legalname:
      type: string
      description: Business legal name.
      title: Legalname
    type_:Orgid:
      type: integer
      format: int64
      description: Organization ID. Unique identifier assigned to an org by Payabli.
      title: Orgid
    type_:Orgaddress:
      type: string
      description: The organization's address.
      title: Orgaddress
    type_:Orgname:
      type: string
      description: The name of the organization.
      title: Orgname
    type_:Orgtype:
      type: integer
      description: The organization type. Currently, this must be `0`.
      title: Orgtype
    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'
      title: OrgData
    type_:Paypointstatus:
      type: integer
      description: |-
        The paypoint's status. 

        Active - `1`

        Inactive - 0
      title: Paypointstatus
    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`.
      title: AchSetup
    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.
      title: CardSetup
    type_:OdpSetupProcessingRegion:
      type: string
      enum:
        - US
        - CA
      description: Region where payment processing occurs
      title: OdpSetupProcessingRegion
    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
      title: OdpSetup
    type_:Services:
      type: object
      properties:
        ach:
          $ref: '#/components/schemas/type_:AchSetup'
        card:
          $ref: '#/components/schemas/type_:CardSetup'
        odp:
          $ref: '#/components/schemas/type_:OdpSetup'
      description: Controls which services will be enabled for the merchant.
      title: Services
    type_:StateNullable:
      type: string
      description: The state or province.
      title: StateNullable
    type_:PaypointSummary:
      type: object
      properties:
        amountSubs:
          type: number
          format: double
        amountTx:
          type: number
          format: double
        countSubs:
          type: integer
        countTx:
          type: integer
        customers:
          type: integer
      title: PaypointSummary
    type_:Timezone:
      type: integer
      description: Timezone, in UTC offset. For example, -5 is Eastern time.
      title: Timezone
    type_:Website:
      type: string
      description: >-
        The business website address. Include only the domain and TLD, do not
        enter the protocol (http/https). For example: `www.example.com` is
        acceptable.
      title: Website
    type_:Zip:
      type: string
      description: ZIP code for address.
      title: Zip
    type_:StatementEmailConfig:
      type: object
      properties:
        sender:
          type: string
          description: >-
            The email address from which statements are sent. Always uses a
            Payabli domain, for example `acme-partners@payabli.com`. If `null`,
            `noreply@payabli.com` is used.
        recipients:
          type: array
          items:
            type: string
          description: >-
            List of email addresses that receive billing statements. These are
            merchant or partner contacts.
      description: Configuration for statement email recipients and the sender address.
      title: StatementEmailConfig
    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'
        statementEmail:
          $ref: '#/components/schemas/type_:StatementEmailConfig'
          description: >-
            Configuration for billing statement email recipients and sender
            address. `null` if not configured.
      title: PaypointData
    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'
      title: PaypointEntryConfig
    type_:ResponseText:
      type: string
      description: 'Response text for operation: ''Success'' or ''Declined''.'
      title: ResponseText
    type_paypoint:GetBasicEntryByIdResponse:
      type: object
      properties:
        isSuccess:
          $ref: '#/components/schemas/type_:IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/type_:PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/type_:Responsecode'
        responseData:
          $ref: '#/components/schemas/type_:PaypointEntryConfig'
        responseText:
          $ref: '#/components/schemas/type_:ResponseText'
      required:
        - isSuccess
        - responseText
      title: GetBasicEntryByIdResponse
    type_:Responsedata:
      type: object
      additionalProperties:
        description: Any type
      description: The object containing the response data.
      title: Responsedata
    type_:PayabliApiResponse:
      type: object
      properties:
        isSuccess:
          $ref: '#/components/schemas/type_:IsSuccess'
        responseData:
          $ref: '#/components/schemas/type_:Responsedata'
        responseText:
          $ref: '#/components/schemas/type_:ResponseText'
      required:
        - responseText
      title: PayabliApiResponse
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: requestToken

```

## SDK Code Examples

```typescript Example Paypoint Entry response
import { PayabliClient } from "@payabli/sdk-node";

async function main() {
    const client = new PayabliClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.paypoint.getBasicEntryById("198");
}
main();

```

```python Example Paypoint Entry response
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY_HERE",
)

client.paypoint.get_basic_entry_by_id(
    id_paypoint="198",
)

```

```csharp Example Paypoint Entry response
using PayabliPayabliApi;
using System.Threading.Tasks;

namespace Usage;

public class Example
{
    public async Task Do() {
        var client = new PayabliPayabliApiClient(
            apiKey: "YOUR_API_KEY_HERE"
        );

        await client.Paypoint.GetBasicEntryByIdAsync(
            "198"
        );
    }

}

```

```go Example Paypoint Entry response
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/Paypoint/basicById/198"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("requestToken", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Example Paypoint Entry response
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Paypoint/basicById/198")

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 Example Paypoint Entry response
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Paypoint/basicById/198")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php Example Paypoint Entry response
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Paypoint/basicById/198', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

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

```swift Example Paypoint Entry response
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Paypoint/basicById/198")! 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()
```