openapi: 3.1.0
info:
  title: Payabli API
  description: |
    The Payabli API gives partners and developers programmatic access to Payabli's embedded
    payments platform — payment acceptance, payouts, and platform operations. See the
    [developer documentation](https://docs.payabli.com) for guides, recipes, and SDK references,
    or the [API overview](https://docs.payabli.com/developers/api-reference/api-overview) for
    environments, authentication, idempotency, and error handling.
  version: '1.0'
servers:
  - url: https://api-sandbox.payabli.com/api
    description: Sandbox
  - url: https://api.payabli.com/api
    description: Production
security:
  - APIKeyAuth: []
tags:
  - name: MoneyIn
    description: |
      The MoneyIn service handles all payment acceptance operations for receiving funds from customers. This includes processing card and ACH transactions through various flows: authorize-only for reserving funds, capture for completing authorized transactions, and single-step payment processing. The service supports transaction management operations like voiding, refunding, and reversing payments, along with specialized capabilities for ACH credit microdeposits, card validation without charges, and detailed transaction retrieval. All endpoints support idempotency keys for safe retry logic and can include extended transaction details when needed.
  - name: MoneyOut
    description: |
      The MoneyOut service manages all outbound payment operations for sending funds to vendors and recipients. It provides comprehensive payout functionality including authorization and capture workflows for payouts, batch operations for processing multiple transactions efficiently, and support for multiple payout methods including managed payouts, ACH transfers, checks, and virtual cards. The service includes detailed transaction tracking, vCard link delivery, check image retrieval, and cancellation capabilities. It supports complex scenarios like split funding and various vendor payment preferences while maintaining full audit trails of all payout activities.
  - name: Bill
    description: |
      The Bill service provides complete accounts payable management for tracking and paying vendor bills. It enables creation, modification, and deletion of bills with support for both one-time and scheduled recurring bills. The service handles bill attachments and document management, approval workflows with multi-user approval chains, and bill status tracking throughout the payment lifecycle. Bills can be linked to transactions, contain detailed line items with tax and discount calculations, and support various payment terms. The service integrates with vendor management and can automatically create bills from payout transactions or manage them independently.
  - name: Invoice
    description: |
      The Invoice service manages accounts receivable operations for billing customers and tracking payments. It provides full invoice lifecycle management including creation, modification, and deletion of invoices with support for both one-time and recurring scheduled invoices. The service handles invoice delivery via email, attachment management for supporting documents, and automatic invoice numbering with customizable prefixes. Invoices support detailed line items, shipping information, tax and discount calculations, and multiple payment terms. The service integrates with customer records, generates payment links for online payment, and tracks payment history including partial payments against invoices.
  - name: Customer
    description: |
      The Customer service provides comprehensive customer relationship management and identity tracking for payment operations. It handles creation, retrieval, updating, and deletion of customer records with flexible identifier configurations to match business requirements. The service manages customer contact information, billing and shipping addresses, and maintains customer status tracking. Customers can be linked to transactions, store multiple payment methods, manage subscriptions, and track consent preferences for communications. The service supports custom fields for additional data storage and integrates with stored payment methods and transaction history.
  - name: Vendor
    description: |
      The Vendor service manages vendor and supplier relationships for accounts payable operations. It provides complete vendor record management including creation, updates, and deletion with support for comprehensive vendor information like tax identification, multiple contact persons, and remittance details. The service handles vendor banking information for payment processing, tracks vendor status and enrollment for various payout methods, maintains separate billing and remittance addresses, and supports custom fields for internal tracking. Vendors can be associated with multiple payment methods, bills, and payout transactions while maintaining a complete activity history and summary statistics.
  - name: Boarding
    description: |
      The Boarding service handles merchant application and onboarding workflows for setting up new payment processing accounts. It manages the complete application lifecycle from submission through approval, supporting multiple processing types including Pay In, Managed Payout, and On-Demand Payout services. The service handles complex application data including business information, ownership details, banking setup, and service configuration. It supports resumable applications allowing merchants to save progress, document attachment management, and configurable boarding templates. The service includes boarding link generation for merchant self-service onboarding, application status tracking, and integration with underwriting workflows.
  - name: TokenStorage
    description: |
      The TokenStorage service provides secure payment method tokenization and vault management for storing sensitive payment data. It handles tokenization of both card and ACH payment methods, converting sensitive data into secure tokens for future use. The service supports both permanent token creation for recurring payments and temporary tokens for single-use scenarios, with automatic expiration. It includes features like anonymous tokenization, token-to-permanent conversion, fallback authorization for card verification, and ACH account validation. Stored tokens can be retrieved, updated, or removed, and are automatically linked to customer records for organized payment method management across all customer touchpoints.
  - name: Notification
    description: |
      The Notification service manages event-driven notifications and automated reporting across the platform. It enables creation of webhooks for real-time event notifications to external systems, email and SMS alerts for important events, and scheduled auto-generated reports for transaction data, returns, chargebacks, and other business metrics. The service supports flexible frequency options from one-time to daily, weekly, bi-weekly, and monthly schedules, with customizable content formats including JSON, CSV, Excel, and PDF. Notifications can be scoped to specific organizations or paypoints, and the service maintains notification history and delivery status tracking for audit purposes.
  - name: Organization
    description: |
      The Organization service provides multi-tenant organization hierarchy management and configuration. It handles creation and management of organizations and sub-organizations, maintaining parent-child relationships for partner and merchant structures. The service manages organization-level settings including branding with logos, contact information, timezone and localization preferences, and billing configurations. It provides user management within organizations, service cost configurations for residual calculations, and organization-wide settings that cascade to child entities. The service supports organization summaries with transaction and subscription metrics, and enables comprehensive organization search and filtering capabilities.
  - name: Paypoint
    description: |
      The Paypoint service manages merchant processing entities and their associated payment pages and configurations. It provides detailed paypoint information including business details, processing credentials, bank account configurations, and parent organization relationships. The service handles payment page creation and management with extensive customization options for form fields, styling, payment methods, and user experience flows. It supports multiple payment pages per paypoint, logo management, settings configuration for invoicing and custom fields, and paypoint migration between organizations. The service maintains comprehensive status tracking and summary statistics for each paypoint's transaction activity.
  - name: Subscription
    description: |
      The Subscription service manages recurring payment schedules and automatic billing operations. It provides comprehensive subscription lifecycle management including creation, modification, pausing, resuming, and cancellation of recurring payment plans. The service supports multiple frequency options from daily to yearly billing, flexible start dates and end dates, and customizable billing amounts that can include service fees. Subscriptions are linked to customers and stored payment methods, with automatic retry logic for failed payments. The service tracks subscription history, payment success rates, and provides detailed subscription status information including next billing dates and payment histories.
  - name: Query
    description: |
      The Query service provides advanced search and reporting capabilities across all transactional and operational data in the platform. It offers flexible query endpoints for transactions, bills, invoices, customers, vendors, boarding applications, vcards, and subscriptions with support for complex filtering using comparison operators, date ranges, text matching, and array operations. The service provides configurable pagination, sorting, and field selection with options to export results in multiple formats including JSON, CSV, Excel, and PDF. Queries can be scoped to specific entrypoints or organizations and support summary statistics alongside detailed record sets.
  - name: PaymentLink
    description: |
      The PaymentLink service generates secure, single-use or reusable payment links for remote payment collection. It creates customizable payment URLs that can be sent to customers via email, SMS, or other channels for self-service payment completion. Payment links support preset amounts or customer-entered amounts, expiration dates, and can be associated with specific invoices or bills. The service tracks link usage, payment completion status, and provides detailed analytics on link performance. Links can be configured with custom branding, specific payment methods, and include metadata for transaction tracking when customers complete payments.
  - name: Export
    description: |
      The Export service provides document and report generation capabilities for various business documents and data sets. It handles invoice PDF generation with customizable templates and branding, check image retrieval for completed payout transactions, and generated report file access for scheduled reports. The service supports multiple export formats and ensures proper document formatting for business use including logos, itemization, and payment details. Exported documents maintain proper audit trails and can be retrieved programmatically for integration with document management systems or accounting software.
  - name: Wallet
    description: |
      The Wallet service integrates digital wallet payment methods including Apple Pay and Google Pay for streamlined mobile and web checkout experiences. It handles wallet token validation, payment processing through tokenized credentials, and provides configuration management for enabling wallet payment options. The service manages the technical integration requirements for each wallet provider, handles token decryption and verification, and processes payments using wallet-provided tokens. It supports both one-time payments and tokenization for recurring use, while maintaining PCI compliance through wallet providers' secure token exchange mechanisms.
  - name: ChargeBacks
    description: |
      The Chargeback service manages dispute and chargeback operations for card transactions under review or reversal. It provides detailed chargeback information including reason codes, amounts, and dispute deadlines for merchant response. The service handles chargeback lifecycle tracking from initial notification through resolution, including status updates for representment submissions. It maintains comprehensive chargeback history and documentation, enables dispute response submission with supporting evidence, and provides analytics on chargeback rates and patterns. The service integrates with transaction records to link chargebacks to original payments and track financial impact.
  - name: Cloud
    description: |
      The CloudPayment service enables cloud-based payment terminal integration for in-person transaction processing through connected devices. It manages device pairing and authentication, transaction initiation to remote terminals, and transaction status monitoring for point-of-sale operations. The service handles various transaction types including sales, refunds, and tokenization through connected terminals while maintaining cloud communication for remote management. It supports multiple terminal types and manufacturers, manages terminal settings and configurations, and provides real-time transaction status updates. The service enables unified commerce experiences by bridging in-person and online payment channels.
  - name: User
    description: |
      The User service provides user account management, authentication, and access control across the platform. It handles user creation, profile management, password resets, and multi-factor authentication configuration for enhanced security. The service manages role-based access control with granular permissions for different organizational functions, supports user assignment to organizations and paypoints with appropriate scope restrictions, and tracks user activity including login history and access patterns. It enables user preference management for notifications, timezone settings, and language localization while maintaining comprehensive audit logs of user actions for compliance and security monitoring.
  - name: Import
    description: |
      The Import service enables bulk data loading operations for migrating or batch creating records across various entity types. It supports structured file uploads in formats like CSV and Excel for importing customers, vendors, bills, invoices, and transactions in bulk. The service provides validation of import data before processing, error reporting for invalid records, and partial import completion for valid records when some fail validation. It handles large datasets efficiently with progress tracking and maintains import history with detailed logs of records created, updated, or skipped. The service supports field mapping for flexible data source integration and provides rollback capabilities for failed imports.
  - name: LineItem
    description: |
      The LineItem service manages detailed line item data for invoices and bills including products, services, quantities, and pricing. It provides line item creation, modification, and deletion with support for complex pricing structures including unit costs, quantities, tax calculations, and discounts. Line items can include product codes, descriptions, commodity codes for Level 2/3 processing, and custom categories for reporting. The service calculates line totals and maintains consistency with document-level amounts, supports tax rate application, and enables detailed itemization for transparent billing. Line items integrate with inventory management and can include custom fields for specialized business requirements.
  - name: CheckCapture
    description: |
      The CheckCapture service handles remote check deposit and check conversion operations for accepting check payments electronically. It processes check images captured via mobile devices or scanners, performs image quality validation, and extracts MICR data for routing and account numbers. The service supports check 21 compliance for electronic check conversion and provides duplicate detection to prevent double deposits. It integrates with ACH processing to convert checks into electronic payments, maintains check images for record retention, and provides status tracking for check processing workflows. The service includes fraud detection capabilities and integrates with identity verification for risk management.
  - name: Templates
    description: |
      The Templates service manages customizable document and communication templates for invoices, receipts, emails, and boarding forms. It provides template creation, versioning, and management with support for dynamic field insertion, conditional content, and branding elements. Templates can be configured at organization or paypoint levels with inheritance and override capabilities. The service supports multiple template types including HTML email templates, PDF invoice templates, and boarding application layouts with customizable form fields. It enables consistent branding across customer communications while allowing flexibility for different business units or use cases through template variants.
  - name: Statistic
    description: |
      The Statistic service provides business intelligence and analytics capabilities with aggregated metrics and reporting data. It delivers dashboard-ready statistics including transaction volumes, payment success rates, revenue metrics, and trend analysis across configurable time periods. The service provides segmentation by payment method, geography, merchant, and other dimensions for detailed business insights. It calculates key performance indicators for payment operations, chargeback rates, average transaction values, and customer lifetime metrics. Statistics can be filtered by organization, paypoint, or date ranges and support comparative analysis for identifying trends and anomalies in payment processing activity.
  - name: PaymentMethodDomain
    description: |
      The PaymentMethodDomain service manages payment method domains and routing configurations for optimizing transaction success rates. It handles domain verification for Apple Pay, Google Pay, and other wallet integrations requiring merchant domain validation. The service configures payment method availability and routing rules based on transaction characteristics, merchant settings, and processor capabilities. It manages fallback logic for payment processing, enables A/B testing of payment flows, and provides configuration for payment method display order and availability by geography or transaction type. The service ensures proper technical setup for each payment method channel while optimizing for conversion and user experience.
  - name: Notificationlogs
    description: |
      The NotificationLogs service provides comprehensive logging and monitoring for all notification activities across the platform. It records detailed logs of webhook deliveries, email sends, SMS transmissions, and report generations including timestamps, status codes, and response data. The service enables troubleshooting of notification failures with detailed error messages and retry information, and provides audit trails for compliance requirements. Notification logs can be queried and filtered by notification type, status, date range, and destination, enabling operational monitoring of integration health and debugging of webhook issues. The service maintains retention policies for log data and provides statistics on notification delivery success rates.
  - name: Management
    description: |
      The Management service exposes operational utilities for paypoint administrators, including bank account verification against the verification network. It returns detailed verification results — bank name, account status, response codes, and account history — to support decision-making and troubleshooting beyond a simple pass/fail check. When bank authentication is enabled for the paypoint's organization, the service performs an identity verification check on the account holder; otherwise it performs an account existence check.
paths:
  /Bill/single/{entry}:
    post:
      operationId: bill_AddBill
      tags:
        - Bill
      x-fern-sdk-group-name: bill
      x-fern-sdk-method-name: AddBill
      x-fern-request-name: AddBillRequest
      summary: Add bill
      description: Creates a bill in an entrypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillOutData'
            example:
              billNumber: ABC-123
              netAmount: 3762.87
              billDate: '2024-07-01'
              dueDate: '2024-07-01'
              comments: Deposit for materials
              billItems:
                - itemProductCode: M-DEPOSIT
                  itemProductName: Materials deposit
                  itemDescription: Deposit for materials
                  itemCommodityCode: '010'
                  itemUnitOfMeasure: SqFt
                  itemCost: 5
                  itemQty: 1
                  itemMode: 0
                  itemCategories:
                    - deposits
                  itemTotalAmount: 123
                  itemTaxAmount: 7
                  itemTaxRate: 0.075
              mode: 0
              accountingField1: MyInternalId
              vendor:
                vendorNumber: 1234-A
              endDate: '2024-07-01'
              frequency: monthly
              terms: NET30
              status: -99
              attachments:
                - ftype: pdf
                  filename: my-doc.pdf
                  furl: https://mysite.com/my-doc.pdf
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillResponse'
              example:
                responseCode: 1
                pageIdentifier: null
                roomId: 0
                isSuccess: true
                responseText: Success
                responseData: 6101
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Bill/{idBill}:
    delete:
      operationId: bill_DeleteBill
      tags:
        - Bill
      x-fern-sdk-group-name: bill
      x-fern-sdk-method-name: DeleteBill
      x-fern-request-name: DeleteBillRequest
      summary: Delete bill
      description: Deletes a bill by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idBill
          in: path
          description: Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
          required: true
          schema:
            type: integer
          example: 285
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillResponse'
              example:
                responseCode: 1
                pageIdentifier: null
                roomId: 0
                isSuccess: true
                responseText: Success
                responseData: 6101
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: bill_EditBill
      tags:
        - Bill
      x-fern-sdk-group-name: bill
      x-fern-sdk-method-name: EditBill
      x-fern-request-name: EditBillRequest
      summary: Update bill
      description: Updates a bill by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idBill
          in: path
          description: Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
          required: true
          schema:
            type: integer
          example: 285
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillOutData'
            example:
              netAmount: 3762.87
              billDate: '2025-07-01'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EditBillResponse'
              example:
                responseCode: 1
                pageIdentifier: null
                roomId: 0
                isSuccess: true
                responseText: Success
                responseData: 6101
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    get:
      operationId: bill_GetBill
      tags:
        - Bill
      x-fern-sdk-group-name: bill
      x-fern-sdk-method-name: GetBill
      x-fern-request-name: GetBillRequest
      summary: Get bill
      description: Retrieves a bill by ID from an entrypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idBill
          in: path
          description: Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
          required: true
          schema:
            type: integer
          example: 285
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBillResponse'
              example:
                responseCode: 1
                pageIdentifier: null
                roomId: 0
                isSuccess: true
                responseText: Success
                responseData:
                  IdBill: 285
                  BillNumber: ABC-123
                  NetAmount: 100
                  Discount: null
                  TotalAmount: 100
                  BillDate: '2025-07-01'
                  DueDate: '2025-07-01'
                  Comments: Deposit for materials
                  BatchNumber: null
                  BillItems:
                    - itemTotalAmount: 123
                      itemTaxAmount: 7
                      itemTaxRate: 0.075
                      itemProductCode: M-DEPOSIT
                      itemProductName: Materials deposit
                      itemDescription: Deposit for materials.
                      itemCommodityCode: '010'
                      itemUnitOfMeasure: SqFt
                      itemCost: 5
                      itemQty: 1
                      itemMode: 0
                      itemCategories: null
                  Mode: 0
                  PaymentMethod: null
                  PaymentId: null
                  AccountingField1: MyInternalId
                  AccountingField2: MyInternalId
                  Terms: null
                  Source: null
                  AdditionalData: null
                  Vendor:
                    VendorNumber: '1234'
                    Name1: Herman's Coatings and Masonry
                    Name2: ''
                    EIN: XXXX6789
                    Phone: '5555555555'
                    Email: contact@hermanscoatings.com
                    RemitEmail: null
                    Address1: 123 Ocean Drive
                    Address2: Suite 400
                    City: Miami
                    State: FL
                    Zip: '33139'
                    Country: US
                    Mcc: '7777'
                    LocationCode: MIA123
                    Contacts:
                      - ContactName: Herman Martinez
                        ContactEmail: herman@hermanscoatings.com
                        ContactTitle: Owner
                        ContactPhone: '3055550000'
                    BillingData:
                      id: 123
                      accountId: acct-1xxxxx3123
                      nickname: Checking Account
                      bankName: Country Bank
                      routingAccount: '123123123'
                      accountNumber: 1XXXXXX3123
                      typeAccount: Checking
                      bankAccountHolderName: Gruzya Adventure Outfitters LLC
                      bankAccountHolderType: Business
                      bankAccountFunction: 0
                      verified: true
                      status: 1
                      services: []
                      default: true
                    PaymentMethod: vcard
                    VendorStatus: 1
                    VendorId: 1234
                    EnrollmentStatus: null
                    Summary:
                      ActiveBills: 5
                      PendingBills: 2
                      InTransitBills: 1
                      PaidBills: 10
                      OverdueBills: 0
                      ApprovedBills: 3
                      DisapprovedBills: 0
                      TotalBills: 21
                      ActiveBillsAmount: 1500
                      PendingBillsAmount: 500
                      InTransitBillsAmount: 200
                      PaidBillsAmount: 3000
                      OverdueBillsAmount: 0
                      ApprovedBillsAmount: 800
                      DisapprovedBillsAmount: 0
                      TotalBillsAmount: 6000
                    PaypointLegalname: Gruzya Adventure Outfitters LLC
                    PaypointDbaname: Gruzya Adventure Outfitters
                    PaypointEntryname: 41035afaa7
                    ParentOrgName: Pilgrim Planner
                    ParentOrgId: 1232
                    CreatedDate: '2022-07-01T15:00:01Z'
                    LastUpdated: '2022-07-01T15:00:01Z'
                    remitAddress1: 123 Walnut Street
                    remitAddress2: Suite 900
                    remitCity: Miami
                    remitState: FL
                    remitZip: '31113'
                    remitCountry: US
                    payeeName1: Herman Martinez
                    payeeName2: ''
                    customField1: ''
                    customField2: ''
                    customerVendorAccount: A-37622
                    InternalReferenceId: 123
                    additionalData:
                      customField: Custom Value 1
                      reference: REF-12345
                      notes: Additional vendor information
                    externalPaypointID: ext123
                    StoredMethods: []
                  Status: -99
                  CreatedAt: '2025-07-01T15:00:01Z'
                  EndDate: null
                  LastUpdated: '2025-07-01T15:00:01Z'
                  Frequency: null
                  billEvents:
                    - description: Created Bill
                      eventTime: '2025-07-01T15:00:01Z'
                      refData: REF-12345
                      extraData: null
                      source: API
                  billApprovals: null
                  PaypointLegalname: Gruzya Adventure Outfitters LLC
                  PaypointDbaname: Gruzya Adventure Outfitters
                  ParentOrgId: 1232
                  ParentOrgName: Pilgrim Planner
                  PaypointEntryname: 41035afaa7
                  paylinkId: null
                  DocumentsRef:
                    zipfile: documents_285.zip
                    filelist:
                      - originalName: invoice.pdf
                        zipName: 0_invoice.pdf
                        descriptor: Invoice document
                  externalPaypointID: null
                  LotNumber: LOT-285
                  EntityID: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Bill/attachedFileFromBill/{idBill}/{filename}:
    delete:
      operationId: bill_deleteAttachedFromBill
      tags:
        - Bill
      x-fern-sdk-group-name: bill
      x-fern-sdk-method-name: deleteAttachedFromBill
      x-fern-request-name: deleteAttachedFromBillRequest
      summary: Delete attached file from bill
      description: Delete a file attached to a bill.
      security:
        - APIKeyAuth: []
      parameters:
        - name: filename
          in: path
          description: |-
            The filename in Payabli. Get this from the `zipName` field
            in the `DocumentsRef.filelist` array returned by
            `/api/Bill/{idBill}`. Example: `0_Bill.pdf`.
          required: true
          schema:
            type: string
          example: 0_Bill.pdf
        - name: idBill
          in: path
          description: Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
          required: true
          schema:
            type: integer
          example: 285
        - name: returnObject
          in: query
          description: When `true`, the response includes the full bill object.
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillResponse'
              example:
                responseCode: 1
                pageIdentifier: null
                roomId: 0
                isSuccess: true
                responseText: Success
                responseData: 6101
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    get:
      operationId: bill_getAttachedFromBill
      tags:
        - Bill
      x-fern-sdk-group-name: bill
      x-fern-sdk-method-name: getAttachedFromBill
      x-fern-request-name: getAttachedFromBillRequest
      summary: Get attached file from bill
      description: Retrieves a file attached to a bill, either as a binary file or as a Base64-encoded string.
      security:
        - APIKeyAuth: []
      parameters:
        - name: filename
          in: path
          description: |-
            The filename in Payabli. Get this from the `zipName` field
            in the `DocumentsRef.filelist` array returned by
            `/api/Bill/{idBill}`. Example: `0_Bill.pdf`.
          required: true
          schema:
            type: string
          example: 0_Bill.pdf
        - name: idBill
          in: path
          description: Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
          required: true
          schema:
            type: integer
          example: 285
        - name: returnObject
          in: query
          description: When `true`, the request returns the file content as a Base64-encoded string.
          required: false
          schema:
            type: boolean
            default: false
          example: true
      responses:
        '200':
          description: A successful response returns a binary file when `returnObject` is `false`. When `returnObject` is `true`, the response contains the file content as a Base64-encoded string in an object. Due to technical limitations, only the object response is documented here.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileContent'
              example:
                fContent: TXkgdGVzdCBmaWxlHJ==...
                filename: my-doc.pdf
                ftype: pdf
                furl: https://mysite.com/my-doc.pdf
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Bill/approval/{idBill}:
    put:
      operationId: bill_ModifyApprovalBill
      tags:
        - Bill
      x-fern-sdk-group-name: bill
      x-fern-sdk-method-name: ModifyApprovalBill
      x-fern-request-name: ModifyApprovalBillRequest
      summary: Change bill approvers
      description: Modify the list of users the bill is sent to for approval.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idBill
          in: path
          description: Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
          required: true
          schema:
            type: integer
          example: 285
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyApprovalBillResponse'
              example:
                isSuccess: true
                responseData: 6101
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    post:
      operationId: bill_SendToApprovalBill
      tags:
        - Bill
      x-fern-sdk-group-name: bill
      x-fern-sdk-method-name: SendToApprovalBill
      x-fern-request-name: SendToApprovalBillRequest
      summary: Send a bill to approval
      description: Send a bill to a user or list of users to approve.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idBill
          in: path
          description: Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
          required: true
          schema:
            type: integer
          example: 285
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
          example: 6B29FC40-CA47-1067-B31D-00DD010662DA
        - name: autocreateUser
          in: query
          description: Automatically create the target user for approval if they don't exist.
          required: false
          schema:
            type: boolean
            default: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillResponse'
              example:
                responseCode: 1
                pageIdentifier: null
                roomId: 0
                isSuccess: true
                responseText: Success
                responseData: 6101
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Bill/approval/{idBill}/{approved}:
    get:
      operationId: bill_SetApprovedBill
      tags:
        - Bill
      x-fern-sdk-group-name: bill
      x-fern-sdk-method-name: SetApprovedBill
      x-fern-request-name: SetApprovedBillRequest
      summary: Approve or disapprove a bill
      description: Approve or disapprove a bill by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: approved
          in: path
          description: 'String representing the approved status. Accepted values: ''true'' or ''false''.'
          required: true
          schema:
            type: string
          example: 'true'
        - name: idBill
          in: path
          description: Payabli ID for the bill. Get this ID by querying `/api/Query/bills/` for the entrypoint or the organization.
          required: true
          schema:
            type: integer
          example: 285
        - name: email
          in: query
          description: Email or username of user modifying approval status.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetApprovedBillResponse'
              example:
                isSuccess: true
                responseData: 6101
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/bills/{entry}:
    get:
      operationId: bill_ListBills
      tags:
        - Bill
      x-fern-sdk-group-name: bill
      x-fern-sdk-method-name: ListBills
      x-fern-request-name: ListBillsRequest
      summary: Get list of bills for entrypoint
      description: Retrieve a list of bills for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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 isn't 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `frequency` (`in`, `nin`, `ne`, `eq`)
            - `method` (`in`, `nin`, `eq`, `ne`)
            - `event` (`in`, `nin`, `eq`, `ne`)
            - `target` (`ct`, `nct`, `eq`, `ne`)
            - `status` (`eq`, `ne`)
            - `approvalUserId` (`eq`, `ne`)
            - `parentOrgId` (`ne`, `eq`, `nin`, `in`)
            - `approvalUserEmail` (`eq`, `ne`)
            - `scheduleId` (`ne`, `eq`)

            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: `totalAmount(gt)=20` returns all records with a `totalAmount` that's greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillQueryResponse'
              example:
                Summary:
                  pageidentifier: null
                  pageSize: 20
                  total2approval: 1
                  totalactive: 1
                  totalAmount: 1.1
                  totalamount2approval: 1.1
                  totalamountactive: 1.1
                  totalamountapproved: 1.1
                  totalamountcancel: 1.1
                  totalamountdisapproved: 1.1
                  totalamountintransit: 1.1
                  totalamountoverdue: 1.1
                  totalamountpaid: 1.1
                  totalamountsent2approval: 1.1
                  totalapproved: 1
                  totalcancel: 1
                  totaldisapproved: 1
                  totalintransit: 1
                  totaloverdue: 1
                  totalPages: 1
                  totalpaid: 1
                  totalRecords: 2
                  totalsent2approval: 1
                Records:
                  - AdditionalData: null
                    billApprovals:
                      - approved: 0
                        approvedTime: '2024-03-13T15:54:27Z'
                        email: lisandra@example.com
                        Id: 34
                      - approved: 0
                        approvedTime: '2024-03-13T15:54:27Z'
                        email: jccastillo@example.com
                        Id: 293
                    BillDate: '2025-03-10'
                    billEvents:
                      - description: Created Bill
                        eventTime: '2024-03-13T15:54:26Z'
                        refData: 00-45e1c2d8b53b72fafc4082f374e68753-ffea4ba4c2ce63ce-00
                      - description: Sent to Approval
                        eventTime: '2024-03-13T15:54:28Z'
                        refData: 00-086a951822211bc2eb1803ed64db9d4f-0f07e0e8c394e481-00
                    BillItems:
                      - itemCommodityCode: Commod-MI-2024031926
                        itemCost: 200
                        itemDescription: Consultation price
                        itemMode: 0
                        itemProductCode: Prod-MI-2024031926
                        itemProductName: Consultation
                        itemQty: 1
                        itemTaxAmount: 0
                        itemTaxRate: 0
                        itemTotalAmount: 200
                        itemUnitOfMeasure: per each
                    BillNumber: MI-bill-2024031926
                    Comments: PAYBILL
                    CreatedAt: '2024-03-13T15:54:26Z'
                    Discount: 0
                    DocumentsRef: null
                    DueDate: '2025-03-10'
                    EndDate: null
                    EntityID: null
                    externalPaypointID: micasa-10
                    Frequency: onetime
                    IdBill: 6104
                    LastUpdated: '2024-03-13T10:54:26Z'
                    LotNumber: LOT123
                    Mode: 0
                    NetAmount: 200
                    ParentOrgId: 1001
                    ParentOrgName: Fitness Hub
                    PaymentId: null
                    PaymentMethod: null
                    paylinkId: null
                    PaypointDbaname: MiCasa Sports
                    PaypointEntryname: micasa
                    PaypointLegalname: MiCasa Sports LLC
                    Source: web
                    Status: 2
                    Terms: NET30
                    TotalAmount: 200
                    Transaction: null
                    Vendor:
                      Address1: 1234 Liberdad St.
                      Address2: Suite 100
                      BillingData:
                        accountNumber: 12345XXXX
                        bankAccountFunction: 0
                        bankAccountHolderName: Elena Gomez
                        bankAccountHolderType: Business
                        bankName: Michigan Savings Bank
                        id: 0
                        routingAccount: '072000326'
                        typeAccount: Checking
                      City: Detroit
                      Country: US
                      EIN: XXXXX6789
                      Email: elenag@industriesexample.com
                      InternalReferenceId: 1215
                      Mcc: '700'
                      Name1: Gomez-Radulescu Industries
                      Name2: Elena
                      Phone: 517-555-0123
                      State: MI
                      VendorId: 8723
                      VendorNumber: MI-vendor-2024031926
                      VendorStatus: 1
                      Zip: '48201'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/bills/org/{orgId}:
    get:
      operationId: bill_ListBillsOrg
      tags:
        - Bill
      x-fern-sdk-group-name: bill
      x-fern-sdk-method-name: ListBillsOrg
      x-fern-request-name: ListBillsOrgRequest
      summary: Get list of bills for organization
      description: Retrieve a list of bills for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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 isn't 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `frequency` (in, nin, ne, eq)
            - `method` (in, nin, eq, ne)
            - `event` (in, nin, eq, ne)
            - `target` (ct, nct, eq, ne)
            - `status` (eq, ne)
            - `parentOrgId` (ne, eq, nin, in)
            - `approvalUserId` (eq, ne)
            - `approvalUserEmail` (eq, ne)

            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: totalAmount(gt)=20 return all records with totalAmount greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillQueryResponse'
              example:
                Summary:
                  pageidentifier: null
                  pageSize: 20
                  total2approval: 1
                  totalactive: 1
                  totalAmount: 1.1
                  totalamount2approval: 1.1
                  totalamountactive: 1.1
                  totalamountapproved: 1.1
                  totalamountcancel: 1.1
                  totalamountdisapproved: 1.1
                  totalamountintransit: 1.1
                  totalamountoverdue: 1.1
                  totalamountpaid: 1.1
                  totalamountsent2approval: 1.1
                  totalapproved: 1
                  totalcancel: 1
                  totaldisapproved: 1
                  totalintransit: 1
                  totaloverdue: 1
                  totalPages: 1
                  totalpaid: 1
                  totalRecords: 2
                  totalsent2approval: 1
                Records:
                  - AdditionalData: null
                    billApprovals:
                      - approved: 0
                        approvedTime: '2024-03-13T15:54:27Z'
                        email: lisandra@example.com
                        Id: 34
                      - approved: 0
                        approvedTime: '2024-03-13T15:54:27Z'
                        email: jccastillo@example.com
                        Id: 293
                    BillDate: '2025-03-10'
                    billEvents:
                      - description: Created Bill
                        eventTime: '2024-03-13T15:54:26Z'
                        refData: 00-45e1c2d8b53b72fafc4082f374e68753-ffea4ba4c2ce63ce-00
                      - description: Sent to Approval
                        eventTime: '2024-03-13T15:54:28Z'
                        refData: 00-086a951822211bc2eb1803ed64db9d4f-0f07e0e8c394e481-00
                    BillItems:
                      - itemCommodityCode: Commod-MI-2024031926
                        itemCost: 200
                        itemDescription: Consultation price
                        itemMode: 0
                        itemProductCode: Prod-MI-2024031926
                        itemProductName: Consultation
                        itemQty: 1
                        itemTaxAmount: 0
                        itemTaxRate: 0
                        itemTotalAmount: 200
                        itemUnitOfMeasure: per each
                    BillNumber: MI-bill-2024031926
                    Comments: PAYBILL
                    CreatedAt: '2024-03-13T15:54:26Z'
                    Discount: 0
                    DocumentsRef: null
                    DueDate: '2025-03-10'
                    EndDate: null
                    EntityID: null
                    externalPaypointID: micasa-10
                    Frequency: onetime
                    IdBill: 6104
                    LastUpdated: '2024-03-13T10:54:26Z'
                    LotNumber: LOT123
                    Mode: 0
                    NetAmount: 200
                    ParentOrgId: 1001
                    ParentOrgName: Fitness Hub
                    PaymentId: null
                    PaymentMethod: null
                    paylinkId: null
                    PaypointDbaname: MiCasa Sports
                    PaypointEntryname: micasa
                    PaypointLegalname: MiCasa Sports LLC
                    Source: web
                    Status: 2
                    Terms: NET30
                    TotalAmount: 200
                    Transaction: null
                    Vendor:
                      Address1: 1234 Liberdad St.
                      Address2: Suite 100
                      BillingData:
                        accountNumber: 12345XXXX
                        bankAccountFunction: 0
                        bankAccountHolderName: Elena Gomez
                        bankAccountHolderType: Business
                        bankName: Michigan Savings Bank
                        id: 0
                        routingAccount: '072000326'
                        typeAccount: Checking
                      City: Detroit
                      Country: US
                      EIN: XXXXX6789
                      Email: elenag@industriesexample.com
                      InternalReferenceId: 1215
                      Mcc: '700'
                      Name1: Gomez-Radulescu Industries
                      Name2: Elena
                      Phone: 517-555-0123
                      State: MI
                      VendorId: 8723
                      VendorNumber: MI-vendor-2024031926
                      VendorStatus: 1
                      Zip: '48201'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Customer/single/{entry}:
    post:
      operationId: customer_AddCustomer
      tags:
        - Customer
      x-fern-sdk-group-name: customer
      x-fern-sdk-method-name: AddCustomer
      x-fern-request-name: AddCustomerRequest
      summary: Add customer
      description: |-
        Creates a customer in an entrypoint. An identifier is required to create customer records. Change your identifier settings in Settings > Custom Fields in PartnerHub.
        If you don't include an identifier, the record is rejected.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entrypoint identifier.
          schema:
            $ref: '#/components/schemas/Entrypointfield'
          example: 8cfec329267
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
        - name: forceCustomerCreation
          in: query
          description: When `true`, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.
          required: false
          schema:
            type: boolean
            default: false
        - name: replaceExisting
          in: query
          description: 'Flag indicating to replace existing customer with a new record. Possible values: 0 (don''t replace), 1 (replace). Default is `0`.'
          required: false
          schema:
            type: integer
            default: 0
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerData'
            example:
              customerNumber: 12356ACB
              firstname: Irene
              lastname: Canizales
              address1: 123 Bishop's Trail
              city: Mountain City
              state: TN
              zip: '37612'
              country: US
              email: irene@canizalesconcrete.com
              identifierFields:
                - email
              timeZone: -5
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseCustomerQuery'
              example:
                isSuccess: true
                responseData:
                  customerId: 17264
                  customerNumber: 12356ACB
                  customerUsername: null
                  customerStatus: 0
                  Company: null
                  Firstname: Irene
                  Lastname: Canizales
                  Phone: null
                  Email: irene@canizalesconcrete.com
                  Address: null
                  Address1: 123 Bishop's Trail
                  City: Mountain City
                  State: TN
                  Zip: '37612'
                  Country: US
                  ShippingAddress: null
                  ShippingAddress1: null
                  ShippingCity: null
                  ShippingState: null
                  ShippingZip: null
                  ShippingCountry: null
                  Balance: 0
                  TimeZone: -5
                  MFA: false
                  MFAMode: 0
                  snProvider: null
                  snIdentifier: null
                  snData: null
                  LastUpdated: '2024-03-13T12:49:56Z'
                  Created: '2024-03-13T12:49:56Z'
                  AdditionalFields:
                    key: value
                  IdentifierFields:
                    - email
                  Subscriptions: null
                  StoredMethods: null
                  customerSummary:
                    NumberofTransactions: 30
                    RecentTransactions:
                      - EntrypageId: 0
                        FeeAmount: 1
                        PayorId: 1551
                        PaypointId: 226
                        SettlementStatus: 2
                        splitCount: 0
                        TotalAmount: 30.22
                        TransStatus: 1
                    TotalAmountTransactions: 1500
                    TotalNetAmountTransactions: 1500
                  PaypointLegalname: Gruzya Adventure Outfitters, LLC
                  PaypointDbaname: Gruzya Adventure Outfitters
                  ParentOrgName: The Pilgrim Planner
                  ParentOrgId: 123
                  PaypointEntryname: 41035afaa7
                  pageidentifier: 'null'
                  externalPaypointID: null
                  customerConsent: null
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Customer/{customerId}:
    delete:
      operationId: customer_DeleteCustomer
      tags:
        - Customer
      x-fern-sdk-group-name: customer
      x-fern-sdk-method-name: DeleteCustomer
      x-fern-request-name: DeleteCustomerRequest
      summary: Delete customer record
      description: Delete a customer record.
      security:
        - APIKeyAuth: []
      parameters:
        - name: customerId
          in: path
          description: Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
          required: true
          schema:
            type: integer
          example: 998
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
              example:
                responseCode: 1
                isSuccess: true
                pageIdentifier: 'null'
                roomId: 0
                responseData: ' '
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    get:
      operationId: customer_GetCustomer
      tags:
        - Customer
      x-fern-sdk-group-name: customer
      x-fern-sdk-method-name: GetCustomer
      x-fern-request-name: GetCustomerRequest
      summary: Get customer record
      description: Retrieves a customer's record and details.
      security:
        - APIKeyAuth: []
      parameters:
        - name: customerId
          in: path
          description: Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
          required: true
          schema:
            type: integer
          example: 998
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerQueryRecords'
              example:
                customerId: 4440
                customerNumber: 3456-7645A
                customerUsername: myusername
                customerStatus: 1
                Company: AA LLC
                Firstname: John
                Lastname: Smith
                Phone: '1234567890'
                Email: example@email.com
                Address: 3245 Main St
                Address1: STE 900
                City: Miami
                State: FL
                Zip: '77777'
                Country: US
                ShippingAddress: 123 Walnut St
                ShippingAddress1: STE 900
                ShippingCity: Johnson City
                ShippingState: TN
                ShippingZip: '37619'
                ShippingCountry: US
                Balance: 1.1
                TimeZone: -5
                MFA: false
                MFAMode: 0
                snProvider: facebook
                snIdentifier: 6677fgttyudd999
                snData: ''
                LastUpdated: '2021-06-16T05:00:00Z'
                Created: '2021-06-10T05:00:00Z'
                AdditionalFields:
                  property1: string
                  property2: string
                IdentifierFields:
                  - email
                Subscriptions:
                  - CreatedAt: '2022-07-01T15:00:01Z'
                    EndDate: '2025-10-19T00:00:00Z'
                    EntrypageId: 0
                    ExternalPaypointID: Paypoint-100
                    FeeAmount: 3
                    Frequency: monthly
                    IdSub: 396
                    LastRun: '2025-10-19T00:00:00Z'
                    LastUpdated: '2022-07-01T15:00:01Z'
                    LeftCycles: 15
                    Method: card
                    NetAmount: 3762.87
                    NextDate: '2025-10-19T00:00:00Z'
                    ParentOrgName: PropertyManager Pro
                    PaymentData:
                      paymentDetails:
                        totalAmount: 100
                    PaypointDbaname: Sunshine Gutters
                    PaypointEntryname: d193cf9a46
                    PaypointId: 255
                    PaypointLegalname: Sunshine Services, LLC
                    PlanId: 0
                    Source: api
                    StartDate: '2025-10-19T00:00:00Z'
                    SubEvents:
                      - description: TransferCreated
                        eventTime: '2023-07-05T22:31:06Z'
                    SubStatus: 1
                    TotalAmount: 103
                    TotalCycles: 24
                    UntilCancelled: true
                StoredMethods:
                  - IdPmethod: 6edcbb56-9c0e-4003-b3d1-99abf149ba0e
                    Method: card
                    Descriptor: visa
                    MaskedAccount: 4XXXXXXXX1111
                    ExpDate: '1227'
                    HolderName: Chad Mercia
                    AchSecCode: null
                    AchHolderType: null
                    IsValidatedACH: null
                    BIN: '411111'
                    binData:
                      binMatchedLength: '6'
                      binCardBrand: Visa
                      binCardType: Credit
                      binCardCategory: PLATINUM
                      binCardIssuer: Bank of Example
                      binCardIssuerCountry: United States
                      binCardIssuerCountryCodeA2: US
                      binCardIssuerCountryNumber: '840'
                      binCardIsRegulated: 'false'
                      binCardUseCategory: Consumer
                      binCardIssuerCountryCodeA3: USA
                    ABA: null
                    PostalCode: null
                    MethodType: null
                    WalletType: null
                    LastUpdated: '2022-07-01T15:00:01Z'
                    CardUpdatedOn: null
                customerSummary:
                  NumberofTransactions: 30
                  RecentTransactions:
                    - EntrypageId: 0
                      FeeAmount: 1
                      PayorId: 1551
                      PaypointId: 226
                      SettlementStatus: 2
                      splitCount: 0
                      TotalAmount: 30.22
                      TransStatus: 1
                  TotalAmountTransactions: 1500
                  TotalNetAmountTransactions: 1500
                PaypointLegalname: Sunshine Services, LLC
                PaypointDbaname: Sunshine Gutters
                ParentOrgName: PropertyManager Pro
                ParentOrgId: 123
                PaypointEntryname: d193cf9a46
                pageidentifier: 'null'
                externalPaypointID: Paypoint-100
                customerConsent:
                  eCommunication:
                    status: 1
                    updatedAt: '2022-07-01T15:00:01Z'
                  sms:
                    status: 1
                    updatedAt: '2022-07-01T15:00:01Z'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: customer_UpdateCustomer
      tags:
        - Customer
      x-fern-sdk-group-name: customer
      x-fern-sdk-method-name: UpdateCustomer
      x-fern-request-name: UpdateCustomerRequest
      summary: Update customer record
      description: Update a customer record. Include only the fields you want to change.
      security:
        - APIKeyAuth: []
      parameters:
        - name: customerId
          in: path
          description: Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
          required: true
          schema:
            type: integer
          example: 998
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerData'
            example:
              firstname: Irene
              lastname: Canizales
              address1: 145 Bishop's Trail
              city: Mountain City
              state: TN
              zip: '37612'
              country: US
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
              example:
                isSuccess: true
                responseCode: 1
                responseData: ' '
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Customer/{customerId}/consent:
    post:
      operationId: customer_RequestConsent
      tags:
        - Customer
      x-fern-sdk-group-name: customer
      x-fern-sdk-method-name: RequestConsent
      x-fern-request-name: RequestConsentRequest
      summary: Request consent opt-in
      description: Sends the consent opt-in email to the customer email address in the customer record.
      security:
        - APIKeyAuth: []
      parameters:
        - name: customerId
          in: path
          description: Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
          required: true
          schema:
            type: integer
          example: 998
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
              example:
                isSuccess: true
                pageIdentifier: 'null'
                responseCode: 1
                responseData: ' '
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Customer/link/{customerId}/{transId}:
    get:
      operationId: customer_LinkCustomerTransaction
      tags:
        - Customer
      x-fern-sdk-group-name: customer
      x-fern-sdk-method-name: LinkCustomerTransaction
      x-fern-request-name: LinkCustomerTransactionRequest
      summary: Link Customer to Transaction
      description: Links a customer to a transaction by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: customerId
          in: path
          description: Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
          required: true
          schema:
            type: integer
          example: 998
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          example: 45-as456777hhhhhhhhhh77777777-324
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
              example:
                responseCode: 1
                pageIdentifier: 'null'
                roomId: 0
                isSuccess: true
                responseText: Success
                responseData: ' '
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /CheckCapture/CheckProcessing:
    post:
      operationId: checkCapture_CheckProcessing
      tags:
        - CheckCapture
      x-fern-sdk-group-name: checkCapture
      x-fern-sdk-method-name: CheckProcessing
      x-fern-request-name: CheckCaptureRequestBody
      summary: Process Check Capture
      description: Captures a check for Remote Deposit Capture (RDC) using the provided check images and details. This endpoint handles the OCR extraction of check data including MICR, routing number, account number, and amount. See the [RDC guide](/developers/developer-guides/pay-in-rdc) for more details.
      x-fern-availability: pre-release
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckCaptureRequestBody'
            example:
              entryPoint: 47abcfea12
              frontImage: /9j/4AAQSkZJRgABAQEASABIAAD...
              rearImage: /9j/4AAQSkZJRgABAQEASABIAAD...
              checkAmount: 12550
      responses:
        '200':
          description: Success response with check processing results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckCaptureResponse'
              example:
                id: txn_abc123def456
                success: true
                processDate: '2025-04-10T04:17:09.875Z'
                ocrMicr: ⑆123456789⑆ ⑈123456⑈ 0123
                ocrMicrStatus: SUCCESS
                ocrMicrConfidence: '95'
                ocrAccountNumber: '123456'
                ocrRoutingNumber: '123456789'
                ocrCheckNumber: '0123'
                ocrCheckTranCode: ''
                ocrAmount: '125.50'
                ocrAmountStatus: SUCCESS
                ocrAmountConfidence: '98'
                amountDiscrepancyDetected: false
                endorsementDetected: true
                errors: []
                messages:
                  - Check processed successfully
                carLarMatchConfidence: '97'
                carLarMatchStatus: MATCH
                checkType: 1
                referenceNumber: REF_XYZ789
                pageIdentifier: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/authorize:
    post:
      operationId: moneyIn_Authorize
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: Authorize
      x-fern-request-name: RequestPaymentAuthorize
      summary: Authorize card transaction
      description: |-
        Authorize a card transaction. This returns an authorization code and reserves funds for the merchant. Authorized transactions aren't flagged for settlement until [captured](/developers/api-reference/moneyin/capture-an-authorized-transaction).
        Only card transactions can be authorized. This endpoint can't be used for ACH transactions.
        <Tip>
          Consider migrating to the [v2 Authorize endpoint](/developers/api-reference/moneyinV2/authorize-a-transaction) to take advantage of unified response codes and improved response consistency.
        </Tip>
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
        - name: forceCustomerCreation
          in: query
          required: false
          description: When `true`, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to `false`.
          schema:
            $ref: '#/components/schemas/ForceCustomerCreation'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransRequestBody'
            example:
              customerData:
                customerId: 4440
              entryPoint: f743aed24a
              ipaddress: 255.255.255.255
              paymentDetails:
                serviceFee: 0
                totalAmount: 100
              paymentMethod:
                cardcvv: '999'
                cardexp: 02/27
                cardHolder: John Cassian
                cardnumber: '4111111111111111'
                cardzip: '12345'
                initiator: payor
                method: card
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
              example:
                responseText: Success
                isSuccess: true
                pageIdentifier: null
                responseData:
                  authCode: '123456'
                  referenceId: 10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13
                  resultCode: 1
                  resultText: Authorized
                  avsResponseText: No address or ZIP match only
                  cvvResponseText: CVV2/CVC2 no match
                  customerId: 4440
                  methodReferenceId: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/capture/{transId}/{amount}:
    get:
      operationId: moneyIn_Capture
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: Capture
      summary: Capture an authorized transaction
      description: |-
        <Warning>
          This endpoint is deprecated and will be sunset on November 24, 2025. Migrate to [POST `/capture/{transId}`](/developers/api-reference/moneyin/capture-an-authorized-transaction)`.
        </Warning>

          Capture an [authorized
        transaction](/developers/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: amount
          in: path
          description: Amount to be captured. The amount can't be greater the original total amount of the transaction. `0` captures the total amount authorized in the transaction. Partial captures aren't supported.
          required: true
          schema:
            type: number
            format: double
          example: 0
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          example: 10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptureResponse'
              example:
                responseCode: 1
                pageIdentifier: null
                roomId: 0
                isSuccess: true
                responseText: Success
                responseData:
                  authCode: '123456'
                  referenceId: 10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13
                  resultCode: 1
                  resultText: SUCCESS
                  avsResponseText: null
                  cvvResponseText: null
                  customerId: null
                  methodReferenceId: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/capture/{transId}:
    post:
      operationId: moneyIn_CaptureAuth
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: CaptureAuth
      x-fern-request-name: CaptureAuthRequest
      description: |-
        Capture an [authorized transaction](/developers/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.

        You can use this endpoint to capture both full and partial amounts of the original authorized transaction. See [Capture an authorized transaction](/developers/developer-guides/pay-in-auth-and-capture) for more information about this endpoint.

        <Tip>
        Consider migrating to the [v2 Capture endpoint](/developers/api-reference/moneyinV2/capture-an-authorized-transaction) to take advantage of unified response codes and improved response consistency.
        </Tip>
      security:
        - APIKeyAuth: []
      parameters:
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          examples:
            CaptureFullAmountwithFee:
              value: 10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13
            CapturePartialAmountwithFee:
              value: 10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13
            CaptureNoFee:
              value: 10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CaptureRequest'
            examples:
              CaptureFullAmountwithFee:
                value:
                  paymentDetails:
                    totalAmount: 105
                    serviceFee: 5
              CapturePartialAmountwithFee:
                value:
                  paymentDetails:
                    totalAmount: 89
                    serviceFee: 4
              CaptureNoFee:
                value:
                  paymentDetails:
                    totalAmount: 100
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptureResponse'
              examples:
                CaptureFullAmountwithFee:
                  value:
                    responseCode: 1
                    pageIdentifier: null
                    roomId: 0
                    isSuccess: true
                    responseText: Success
                    responseData:
                      authCode: '123456'
                      referenceId: 10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13
                      resultCode: 1
                      resultText: SUCCESS
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: null
                      methodReferenceId: null
                CapturePartialAmountwithFee:
                  value:
                    responseCode: 1
                    pageIdentifier: null
                    roomId: 0
                    isSuccess: true
                    responseText: Success
                    responseData:
                      authCode: '123456'
                      referenceId: 10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13
                      resultCode: 1
                      resultText: SUCCESS
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: null
                      methodReferenceId: null
                CaptureNoFee:
                  value:
                    responseCode: 1
                    pageIdentifier: null
                    roomId: 0
                    isSuccess: true
                    responseText: Success
                    responseData:
                      authCode: '123456'
                      referenceId: 10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13
                      resultCode: 1
                      resultText: SUCCESS
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: null
                      methodReferenceId: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/makecredit:
    post:
      operationId: moneyIn_Credit
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: Credit
      x-fern-request-name: RequestCredit
      summary: Make an ACH credit transaction
      description: |-
        Make a temporary microdeposit in a customer account to verify the customer's ownership and access to the target account. Reverse the microdeposit with `reverseCredit`. Payabli doesn't automatically make microdeposits when you add a bank account, you must manually make the requests.

        This feature must be enabled by Payabli on a per-merchant basis. Contact support for help.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
          examples:
            MinimumFields:
              value: 6B29FC40-CA47-1067-B31D-00DD010662DA
            ComplexFields:
              value: 6B29FC40-CA47-1067-B31D-00DD010662DA
        - name: forceCustomerCreation
          in: query
          required: false
          description: When `true`, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to `false`.
          schema:
            $ref: '#/components/schemas/ForceCustomerCreation'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCredit'
            examples:
              MinimumFields:
                value:
                  customerData:
                    billingAddress1: 5127 Linkwood ave
                    customerNumber: '100'
                  entrypoint: my-entrypoint
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 1
                  paymentMethod:
                    achAccount: '88354454'
                    achAccountType: Checking
                    achHolder: John Smith
                    achRouting: '021000021'
                    method: ach
              ComplexFields:
                value:
                  customerData:
                    billingAddress1: 125 Main Street
                    billingCity: Kingsport
                    billingEmail: johnnyp@email.com
                    company: Acme, Inc
                    customerNumber: '100'
                    firstName: Johnny
                    lastName: Poulsbo
                  entrypoint: my-entrypoint
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 1
                  paymentMethod:
                    achAccount: '88354554'
                    achAccountType: Checking
                    achHolder: John Poulsbo
                    achRouting: 29000021
                    method: ach
      responses:
        '200':
          description: |-
            Success. The `referenceId` returned in a successful response is the `transId` value you need to reverse the microdeposit.

            A "Missing Gateway Data" message can indicate that the entrypoint targeted in the request isn't set up for ACH payments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse0'
              examples:
                MinimumFields:
                  value:
                    isSuccess: true
                    pageIdentifier: 'null'
                    responseData:
                      AuthCode: AuthCode
                      CustomerId: 4440
                      methodReferenceId: null
                      ReferenceId: 45-erre-324
                      ResultCode: 1
                      ResultText: Approved
                    responseText: Success
                ComplexFields:
                  value:
                    isSuccess: true
                    pageIdentifier: 'null'
                    responseData:
                      AuthCode: AuthCode
                      CustomerId: 4440
                      methodReferenceId: null
                      ReferenceId: 45-erre-324
                      ResultCode: 1
                      ResultText: Approved
                    responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/details/{transId}:
    get:
      operationId: moneyIn_Details
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: Details
      x-fern-request-name: DetailsRequest
      summary: Get details for a processed transaction
      description: Retrieve a processed transaction's details.
      security:
        - APIKeyAuth: []
      parameters:
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          example: 45-as456777hhhhhhhhhh77777777-324
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionQueryRecordsCustomer'
              example:
                BatchAmount: 10050.75
                BatchNumber: BN987654321
                CfeeTransactions:
                  - cFeeTransid: cFeeTransid
                    feeAmount: 1.1
                    operation: operation
                    refundId: 4440
                    responseData:
                      key: value
                    settlementStatus: 1
                    transactionTime: '2024-01-15T09:30:00Z'
                    transStatus: 1
                Customer:
                  AdditionalData:
                    key1: value1
                    key2: value2
                    key3: value3
                  BillingAddress1: 123 Willow Lane
                  BillingAddress2: Unit 101
                  BillingCity: Greenfield
                  BillingCountry: USA
                  BillingEmail: elizabeta.marion@email.com
                  BillingPhone: 831-555-0123
                  BillingState: CA
                  BillingZip: '93927'
                  customerId: 4440
                  CustomerNumber: CUST12345
                  customerStatus: 1
                  FirstName: Elizabeta
                  Identifiers:
                    - \"firstname\"
                    - \"lastname\"
                    - \"email\"
                    - \"customId\"
                  LastName: Marion
                  ShippingAddress1: 123 Willow Lane
                  ShippingAddress2: Unit 101
                  ShippingCity: Greenfield
                  ShippingCountry: USA
                  ShippingState: CA
                  ShippingZip: '93927'
                EntrypageId: 0
                ExternalProcessorInformation: '[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]'
                FeeAmount: 5
                GatewayTransId: GT12345678
                invoiceData:
                  AdditionalData: null
                  company: Wind in the Willows Neighborhood Association, LLC
                  discount: 0
                  dutyAmount: 0
                  firstName: Elizabeta
                  freightAmount: 0
                  frequency: onetime
                  invoiceAmount: 1000.5
                  invoiceDate: '2025-02-15'
                  invoiceDueDate: '2025-03-15'
                  invoiceEndDate: '2025-04-15'
                  invoiceNumber: INV-20242401
                  invoiceStatus: 1
                  invoiceType: 1
                  items:
                    - itemCategories:
                        - HOA Dues
                        - Annual Service
                      itemCommodityCode: '200300'
                      itemCost: 1000.5
                      itemDescription: Annual dues for Wind in the Willows HOA.
                      itemMode: 1
                      itemProductCode: HOADUES2024
                      itemProductName: HOA Annual Dues
                      itemQty: 1
                      itemTaxAmount: 0
                      itemTaxRate: 0
                      itemTotalAmount: 1000.5
                      itemUnitOfMeasure: service
                  lastName: Marion
                  notes: Annual HOA dues for Wind in the Willows Neighborhood.
                  paymentTerms: NET30
                  purchaseOrder: PO-4321ABC
                  shippingAddress1: 123 Willow Lane
                  shippingAddress2: Unit 101
                  shippingCity: Greenfield
                  shippingCountry: USA
                  shippingEmail: elizabeta.marion@email.com
                  shippingFromZip: '93926'
                  shippingPhone: 831-555-0123
                  shippingState: CA
                  shippingZip: '93927'
                  summaryCommodityCode: HOA2024
                  tax: 0
                  termsConditions: Full payment of HOA dues required within 30 days.
                Method: online
                NetAmount: 995.5
                Operation: Sale
                OrderId: DUES-123
                OrgId: 500
                ParentOrgName: HOAManager Pro
                PaymentData:
                  AccountExp: 11/29
                  AccountType: visa
                  AccountZip: '90210'
                  binData:
                    binMatchedLength: '6'
                    binCardBrand: Visa
                    binCardType: Credit
                    binCardCategory: PLATINUM
                    binCardIssuer: Bank of Example
                    binCardIssuerCountry: United States
                    binCardIssuerCountryCodeA2: US
                    binCardIssuerCountryNumber: '840'
                    binCardIsRegulated: 'false'
                    binCardUseCategory: Consumer
                    binCardIssuerCountryCodeA3: USA
                  HolderName: Elizabeta Marion
                  Initiator: merchant
                  MaskedAccount: 5xxxxxxxxxxx4321
                  orderDescription: Annual HOA Dues for Wind in the Willows
                  paymentDetails:
                    categories:
                      - amount: 1000
                        label: Deposit
                      - amount: 1000
                        label: Deposit
                    currency: USD
                    serviceFee: 5
                    splitFunding:
                      - {}
                    totalAmount: 1000.5
                  Sequence: first
                  SignatureData: image/png;base64,
                  StoredMethodUsageType: unscheduled
                PaymentTransId: 12345-67890abcd
                PayorId: 98765
                PaypointDbaname: Wind in the Willows
                PaypointEntryname: 72aeon12
                PaypointId: 12345
                PaypointLegalname: Wind in the Willows Neighborhood Association, LLC
                PendingFeeAmount: 0
                RefundId: 0
                ResponseData:
                  authcode: '123456'
                  avsresponse: 'N'
                  avsresponse_text: No address or ZIP match only
                  cvvresponse: M
                  cvvresponse_text: CVV2/CVC2 match
                  emv_auth_response_data: null
                  orderid: 10-bfcd5a17861d4a8690ca53c00000X
                  response: Success
                  response_code: '100'
                  response_code_text: Transaction was approved.
                  responsetext: SUCCESS
                  resultCode: A0000
                  resultCodeText: Approved
                  transactionid: '8082800000'
                ReturnedId: 0
                ScheduleReference: 0
                SettlementStatus: 1
                Source: web
                splitCount: 0
                TotalAmount: 1000.5
                TransactionEvents:
                  - EventTime: '2024-01-23T00:46:05Z'
                    TransEvent: Created
                  - EventData: response=1&responsetext=Approved&authcode=123456&transactionid=9144440&avsresponse=&cvvresponse=&orderid=434-38aXXXX8ae4cd496db737200000000&type=sale&response_code=100&verification_method=&emv_application_id=A0000000031000&emv_application_label=VISA&emv_application_preferred_name=&emv_application_pan_sequence_number=00&transaction_status_information=&masked_merchant_number=xxxxxxxx9100&masked_terminal_number=xx01
                    EventTime: '2024-01-23T00:46:17Z'
                    TransEvent: Approved
                  - EventData:
                      action_type: settle
                      amount: 1000.5
                      api_method: ''
                      batch_id: '68031555'
                      date: '20240123013414'
                      device_license_number: ''
                      device_nickname: ''
                      ip_address: 100.100.100.100
                      processor_batch_id: '680317555'
                      processor_response_code: ''
                      processor_response_text: ''
                      requested_amountSpecified: false
                      response_code: '100'
                      response_text: SUCCESS
                      source: internal
                      success: 1
                      username: ' '
                    EventTime: '2024-01-23T01:34:14Z'
                    TransEvent: Settled
                TransactionTime: '2024-02-15T10:30:00Z'
                TransStatus: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/getpaid:
    post:
      operationId: moneyIn_getpaid
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: getpaid
      x-fern-request-name: RequestPayment
      summary: Make a transaction
      description: |-
        Make a single transaction. This method authorizes and captures a payment in one step.

          <Tip>
          Consider migrating to the [v2 Make a transaction endpoint](/developers/api-reference/moneyinV2/make-a-transaction) to take advantage of unified response codes and improved response consistency.
          </Tip>
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
        - name: validationCode
          in: header
          description: Value obtained from user when an API generated CAPTCHA is used in payment page
          required: false
          schema:
            type: string
        - name: achValidation
          in: query
          required: false
          description: When `true`, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.
          schema:
            $ref: '#/components/schemas/AchValidation'
        - name: forceCustomerCreation
          in: query
          required: false
          description: When `true`, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to `false`.
          schema:
            $ref: '#/components/schemas/ForceCustomerCreation'
        - name: includeDetails
          in: query
          description: When `true`, transactionDetails object is returned in the response. See a full example of the `transactionDetails` object in the [Transaction integration guide](/developers/developer-guides/money-in-transaction-add#includedetailstrue-response).
          required: false
          schema:
            type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransRequestBody'
            examples:
              Card:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  ipaddress: 255.255.255.255
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    cardcvv: '999'
                    cardexp: 02/27
                    cardHolder: John Cassian
                    cardnumber: '4111111111111111'
                    cardzip: '12345'
                    initiator: payor
                    method: card
              StoredMethod:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  ipaddress: 255.255.255.255
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    initiator: payor
                    method: card
                    storedMethodId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                    storedMethodUsageType: unscheduled
              Cloud:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  ipaddress: 255.255.255.255
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    device: 6c361c7d-674c-44cc-b790-382b75d1xxx
                    method: cloud
                    saveIfSuccess: true
              ACH:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  ipaddress: 255.255.255.255
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    achAccount: '123123123'
                    achAccountType: Checking
                    achCode: WEB
                    achHolder: John Cassian
                    achHolderType: personal
                    achRouting: '123123123'
                    method: ach
              BOC:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  ipaddress: 255.255.255.255
                  paymentDetails:
                    checkUniqueId: abc123def456
                    serviceFee: 0
                    totalAmount: 125.5
                  paymentMethod:
                    achAccount: '123456'
                    achAccountType: Checking
                    achCode: BOC
                    achHolder: John Doe
                    achRouting: '123456789'
                    method: ach
              ComplexCard:
                value:
                  customerData:
                    billingAddress1: 123 Walnut Street
                    billingCity: Johnson City
                    billingCountry: US
                    billingEmail: john@email.com
                    billingPhone: '1234567890'
                    billingState: Johnson City
                    billingZip: '37615'
                    customerNumber: 3456-7645A
                    firstName: John
                    lastName: Cassian
                  entryPoint: f743aed24a
                  ipaddress: 255.255.255.255
                  orderDescription: New customer package
                  orderId: 982-102
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 1000
                  paymentMethod:
                    cardcvv: '123'
                    cardexp: 02/25
                    cardHolder: John Cassian
                    cardnumber: '4111111111111111'
                    cardzip: '12345'
                    initiator: payor
                    method: card
                    saveIfSuccess: true
                  source: web
              CADCard:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  ipaddress: 255.255.255.255
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                    currency: CAD
                  paymentMethod:
                    cardcvv: '999'
                    cardexp: 02/27
                    cardHolder: John Cassian
                    cardnumber: '4111111111111111'
                    cardzip: '12345'
                    initiator: payor
                    method: card
              Decline:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  ipaddress: 255.255.255.255
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    cardcvv: '999'
                    cardexp: 02/27
                    cardHolder: John Cassian
                    cardnumber: '4111111111111111'
                    cardzip: '12345'
                    initiator: payor
                    method: card
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliAPIResponseGetPaid'
              examples:
                Card:
                  value:
                    responseText: Success
                    isSuccess: true
                    pageIdentifier: null
                    responseData:
                      authCode: VTLMC1
                      referenceId: 575-c490247af7ed403d86ba583507be61b0
                      resultCode: 1
                      resultText: Approved
                      avsResponseText: Exact match, Street address and 5-digit ZIP code both match
                      cvvResponseText: Not processed. Indicates that the expiration date was not provided with the request, or that the card does not have a valid CVV2 code. If the expiration date was not included with the request, resubmit the request with the expiration date.
                      customerId: 41892
                      methodReferenceId: null
                StoredMethod:
                  value:
                    responseText: Success
                    isSuccess: true
                    pageIdentifier: null
                    responseData:
                      authCode: AuthCode
                      referenceId: 45-erre-324
                      resultCode: 1
                      resultText: Approved
                      avsResponseText: No address or ZIP match only
                      cvvResponseText: CVV2/CVC2 no match
                      customerId: 4440
                      methodReferenceId: 1ed73d3c67-4076-8f8c-9f26317762ef
                Cloud:
                  value:
                    responseText: Success
                    isSuccess: true
                    pageIdentifier: null
                    responseData:
                      authCode: AuthCode
                      referenceId: 45-erre-324
                      resultCode: 1
                      resultText: Approved
                      avsResponseText: No address or ZIP match only
                      cvvResponseText: CVV2/CVC2 no match
                      customerId: 4440
                      methodReferenceId: null
                ACH:
                  value:
                    responseText: Success
                    isSuccess: true
                    pageIdentifier: null
                    responseData:
                      authCode: '123456'
                      referenceId: 132-d9719a411918429cb7ca465927969900
                      resultCode: 1
                      resultText: Approved
                      avsResponseText: ''
                      cvvResponseText: ''
                      customerId: 545
                      methodReferenceId: null
                BOC:
                  value:
                    responseText: Success
                    isSuccess: true
                    pageIdentifier: null
                    responseData:
                      authCode: '123456'
                      referenceId: 132-d9719a411918429cb7ca465927969900
                      resultCode: 1
                      resultText: Approved
                      avsResponseText: ''
                      cvvResponseText: ''
                      customerId: 4440
                      methodReferenceId: null
                ComplexCard:
                  value:
                    responseText: Success
                    isSuccess: true
                    pageIdentifier: null
                    responseData:
                      authCode: AuthCode
                      referenceId: 45-erre-324
                      resultCode: 1
                      resultText: Approved
                      avsResponseText: Exact match, Street address and 5-digit ZIP code both match
                      cvvResponseText: CVV2/CVC2 match
                      customerId: 4440
                      methodReferenceId: 1ed73d3c67-4076-8f8c-9f26317762ef
                CADCard:
                  value:
                    responseText: Success
                    isSuccess: true
                    pageIdentifier: null
                    responseData:
                      authCode: VTLMC1
                      referenceId: 575-c490247af7ed403d86ba583507be61b0
                      resultCode: 1
                      resultText: Approved
                      avsResponseText: ' '
                      cvvResponseText: CVV2/CVC2 match
                      customerId: 41892
                      methodReferenceId: null
                Decline:
                  value:
                    responseText: Declined
                    isSuccess: false
                    pageIdentifier: null
                    responseData:
                      authCode: null
                      referenceId: 45-erre-324
                      resultCode: 1
                      resultText: '200: Transaction was declined by processor.. DECLINE'
                      avsResponseText: No address or ZIP match only
                      cvvResponseText: CVV2/CVC2 no match
                      customerId: 4440
                      methodReferenceId: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/reverse/{transId}/{amount}:
    get:
      operationId: moneyIn_Reverse
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: Reverse
      x-fern-request-name: ReverseRequest
      summary: Reverse a transaction
      description: A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not. This endpoint only works on transactions made with the v1 API. For v2 transactions, check the transaction's settlement status and call v2 void or v2 refund based on the result.
      security:
        - APIKeyAuth: []
      parameters:
        - name: amount
          in: path
          description: |-
            Amount to reverse from original transaction, minus any service fees charged on the original transaction.

            The amount provided can't be greater than the original total amount of the transaction, minus service fees. For example, if a transaction was $90 plus a $10 service fee, you can reverse up to $90.

            An amount equal to zero will refunds the total amount authorized minus any service fee.
          required: true
          schema:
            type: number
            format: double
          examples:
            Void:
              value: 0
            Refund:
              value: 53.76
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          examples:
            Void:
              value: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
            Refund:
              value: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReverseResponse'
              examples:
                Void:
                  value:
                    responseCode: 1
                    pageIdentifier: null
                    roomId: 0
                    isSuccess: true
                    responseText: Success
                    responseData:
                      authCode: A0000
                      referenceId: 255-fb61db4171334aa79224b019f090e4c5
                      resultCode: 1
                      resultText: REVERSED
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: null
                      methodReferenceId: null
                Refund:
                  value:
                    responseCode: 1
                    pageIdentifier: null
                    roomId: 0
                    isSuccess: true
                    responseText: Success
                    responseData:
                      authCode: A0000
                      referenceId: 255-fb61db4171334aa79224b019f090e4c5
                      resultCode: 10
                      resultText: INITIATED
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: null
                      methodReferenceId: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/refund/{transId}/{amount}:
    get:
      operationId: moneyIn_Refund
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: Refund
      x-fern-request-name: RefundRequest
      summary: Refund a settled transaction
      description: |-
        Refund a transaction that has settled and send money back to the account holder. If a transaction hasn't been settled, void it instead.

          <Tip>
          Consider migrating to the [v2 Refund endpoint](/developers/api-reference/moneyinV2/refund-a-settled-transaction) to take advantage of unified response codes and improved response consistency.
          </Tip>
      security:
        - APIKeyAuth: []
      parameters:
        - name: amount
          in: path
          description: |-
            Amount to refund from original transaction, minus any service fees charged on the original transaction.

            The amount provided can't be greater than the original total amount of the transaction, minus service fees. For example, if a transaction was \$90 plus a \$10 service fee, you can refund up to \$90.

            An amount equal to zero will refund the total amount authorized minus any service fee.
          required: true
          schema:
            type: number
            format: double
          examples:
            Initiated:
              value: 0
            Captured:
              value: 100.99
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          examples:
            Initiated:
              value: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
            Captured:
              value: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundResponse'
              examples:
                Initiated:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData:
                      authCode: A0000
                      expectedProcessingDateTime: '2025-02-15 10:30:00+00:00'
                      referenceId: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
                      resultCode: 10
                      resultText: INITIATED
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: null
                      methodReferenceId: null
                    pageidentifier: null
                Captured:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData:
                      authCode: A0000
                      referenceId: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
                      resultCode: 1
                      resultText: CAPTURED
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: null
                      methodReferenceId: null
                    pageidentifier: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/refund/{transId}:
    post:
      operationId: moneyIn_RefundWithInstructions
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: RefundWithInstructions
      x-fern-request-name: RequestRefund
      summary: Refund a settled transaction with split instructions
      description: Refunds a settled transaction with split instructions.
      security:
        - APIKeyAuth: []
      parameters:
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          examples:
            FullSplitRefund:
              value: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
            PartialSplitRefund:
              value: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
          examples:
            FullSplitRefund:
              value: 8A29FC40-CA47-1067-B31D-00DD010662DB
            PartialSplitRefund:
              value: 8A29FC40-CA47-1067-B31D-00DD010662DB
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestRefund'
            examples:
              FullSplitRefund:
                value:
                  source: api
                  orderDescription: Materials deposit
                  amount: 100
                  refundDetails:
                    splitRefunding:
                      - originationEntryPoint: 7f1a381696
                        accountId: 187-342
                        description: Refunding undelivered materials
                        amount: 60
                      - originationEntryPoint: 7f1a381696
                        accountId: 187-343
                        description: Refunding deposit for undelivered materials
                        amount: 40
              PartialSplitRefund:
                value:
                  source: api
                  orderDescription: Materials deposit
                  amount: 70
                  refundDetails:
                    splitRefunding:
                      - originationEntryPoint: 7f1a381696
                        accountId: 187-342
                        description: Refunding undelivered materials
                        amount: 40
                      - originationEntryPoint: 7f1a381696
                        accountId: 187-343
                        description: Refunding deposit for undelivered materials
                        amount: 30
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundWithInstructionsResponse'
              examples:
                FullSplitRefund:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData:
                      authCode: ''
                      referenceId: 288-a1192b75-99e9-4d43-8af1-7ae9ab7da4f4
                      resultCode: 1
                      resultText: CAPTURED
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: null
                      methodReferenceId: null
                    pageidentifier: null
                PartialSplitRefund:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData:
                      authCode: ''
                      referenceId: 288-a1192b75-99e9-4d43-8af1-7ae9ab7da4f4
                      resultCode: 1
                      resultText: CAPTURED
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: null
                      methodReferenceId: null
                    pageidentifier: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/reverseCredit/{transId}:
    get:
      operationId: moneyIn_ReverseCredit
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: ReverseCredit
      x-fern-request-name: ReverseCreditRequest
      summary: Reverse an ACH credit transaction
      description: Reverse microdeposits that are used to verify customer account ownership and access. The `transId` value is returned in the success response for the original credit transaction made with `api/MoneyIn/makecredit`.
      security:
        - APIKeyAuth: []
      parameters:
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          example: 45-as456777hhhhhhhhhh77777777-324
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse'
              example:
                isSuccess: true
                responseData:
                  authCode: null
                  avsResponseText: null
                  customerId: 4440
                  cvvResponseText: null
                  referenceId: 148-7e1528b9b7ab56d0bf3b837237b84479
                  resultCode: 1
                  resultText: transaction processed.
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/sendreceipt/{transId}:
    get:
      operationId: moneyIn_SendReceipt2Trans
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: SendReceipt2Trans
      x-fern-request-name: SendReceipt2TransRequest
      summary: Send receipt for transaction
      description: Send a payment receipt for a transaction.
      security:
        - APIKeyAuth: []
      parameters:
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          example: 45-as456777hhhhhhhhhh77777777-324
        - name: email
          in: query
          description: |-
            Email address where the payment receipt should be sent.

            If not provided, the email address on file for the user owner of the transaction is used.
          required: false
          schema:
            type: string
          example: example@email.com
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceiptResponse'
              example:
                isSuccess: true
                pageIdentifier: 'null'
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/validate:
    post:
      operationId: moneyIn_Validate
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: Validate
      x-fern-request-name: RequestPaymentValidate
      summary: Validate card
      description: Validates a card number without running a transaction or authorizing a charge.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
          example: 6B29FC40-CA47-1067-B31D-00DD010662DA
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestPaymentValidate'
            example:
              entryPoint: entry132
              paymentMethod:
                method: card
                cardnumber: '4360000001000005'
                cardexp: 12/29
                cardzip: 14602-8328
                cardHolder: Dianne Becker-Smith
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateResponse'
              example:
                isSuccess: true
                responseData:
                  authCode: ''
                  referenceId: ''
                  resultCode: 1
                  resultText: Validated
                  avsResponseText: Zip code provided
                  cvvResponseText: ''
                  customerId: 0
                  methodReferenceId: null
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyIn/void/{transId}:
    get:
      operationId: moneyIn_Void
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: Void
      x-fern-request-name: VoidRequest
      summary: Void a transaction
      description: |-
        Cancel a transaction that hasn't been settled yet. Voiding non-captured authorizations prevents future captures. If a transaction has been settled, refund it instead.

          <Tip>
          Consider migrating to the [v2 Void endpoint](/developers/api-reference/moneyinV2/void-a-transaction) to take advantage of unified response codes and improved response consistency.
          </Tip>
      security:
        - APIKeyAuth: []
      parameters:
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          example: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoidResponse'
              example:
                responseCode: 1
                pageIdentifier: null
                roomId: 0
                isSuccess: true
                responseText: Success
                responseData:
                  authCode: '123456'
                  referenceId: 132-9eab3dfe958146639944aebcab3e9e28
                  resultCode: 1
                  resultText: Transaction Void Successful
                  avsResponseText: null
                  cvvResponseText: null
                  customerId: null
                  methodReferenceId: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /v2/MoneyIn/getpaid:
    post:
      operationId: moneyIn_getpaidv2
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: getpaidv2
      x-fern-request-name: RequestPaymentV2
      summary: Make a transaction (v2)
      description: Make a single transaction. This method authorizes and captures a payment in one step. This is the v2 version of the `api/MoneyIn/getpaid` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
        - name: validationCode
          in: header
          description: Value obtained from user when an API generated CAPTCHA is used in payment page
          required: false
          schema:
            type: string
        - name: achValidation
          in: query
          required: false
          description: When `true`, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.
          schema:
            $ref: '#/components/schemas/AchValidation'
        - name: forceCustomerCreation
          in: query
          required: false
          description: When `true`, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to `false`.
          schema:
            $ref: '#/components/schemas/ForceCustomerCreation'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransRequestBody'
            examples:
              CardApproval:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  ipaddress: 255.255.255.255
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    cardcvv: '999'
                    cardexp: 02/27
                    cardHolder: John Cassian
                    cardnumber: '4111111111111111'
                    cardzip: '12345'
                    initiator: payor
                    method: card
              StoredMethodApproval:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  ipaddress: 255.255.255.255
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    initiator: payor
                    method: card
                    storedMethodId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                    storedMethodUsageType: unscheduled
              ACHApproval:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  ipaddress: 255.255.255.255
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    achAccount: '123123123'
                    achAccountType: Checking
                    achCode: WEB
                    achHolder: John Cassian
                    achHolderType: personal
                    achRouting: '123123123'
                    method: ach
              CloudApproval:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  ipaddress: 255.255.255.255
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    device: 6c361c7d-674c-44cc-b790-382b75d1xxx
                    method: cloud
                    saveIfSuccess: true
      responses:
        '201':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TransactionResponseWrapper'
              examples:
                CardApproval:
                  value:
                    code: A0000
                    reason: Approved
                    explanation: Transaction approved
                    action: No action required
                    data:
                      parentOrgName: Mrinal's Pet Supplies
                      paypointDbaname: Mrinal's Pet Shop North
                      paypointLegalname: Mrinal's Pet Shop North
                      paypointEntryname: 495147f647
                      paymentTransId: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                      connectorName: gp
                      externalProcessorInformation: ''
                      gatewayTransId: TRN_Ih68D6UZdip7OEQ2QFXat1yQSLF2nB
                      orderId: null
                      method: card
                      batchNumber: 3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49
                      batchAmount: 420
                      payorId: 4440
                      paymentData:
                        maskedAccount: 4XXXXXXXXXXX5439
                        accountType: visa
                        accountExp: 12/25
                        holderName: John Cassian
                        storedId: null
                        initiator: null
                        storedMethodUsageType: null
                        sequence: null
                        orderDescription: ''
                        accountId: null
                        signatureData: null
                        binData:
                          binMatchedLength: '6'
                          binCardBrand: VISA
                          binCardType: CREDIT
                          binCardCategory: CLASSIC
                          binCardIssuer: ''
                          binCardIssuerCountry: RUSSIAN FEDERATION
                          binCardIssuerCountryCodeA2: RU
                          binCardIssuerCountryNumber: '643'
                          binCardIsRegulated: ''
                          binCardUseCategory: ''
                          binCardIssuerCountryCodeA3: ''
                        paymentDetails:
                          totalAmount: 105
                          serviceFee: 5
                          checkNumber: null
                          checkImage: null
                          checkUniqueId: ''
                          currency: USD
                          orderDescription: null
                          orderId: null
                          orderIdAlternative: null
                          paymentDescription: null
                          groupNumber: null
                          source: null
                          payabliTransId: null
                          unbundled: null
                          categories: []
                          splitFunding: []
                      transStatus: 1
                      paypointId: 3040
                      totalAmount: 105
                      netAmount: 100
                      feeAmount: 5
                      settlementStatus: 0
                      operation: Sale
                      responseData:
                        response: null
                        resultCode: A0000
                        resultCodeText: Approved
                        responsetext: CAPTURED
                        authcode: AXS425
                        transactionid: TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I
                        avsresponse: 'N'
                        avsresponse_text: No Match, No address or ZIP match
                        cvvresponse: M
                        cvvresponse_text: CVV2/CVC2 match
                        orderid: null
                        type: null
                        response_code: '100'
                        response_code_text: Operation successful
                        customer_vault_id: null
                        emv_auth_response_data: null
                      source: api
                      scheduleReference: 0
                      orgId: 17448
                      refundId: 0
                      returnedId: 0
                      chargebackId: 0
                      retrievalId: 0
                      transAdditionalData: null
                      invoiceData:
                        invoiceNumber: null
                        invoiceDate: null
                        invoiceDueDate: null
                        invoiceEndDate: null
                        invoiceStatus: null
                        invoiceType: null
                        frequency: null
                        paymentTerms: null
                        termsConditions: null
                        notes: null
                        tax: null
                        discount: null
                        invoiceAmount: null
                        freightAmount: null
                        dutyAmount: null
                        purchaseOrder: null
                        firstName: null
                        lastName: null
                        company: null
                        shippingAddress1: null
                        shippingAddress2: null
                        shippingCity: null
                        shippingState: null
                        shippingZip: null
                        shippingCountry: null
                        shippingEmail: null
                        shippingPhone: null
                        shippingFromZip: null
                        summaryCommodityCode: null
                        items: null
                        attachments: null
                        additionalData: null
                      entrypageId: 0
                      externalPaypointID: ''
                      isValidatedACH: false
                      transactionTime: '2025-12-01T09:50:03.559'
                      customer:
                        identifiers: null
                        firstName: David
                        lastName: Beckham
                        companyName: Driving School LLC
                        billingAddress1: Home Address
                        billingAddress2: ''
                        billingCity: ''
                        billingState: ''
                        billingZip: '45157'
                        billingCountry: US
                        billingPhone: '+15555555555'
                        billingEmail: example@payabli.com
                        customerNumber: C-90010
                        shippingAddress1: Home Address
                        shippingAddress2: ''
                        shippingCity: ''
                        shippingState: ''
                        shippingZip: '45157'
                        shippingCountry: US
                        customerId: 4440
                        customerStatus: 0
                        additionalData: null
                      splitFundingInstructions: null
                      cfeeTransactions:
                        - cFeeTransid: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                          transStatus: 1
                          feeAmount: 5
                          settlementStatus: 0
                          operation: Sale
                          responseData: {}
                          refundId: 0
                          transactionTime: '2025-12-01T09:50:03.559'
                      transactionEvents:
                        - transEvent: Created
                          eventData: 0HNHD68HATSUC:00000001
                          eventTime: '2025-12-01T09:50:02.558651'
                        - transEvent: Approved
                          eventData: 0HNHD68HATSUC:00000001
                          eventTime: '2025-12-01T09:50:03.609111'
                      pendingFeeAmount: 0
                      riskFlagged: false
                      riskFlaggedOn: '2025-12-01T09:50:02.5474568'
                      riskStatus: PASSED
                      riskReason: ''
                      riskAction: ''
                      riskActionCode: 0
                      deviceId: ''
                      achSecCode: ''
                      achHolderType: personal
                      ipAddress: 255.255.255.255
                      isSameDayACH: false
                      walletType: null
                    token: null
                StoredMethodApproval:
                  value:
                    code: A0000
                    reason: Approved
                    explanation: Transaction approved
                    action: No action required
                    data:
                      parentOrgName: Mrinal's Pet Supplies
                      paypointDbaname: Mrinal's Pet Shop North
                      paypointLegalname: Mrinal's Pet Shop North
                      paypointEntryname: 495147f647
                      paymentTransId: 3040-9708542b00354726ad8a6b0c65bc7a54
                      connectorName: gp
                      externalProcessorInformation: ''
                      gatewayTransId: TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I
                      orderId: null
                      method: card
                      batchNumber: 3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49
                      batchAmount: 630
                      payorId: 4440
                      paymentData:
                        maskedAccount: 3XXXXXXXXXX0227
                        accountType: amex
                        accountExp: 12/25
                        holderName: Alexa Amazon
                        storedId: fb1f5ec2-1ba4-4ba6-9839-20c2cc4baf5a-4440
                        initiator: merchant
                        storedMethodUsageType: unscheduled
                        sequence: subsequent
                        orderDescription: ''
                        accountId: null
                        signatureData: null
                        binData:
                          binMatchedLength: ''
                          binCardBrand: ''
                          binCardType: ''
                          binCardCategory: ''
                          binCardIssuer: ''
                          binCardIssuerCountry: ''
                          binCardIssuerCountryCodeA2: ''
                          binCardIssuerCountryNumber: ''
                          binCardIsRegulated: ''
                          binCardUseCategory: ''
                          binCardIssuerCountryCodeA3: ''
                        paymentDetails:
                          totalAmount: 105
                          serviceFee: 5
                          checkNumber: null
                          checkImage: null
                          checkUniqueId: ''
                          currency: USD
                          orderDescription: null
                          orderId: null
                          orderIdAlternative: null
                          paymentDescription: null
                          groupNumber: null
                          source: null
                          payabliTransId: null
                          unbundled: null
                          categories: []
                          splitFunding: []
                      transStatus: 1
                      paypointId: 3040
                      totalAmount: 105
                      netAmount: 100
                      feeAmount: 5
                      settlementStatus: 0
                      operation: Sale
                      responseData:
                        response: null
                        resultCode: A0000
                        resultCodeText: Approved
                        responsetext: CAPTURED
                        authcode: AXS425
                        transactionid: TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I
                        avsresponse: 'N'
                        avsresponse_text: No Match, No address or ZIP match
                        cvvresponse: M
                        cvvresponse_text: CVV2/CVC2 match
                        orderid: null
                        type: null
                        response_code: '100'
                        response_code_text: Operation successful
                        customer_vault_id: null
                        emv_auth_response_data: null
                      source: api
                      scheduleReference: 0
                      orgId: 17448
                      refundId: 0
                      returnedId: 0
                      chargebackId: 0
                      retrievalId: 0
                      transAdditionalData: null
                      invoiceData:
                        invoiceNumber: null
                        invoiceDate: null
                        invoiceDueDate: null
                        invoiceEndDate: null
                        invoiceStatus: null
                        invoiceType: null
                        frequency: null
                        paymentTerms: null
                        termsConditions: null
                        notes: null
                        tax: null
                        discount: null
                        invoiceAmount: null
                        freightAmount: null
                        dutyAmount: null
                        purchaseOrder: null
                        firstName: null
                        lastName: null
                        company: null
                        shippingAddress1: null
                        shippingAddress2: null
                        shippingCity: null
                        shippingState: null
                        shippingZip: null
                        shippingCountry: null
                        shippingEmail: null
                        shippingPhone: null
                        shippingFromZip: null
                        summaryCommodityCode: null
                        items: null
                        attachments: null
                        additionalData: null
                      entrypageId: 0
                      externalPaypointID: ''
                      isValidatedACH: false
                      transactionTime: '2025-12-01T09:56:33.967'
                      customer:
                        identifiers: null
                        firstName: David
                        lastName: Beckham
                        companyName: Driving School LLC
                        billingAddress1: Home Address
                        billingAddress2: ''
                        billingCity: ''
                        billingState: ''
                        billingZip: '45157'
                        billingCountry: US
                        billingPhone: '+15555555555'
                        billingEmail: example@payabli.com
                        customerNumber: C-90010
                        shippingAddress1: Home Address
                        shippingAddress2: ''
                        shippingCity: ''
                        shippingState: ''
                        shippingZip: '45157'
                        shippingCountry: US
                        customerId: 4440
                        customerStatus: 0
                        additionalData: null
                      splitFundingInstructions: null
                      cfeeTransactions:
                        - cFeeTransid: 3040-9708542b00354726ad8a6b0c65bc7a54
                          transStatus: 1
                          feeAmount: 5
                          settlementStatus: 0
                          operation: Sale
                          responseData: {}
                          refundId: 0
                          transactionTime: '2025-12-01T09:56:33.967'
                      transactionEvents:
                        - transEvent: Created
                          eventData: 0HNHD68HATSUR:00000004
                          eventTime: '2025-12-01T09:56:32.662988'
                        - transEvent: Approved
                          eventData: 0HNHD68HATSUR:00000004
                          eventTime: '2025-12-01T09:56:34.027504'
                      pendingFeeAmount: 0
                      riskFlagged: false
                      riskFlaggedOn: '2025-12-01T09:56:32.6525967'
                      riskStatus: PASSED
                      riskReason: ''
                      riskAction: ''
                      riskActionCode: 0
                      deviceId: ''
                      achSecCode: ''
                      achHolderType: personal
                      ipAddress: 255.255.255.255
                      isSameDayACH: false
                      walletType: null
                    token: null
                ACHApproval:
                  value:
                    code: A0000
                    reason: Approved
                    explanation: Transaction approved
                    action: No action required
                    data:
                      parentOrgName: Mountain View Services
                      paypointDbaname: Mountain View Auto
                      paypointLegalname: Mountain View Automotive Services LLC
                      paypointEntryname: 31ae451b89
                      paymentTransId: 2145-7b8fa3c9d5e64f73b2ee5a6b14bd39cd
                      connectorName: checkcommerce
                      externalProcessorInformation: ''
                      gatewayTransId: ACH_TRN_8K92D7VZexp8PFR3RGYbu2zRTMG3oC
                      orderId: null
                      method: ach
                      batchNumber: checkcommerce_2145_ach_12-01-2025
                      batchAmount: 525
                      payorId: 38267
                      paymentData:
                        maskedAccount: XXXXX4532
                        accountType: Checking
                        accountExp: null
                        holderName: Sarah Martinez
                        storedId: null
                        initiator: null
                        storedMethodUsageType: null
                        sequence: null
                        orderDescription: ''
                        accountId: null
                        signatureData: null
                        binData: null
                        paymentDetails:
                          totalAmount: 105
                          serviceFee: 5
                          checkNumber: null
                          checkImage: null
                          checkUniqueId: ''
                          currency: USD
                          orderDescription: null
                          orderId: null
                          orderIdAlternative: null
                          paymentDescription: null
                          groupNumber: null
                          source: null
                          payabliTransId: null
                          unbundled: null
                          categories: []
                          splitFunding: []
                      transStatus: 1
                      paypointId: 2145
                      totalAmount: 105
                      netAmount: 100
                      feeAmount: 5
                      settlementStatus: 0
                      operation: Sale
                      responseData:
                        response: null
                        resultCode: A0000
                        resultCodeText: Approved
                        responsetext: CAPTURED
                        authcode: AXS425
                        transactionid: TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I
                        avsresponse: 'N'
                        avsresponse_text: No Match, No address or ZIP match
                        cvvresponse: M
                        cvvresponse_text: CVV2/CVC2 match
                        orderid: null
                        type: null
                        response_code: '100'
                        response_code_text: Operation successful
                        customer_vault_id: null
                        emv_auth_response_data: null
                      source: api
                      scheduleReference: 0
                      orgId: 14267
                      refundId: 0
                      returnedId: 0
                      chargebackId: 0
                      retrievalId: 0
                      transAdditionalData: null
                      invoiceData:
                        invoiceNumber: null
                        invoiceDate: null
                        invoiceDueDate: null
                        invoiceEndDate: null
                        invoiceStatus: null
                        invoiceType: null
                        frequency: null
                        paymentTerms: null
                        termsConditions: null
                        notes: null
                        tax: null
                        discount: null
                        invoiceAmount: null
                        freightAmount: null
                        dutyAmount: null
                        purchaseOrder: null
                        firstName: null
                        lastName: null
                        company: null
                        shippingAddress1: null
                        shippingAddress2: null
                        shippingCity: null
                        shippingState: null
                        shippingZip: null
                        shippingCountry: null
                        shippingEmail: null
                        shippingPhone: null
                        shippingFromZip: null
                        summaryCommodityCode: null
                        items: null
                        attachments: null
                        additionalData: null
                      entrypageId: 0
                      externalPaypointID: ''
                      isValidatedACH: true
                      transactionTime: '2025-12-01T10:15:28.742'
                      customer:
                        identifiers: null
                        firstName: Sarah
                        lastName: Martinez
                        companyName: Martinez Consulting
                        billingAddress1: 456 Oak Avenue
                        billingAddress2: Suite 201
                        billingCity: Portland
                        billingState: OR
                        billingZip: '97201'
                        billingCountry: US
                        billingPhone: '+15035551234'
                        billingEmail: sarah.martinez@example.com
                        customerNumber: C-80245
                        shippingAddress1: 456 Oak Avenue
                        shippingAddress2: Suite 201
                        shippingCity: Portland
                        shippingState: OR
                        shippingZip: '97201'
                        shippingCountry: US
                        customerId: 38267
                        customerStatus: 0
                        additionalData: null
                      splitFundingInstructions: null
                      cfeeTransactions:
                        - cFeeTransid: 2145-7b8fa3c9d5e64f73b2ee5a6b14bd39cd
                          transStatus: 1
                          feeAmount: 5
                          settlementStatus: 0
                          operation: Sale
                          responseData: {}
                          refundId: 0
                          transactionTime: '2025-12-01T10:15:28.742'
                      transactionEvents:
                        - transEvent: Created
                          eventData: 0HNHD69JBVWXP:00000001
                          eventTime: '2025-12-01T10:15:27.682442'
                        - transEvent: Approved
                          eventData: 0HNHD69JBVWXP:00000001
                          eventTime: '2025-12-01T10:15:28.751283'
                      pendingFeeAmount: 0
                      riskFlagged: false
                      riskFlaggedOn: '2025-12-01T10:15:27.6712346'
                      riskStatus: PASSED
                      riskReason: ''
                      riskAction: ''
                      riskActionCode: 0
                      deviceId: ''
                      achSecCode: WEB
                      achHolderType: personal
                      ipAddress: 255.255.255.255
                      isSameDayACH: false
                      walletType: null
                    token: null
                CloudApproval:
                  value:
                    code: A0000
                    reason: Approved
                    explanation: Transaction approved
                    action: No action required
                    data:
                      parentOrgName: Mrinal's Pet Supplies
                      paypointDbaname: Mrinal's Pet Shop North
                      paypointLegalname: Mrinal's Pet Shop North
                      paypointEntryname: 495147f647
                      paymentTransId: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                      connectorName: gp
                      externalProcessorInformation: ''
                      gatewayTransId: TRN_Ih68D6UZdip7OEQ2QFXat1yQSLF2nB
                      orderId: null
                      method: card
                      batchNumber: 3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49
                      batchAmount: 420
                      payorId: 4440
                      paymentData:
                        maskedAccount: 4XXXXXXXXXXX5439
                        accountType: visa
                        accountExp: 12/25
                        holderName: John Cassian
                        storedId: null
                        initiator: null
                        storedMethodUsageType: null
                        sequence: null
                        orderDescription: ''
                        accountId: null
                        signatureData: null
                        binData:
                          binMatchedLength: '6'
                          binCardBrand: VISA
                          binCardType: CREDIT
                          binCardCategory: CLASSIC
                          binCardIssuer: ''
                          binCardIssuerCountry: RUSSIAN FEDERATION
                          binCardIssuerCountryCodeA2: RU
                          binCardIssuerCountryNumber: '643'
                          binCardIsRegulated: ''
                          binCardUseCategory: ''
                          binCardIssuerCountryCodeA3: ''
                        paymentDetails:
                          totalAmount: 105
                          serviceFee: 5
                          checkNumber: null
                          checkImage: null
                          checkUniqueId: ''
                          currency: USD
                          orderDescription: null
                          orderId: null
                          orderIdAlternative: null
                          paymentDescription: null
                          groupNumber: null
                          source: null
                          payabliTransId: null
                          unbundled: null
                          categories: []
                          splitFunding: []
                      transStatus: 1
                      paypointId: 3040
                      totalAmount: 105
                      netAmount: 100
                      feeAmount: 5
                      settlementStatus: 0
                      operation: Sale
                      responseData:
                        response: null
                        resultCode: A0000
                        resultCodeText: Approved
                        responsetext: CAPTURED
                        authcode: AXS425
                        transactionid: TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I
                        avsresponse: 'N'
                        avsresponse_text: No Match, No address or ZIP match
                        cvvresponse: M
                        cvvresponse_text: CVV2/CVC2 match
                        orderid: null
                        type: null
                        response_code: '100'
                        response_code_text: Operation successful
                        customer_vault_id: null
                        emv_auth_response_data: null
                      source: api
                      scheduleReference: 0
                      orgId: 17448
                      refundId: 0
                      returnedId: 0
                      chargebackId: 0
                      retrievalId: 0
                      transAdditionalData: null
                      invoiceData:
                        invoiceNumber: null
                        invoiceDate: null
                        invoiceDueDate: null
                        invoiceEndDate: null
                        invoiceStatus: null
                        invoiceType: null
                        frequency: null
                        paymentTerms: null
                        termsConditions: null
                        notes: null
                        tax: null
                        discount: null
                        invoiceAmount: null
                        freightAmount: null
                        dutyAmount: null
                        purchaseOrder: null
                        firstName: null
                        lastName: null
                        company: null
                        shippingAddress1: null
                        shippingAddress2: null
                        shippingCity: null
                        shippingState: null
                        shippingZip: null
                        shippingCountry: null
                        shippingEmail: null
                        shippingPhone: null
                        shippingFromZip: null
                        summaryCommodityCode: null
                        items: null
                        attachments: null
                        additionalData: null
                      entrypageId: 0
                      externalPaypointID: ''
                      isValidatedACH: false
                      transactionTime: '2025-12-01T09:50:03.559'
                      customer:
                        identifiers: null
                        firstName: David
                        lastName: Beckham
                        companyName: Driving School LLC
                        billingAddress1: Home Address
                        billingAddress2: ''
                        billingCity: ''
                        billingState: ''
                        billingZip: '45157'
                        billingCountry: US
                        billingPhone: '+15555555555'
                        billingEmail: example@payabli.com
                        customerNumber: C-90010
                        shippingAddress1: Home Address
                        shippingAddress2: ''
                        shippingCity: ''
                        shippingState: ''
                        shippingZip: '45157'
                        shippingCountry: US
                        customerId: 4440
                        customerStatus: 0
                        additionalData: null
                      splitFundingInstructions: null
                      cfeeTransactions:
                        - cFeeTransid: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                          transStatus: 1
                          feeAmount: 5
                          settlementStatus: 0
                          operation: Sale
                          responseData: {}
                          refundId: 0
                          transactionTime: '2025-12-01T09:50:03.559'
                      transactionEvents:
                        - transEvent: Created
                          eventData: 0HNHD68HATSUC:00000001
                          eventTime: '2025-12-01T09:50:02.558651'
                        - transEvent: Approved
                          eventData: 0HNHD68HATSUC:00000001
                          eventTime: '2025-12-01T09:50:03.609111'
                      pendingFeeAmount: 0
                      riskFlagged: false
                      riskFlaggedOn: '2025-12-01T09:50:02.5474568'
                      riskStatus: PASSED
                      riskReason: ''
                      riskAction: ''
                      riskActionCode: 0
                      deviceId: ''
                      achSecCode: ''
                      achHolderType: personal
                      ipAddress: 255.255.255.255
                      isSameDayACH: false
                      walletType: null
                    token: null
        '400':
          $ref: '#/components/responses/BadRequestAuthResponseErrorV2'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '402':
          $ref: '#/components/responses/DeclinedAuthResponseErrorV2'
        '500':
          $ref: '#/components/responses/InternalServerResponseErrorV2'
  /v2/MoneyIn/authorize:
    post:
      operationId: moneyIn_authorizev2
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: authorizev2
      x-fern-request-name: RequestPaymentAuthorizeV2
      summary: Authorize card transaction (v2)
      description: |-
        Authorize a card transaction. This returns an authorization code and reserves funds for the merchant. Authorized transactions aren't flagged for settlement until captured. This is the v2 version of the `api/MoneyIn/authorize` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.

        **Note**: Only card transactions can be authorized. This endpoint can't be used for ACH transactions.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
        - name: forceCustomerCreation
          in: query
          required: false
          description: When `true`, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to `false`.
          schema:
            $ref: '#/components/schemas/ForceCustomerCreation'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransRequestBody'
            example:
              customerData:
                customerId: 4440
              entryPoint: f743aed24a
              ipaddress: 255.255.255.255
              paymentDetails:
                serviceFee: 0
                totalAmount: 100
              paymentMethod:
                cardcvv: '999'
                cardexp: 02/27
                cardHolder: John Cassian
                cardnumber: '4111111111111111'
                cardzip: '12345'
                initiator: payor
                method: card
      responses:
        '201':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TransactionResponseWrapper'
              example:
                code: A0002
                reason: Authorized
                explanation: Transaction authorized
                action: No action required.
                data:
                  parentOrgName: Mrinal's Pet Supplies
                  paypointDbaname: Mrinal's Pet Shop North
                  paypointLegalname: Mrinal's Pet Shop North
                  paypointEntryname: 495147f647
                  paymentTransId: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                  connectorName: gp
                  externalProcessorInformation: ''
                  gatewayTransId: TRN_Ih68D6UZdip7OEQ2QFXat1yQSLF2nB
                  orderId: null
                  method: card
                  batchNumber: 3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49
                  batchAmount: 420
                  payorId: 4440
                  paymentData:
                    maskedAccount: 4XXXXXXXXXXX5439
                    accountType: visa
                    accountExp: 12/25
                    holderName: John Cassian
                    storedId: null
                    initiator: null
                    storedMethodUsageType: null
                    sequence: null
                    orderDescription: ''
                    accountId: null
                    signatureData: null
                    binData:
                      binMatchedLength: '6'
                      binCardBrand: VISA
                      binCardType: CREDIT
                      binCardCategory: CLASSIC
                      binCardIssuer: ''
                      binCardIssuerCountry: RUSSIAN FEDERATION
                      binCardIssuerCountryCodeA2: RU
                      binCardIssuerCountryNumber: '643'
                      binCardIsRegulated: ''
                      binCardUseCategory: ''
                      binCardIssuerCountryCodeA3: ''
                    paymentDetails:
                      totalAmount: 105
                      serviceFee: 5
                      checkNumber: null
                      checkImage: null
                      checkUniqueId: ''
                      currency: USD
                      orderDescription: null
                      orderId: null
                      orderIdAlternative: null
                      paymentDescription: null
                      groupNumber: null
                      source: null
                      payabliTransId: null
                      unbundled: null
                      categories: []
                      splitFunding: []
                  transStatus: 11
                  paypointId: 3040
                  totalAmount: 105
                  netAmount: 100
                  feeAmount: 5
                  settlementStatus: 0
                  operation: Sale
                  responseData:
                    response: null
                    resultCode: A0000
                    resultCodeText: Approved
                    responsetext: CAPTURED
                    authcode: AXS425
                    transactionid: TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I
                    avsresponse: 'N'
                    avsresponse_text: No Match, No address or ZIP match
                    cvvresponse: M
                    cvvresponse_text: CVV2/CVC2 match
                    orderid: null
                    type: null
                    response_code: '100'
                    response_code_text: Operation successful
                    customer_vault_id: null
                    emv_auth_response_data: null
                  source: api
                  scheduleReference: 0
                  orgId: 17448
                  refundId: 0
                  returnedId: 0
                  chargebackId: 0
                  retrievalId: 0
                  transAdditionalData: null
                  invoiceData:
                    invoiceNumber: null
                    invoiceDate: null
                    invoiceDueDate: null
                    invoiceEndDate: null
                    invoiceStatus: null
                    invoiceType: null
                    frequency: null
                    paymentTerms: null
                    termsConditions: null
                    notes: null
                    tax: null
                    discount: null
                    invoiceAmount: null
                    freightAmount: null
                    dutyAmount: null
                    purchaseOrder: null
                    firstName: null
                    lastName: null
                    company: null
                    shippingAddress1: null
                    shippingAddress2: null
                    shippingCity: null
                    shippingState: null
                    shippingZip: null
                    shippingCountry: null
                    shippingEmail: null
                    shippingPhone: null
                    shippingFromZip: null
                    summaryCommodityCode: null
                    items: null
                    attachments: null
                    additionalData: null
                  entrypageId: 0
                  externalPaypointID: ''
                  isValidatedACH: false
                  transactionTime: '2025-12-01T09:50:03.559'
                  customer:
                    identifiers: null
                    firstName: David
                    lastName: Beckham
                    companyName: Driving School LLC
                    billingAddress1: Home Address
                    billingAddress2: ''
                    billingCity: ''
                    billingState: ''
                    billingZip: '45157'
                    billingCountry: US
                    billingPhone: '+15555555555'
                    billingEmail: example@payabli.com
                    customerNumber: C-90010
                    shippingAddress1: Home Address
                    shippingAddress2: ''
                    shippingCity: ''
                    shippingState: ''
                    shippingZip: '45157'
                    shippingCountry: US
                    customerId: 4440
                    customerStatus: 0
                    additionalData: null
                  splitFundingInstructions: null
                  cfeeTransactions:
                    - cFeeTransid: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                      transStatus: 1
                      feeAmount: 5
                      settlementStatus: 0
                      operation: Sale
                      responseData: {}
                      refundId: 0
                      transactionTime: '2025-12-01T09:50:03.559'
                  transactionEvents:
                    - transEvent: Created
                      eventData: 0HNHD68HATSUC:00000001
                      eventTime: '2025-12-01T09:50:02.558651'
                    - transEvent: Approved
                      eventData: 0HNHD68HATSUC:00000001
                      eventTime: '2025-12-01T09:50:03.609111'
                  pendingFeeAmount: 0
                  riskFlagged: false
                  riskFlaggedOn: '2025-12-01T09:50:02.5474568'
                  riskStatus: PASSED
                  riskReason: ''
                  riskAction: ''
                  riskActionCode: 0
                  deviceId: ''
                  achSecCode: ''
                  achHolderType: personal
                  ipAddress: 255.255.255.255
                  isSameDayACH: false
                  walletType: null
                token: null
        '400':
          $ref: '#/components/responses/BadRequestAuthResponseErrorV2'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '402':
          $ref: '#/components/responses/DeclinedAuthResponseErrorV2'
        '500':
          $ref: '#/components/responses/InternalServerResponseErrorV2'
  /v2/MoneyIn/capture/{transId}:
    post:
      operationId: moneyIn_capturev2
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: capturev2
      x-fern-request-name: capturev2Request
      summary: Capture an authorized transaction (v2)
      description: Capture an authorized transaction to complete the transaction and move funds from the customer to merchant account. This is the v2 version of the `api/MoneyIn/capture/{transId}` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
      security:
        - APIKeyAuth: []
      parameters:
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          examples:
            FullCapture:
              value: 10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13
            PartialCapture:
              value: 10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CaptureRequest'
            examples:
              FullCapture:
                value:
                  paymentDetails:
                    totalAmount: 105
                    serviceFee: 5
              PartialCapture:
                value:
                  paymentDetails:
                    totalAmount: 89
                    serviceFee: 4
      responses:
        '201':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TransactionResponseWrapper'
              examples:
                FullCapture:
                  value:
                    code: A0000
                    reason: Approved
                    explanation: Approved by card network or card issuer.
                    action: No action required.
                    data:
                      parentOrgName: Mrinal's Pet Supplies
                      paypointDbaname: Mrinal's Pet Shop North
                      paypointLegalname: Mrinal's Pet Shop North
                      paypointEntryname: 495147f647
                      paymentTransId: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                      connectorName: gp
                      externalProcessorInformation: ''
                      gatewayTransId: TRN_Ih68D6UZdip7OEQ2QFXat1yQSLF2nB
                      orderId: null
                      method: card
                      batchNumber: 3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49
                      batchAmount: 420
                      payorId: 4440
                      paymentData:
                        maskedAccount: 4XXXXXXXXXXX5439
                        accountType: visa
                        accountExp: 12/25
                        holderName: John Cassian
                        storedId: null
                        initiator: null
                        storedMethodUsageType: null
                        sequence: null
                        orderDescription: ''
                        accountId: null
                        signatureData: null
                        binData:
                          binMatchedLength: '6'
                          binCardBrand: VISA
                          binCardType: CREDIT
                          binCardCategory: CLASSIC
                          binCardIssuer: ''
                          binCardIssuerCountry: RUSSIAN FEDERATION
                          binCardIssuerCountryCodeA2: RU
                          binCardIssuerCountryNumber: '643'
                          binCardIsRegulated: ''
                          binCardUseCategory: ''
                          binCardIssuerCountryCodeA3: ''
                        paymentDetails:
                          totalAmount: 105
                          serviceFee: 5
                          checkNumber: null
                          checkImage: null
                          checkUniqueId: ''
                          currency: USD
                          orderDescription: null
                          orderId: null
                          orderIdAlternative: null
                          paymentDescription: null
                          groupNumber: null
                          source: null
                          payabliTransId: null
                          unbundled: null
                          categories: []
                          splitFunding: []
                      transStatus: 1
                      paypointId: 3040
                      totalAmount: 105
                      netAmount: 100
                      feeAmount: 5
                      settlementStatus: 0
                      operation: Sale
                      responseData:
                        response: null
                        resultCode: A0000
                        resultCodeText: Approved
                        responsetext: CAPTURED
                        authcode: AXS425
                        transactionid: TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I
                        avsresponse: 'N'
                        avsresponse_text: No Match, No address or ZIP match
                        cvvresponse: M
                        cvvresponse_text: CVV2/CVC2 match
                        orderid: null
                        type: null
                        response_code: '100'
                        response_code_text: Operation successful
                        customer_vault_id: null
                        emv_auth_response_data: null
                      source: api
                      scheduleReference: 0
                      orgId: 17448
                      refundId: 0
                      returnedId: 0
                      chargebackId: 0
                      retrievalId: 0
                      transAdditionalData: null
                      invoiceData:
                        invoiceNumber: null
                        invoiceDate: null
                        invoiceDueDate: null
                        invoiceEndDate: null
                        invoiceStatus: null
                        invoiceType: null
                        frequency: null
                        paymentTerms: null
                        termsConditions: null
                        notes: null
                        tax: null
                        discount: null
                        invoiceAmount: null
                        freightAmount: null
                        dutyAmount: null
                        purchaseOrder: null
                        firstName: null
                        lastName: null
                        company: null
                        shippingAddress1: null
                        shippingAddress2: null
                        shippingCity: null
                        shippingState: null
                        shippingZip: null
                        shippingCountry: null
                        shippingEmail: null
                        shippingPhone: null
                        shippingFromZip: null
                        summaryCommodityCode: null
                        items: null
                        attachments: null
                        additionalData: null
                      entrypageId: 0
                      externalPaypointID: ''
                      isValidatedACH: false
                      transactionTime: '2025-12-01T09:50:03.559'
                      customer:
                        identifiers: null
                        firstName: David
                        lastName: Beckham
                        companyName: Driving School LLC
                        billingAddress1: Home Address
                        billingAddress2: ''
                        billingCity: ''
                        billingState: ''
                        billingZip: '45157'
                        billingCountry: US
                        billingPhone: '+15555555555'
                        billingEmail: example@payabli.com
                        customerNumber: C-90010
                        shippingAddress1: Home Address
                        shippingAddress2: ''
                        shippingCity: ''
                        shippingState: ''
                        shippingZip: '45157'
                        shippingCountry: US
                        customerId: 4440
                        customerStatus: 0
                        additionalData: null
                      splitFundingInstructions: null
                      cfeeTransactions:
                        - cFeeTransid: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                          transStatus: 1
                          feeAmount: 5
                          settlementStatus: 0
                          operation: Sale
                          responseData: {}
                          refundId: 0
                          transactionTime: '2025-12-01T09:50:03.559'
                      transactionEvents:
                        - transEvent: Created
                          eventData: 0HNHD68HATSUC:00000001
                          eventTime: '2025-12-01T09:50:02.558651'
                        - transEvent: Approved
                          eventData: 0HNHD68HATSUC:00000001
                          eventTime: '2025-12-01T09:50:03.609111'
                      pendingFeeAmount: 0
                      riskFlagged: false
                      riskFlaggedOn: '2025-12-01T09:50:02.5474568'
                      riskStatus: PASSED
                      riskReason: ''
                      riskAction: ''
                      riskActionCode: 0
                      deviceId: ''
                      achSecCode: ''
                      achHolderType: personal
                      ipAddress: 255.255.255.255
                      isSameDayACH: false
                      walletType: null
                    token: null
                PartialCapture:
                  value:
                    code: A0000
                    reason: Approved
                    explanation: Approved by card network or card issuer.
                    action: No action required.
                    data:
                      parentOrgName: Mrinal's Pet Supplies
                      paypointDbaname: Mrinal's Pet Shop North
                      paypointLegalname: Mrinal's Pet Shop North
                      paypointEntryname: 495147f647
                      paymentTransId: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                      connectorName: gp
                      externalProcessorInformation: ''
                      gatewayTransId: TRN_Ih68D6UZdip7OEQ2QFXat1yQSLF2nB
                      orderId: null
                      method: card
                      batchNumber: 3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49
                      batchAmount: 420
                      payorId: 4440
                      paymentData:
                        maskedAccount: 4XXXXXXXXXXX5439
                        accountType: visa
                        accountExp: 12/25
                        holderName: John Cassian
                        storedId: null
                        initiator: null
                        storedMethodUsageType: null
                        sequence: null
                        orderDescription: ''
                        accountId: null
                        signatureData: null
                        binData:
                          binMatchedLength: '6'
                          binCardBrand: VISA
                          binCardType: CREDIT
                          binCardCategory: CLASSIC
                          binCardIssuer: ''
                          binCardIssuerCountry: RUSSIAN FEDERATION
                          binCardIssuerCountryCodeA2: RU
                          binCardIssuerCountryNumber: '643'
                          binCardIsRegulated: ''
                          binCardUseCategory: ''
                          binCardIssuerCountryCodeA3: ''
                        paymentDetails:
                          totalAmount: 105
                          serviceFee: 5
                          checkNumber: null
                          checkImage: null
                          checkUniqueId: ''
                          currency: USD
                          orderDescription: null
                          orderId: null
                          orderIdAlternative: null
                          paymentDescription: null
                          groupNumber: null
                          source: null
                          payabliTransId: null
                          unbundled: null
                          categories: []
                          splitFunding: []
                      transStatus: 1
                      paypointId: 3040
                      totalAmount: 105
                      netAmount: 100
                      feeAmount: 5
                      settlementStatus: 0
                      operation: Sale
                      responseData:
                        response: null
                        resultCode: A0000
                        resultCodeText: Approved
                        responsetext: CAPTURED
                        authcode: AXS425
                        transactionid: TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I
                        avsresponse: 'N'
                        avsresponse_text: No Match, No address or ZIP match
                        cvvresponse: M
                        cvvresponse_text: CVV2/CVC2 match
                        orderid: null
                        type: null
                        response_code: '100'
                        response_code_text: Operation successful
                        customer_vault_id: null
                        emv_auth_response_data: null
                      source: api
                      scheduleReference: 0
                      orgId: 17448
                      refundId: 0
                      returnedId: 0
                      chargebackId: 0
                      retrievalId: 0
                      transAdditionalData: null
                      invoiceData:
                        invoiceNumber: null
                        invoiceDate: null
                        invoiceDueDate: null
                        invoiceEndDate: null
                        invoiceStatus: null
                        invoiceType: null
                        frequency: null
                        paymentTerms: null
                        termsConditions: null
                        notes: null
                        tax: null
                        discount: null
                        invoiceAmount: null
                        freightAmount: null
                        dutyAmount: null
                        purchaseOrder: null
                        firstName: null
                        lastName: null
                        company: null
                        shippingAddress1: null
                        shippingAddress2: null
                        shippingCity: null
                        shippingState: null
                        shippingZip: null
                        shippingCountry: null
                        shippingEmail: null
                        shippingPhone: null
                        shippingFromZip: null
                        summaryCommodityCode: null
                        items: null
                        attachments: null
                        additionalData: null
                      entrypageId: 0
                      externalPaypointID: ''
                      isValidatedACH: false
                      transactionTime: '2025-12-01T09:50:03.559'
                      customer:
                        identifiers: null
                        firstName: David
                        lastName: Beckham
                        companyName: Driving School LLC
                        billingAddress1: Home Address
                        billingAddress2: ''
                        billingCity: ''
                        billingState: ''
                        billingZip: '45157'
                        billingCountry: US
                        billingPhone: '+15555555555'
                        billingEmail: example@payabli.com
                        customerNumber: C-90010
                        shippingAddress1: Home Address
                        shippingAddress2: ''
                        shippingCity: ''
                        shippingState: ''
                        shippingZip: '45157'
                        shippingCountry: US
                        customerId: 4440
                        customerStatus: 0
                        additionalData: null
                      splitFundingInstructions: null
                      cfeeTransactions:
                        - cFeeTransid: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                          transStatus: 1
                          feeAmount: 5
                          settlementStatus: 0
                          operation: Sale
                          responseData: {}
                          refundId: 0
                          transactionTime: '2025-12-01T09:50:03.559'
                      transactionEvents:
                        - transEvent: Created
                          eventData: 0HNHD68HATSUC:00000001
                          eventTime: '2025-12-01T09:50:02.558651'
                        - transEvent: Approved
                          eventData: 0HNHD68HATSUC:00000001
                          eventTime: '2025-12-01T09:50:03.609111'
                      pendingFeeAmount: 0
                      riskFlagged: false
                      riskFlaggedOn: '2025-12-01T09:50:02.5474568'
                      riskStatus: PASSED
                      riskReason: ''
                      riskAction: ''
                      riskActionCode: 0
                      deviceId: ''
                      achSecCode: ''
                      achHolderType: personal
                      ipAddress: 255.255.255.255
                      isSameDayACH: false
                      walletType: null
                    token: null
        '400':
          $ref: '#/components/responses/BadRequestCaptureResponseErrorV2'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '402':
          $ref: '#/components/responses/DeclinedCaptureResponseErrorV2'
        '500':
          $ref: '#/components/responses/InternalServerResponseErrorV2'
  /v2/MoneyIn/refund/{transId}:
    post:
      operationId: moneyIn_refundv2
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: refundv2
      x-fern-request-name: refundv2Request
      summary: Refund a settled transaction (v2)
      description: |-
        Give a full refund for a transaction that has settled and send money back to the account holder. To perform a partial refund, see [Partially refund a transaction](developers/api-reference/moneyinV2/partial-refund-a-settled-transaction).

        This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
      security:
        - APIKeyAuth: []
      parameters:
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          example: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
      responses:
        '201':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TransactionResponseWrapper'
              example:
                code: A0004
                reason: Refunded
                explanation: Transaction refunded
                action: No action required
                data:
                  parentOrgName: Mrinal's Pet Supplies
                  paypointDbaname: Mrinal's Pet Shop North
                  paypointLegalname: Mrinal's Pet Shop North
                  paypointEntryname: 495147f647
                  paymentTransId: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                  connectorName: gp
                  externalProcessorInformation: ''
                  gatewayTransId: TRN_Ih68D6UZdip7OEQ2QFXat1yQSLF2nB
                  orderId: null
                  method: card
                  batchNumber: 3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49
                  batchAmount: 420
                  payorId: 4440
                  paymentData:
                    maskedAccount: 4XXXXXXXXXXX5439
                    accountType: visa
                    accountExp: 12/25
                    holderName: John Cassian
                    storedId: null
                    initiator: null
                    storedMethodUsageType: null
                    sequence: null
                    orderDescription: ''
                    accountId: null
                    signatureData: null
                    binData:
                      binMatchedLength: '6'
                      binCardBrand: VISA
                      binCardType: CREDIT
                      binCardCategory: CLASSIC
                      binCardIssuer: ''
                      binCardIssuerCountry: RUSSIAN FEDERATION
                      binCardIssuerCountryCodeA2: RU
                      binCardIssuerCountryNumber: '643'
                      binCardIsRegulated: ''
                      binCardUseCategory: ''
                      binCardIssuerCountryCodeA3: ''
                    paymentDetails:
                      totalAmount: 105
                      serviceFee: 5
                      checkNumber: null
                      checkImage: null
                      checkUniqueId: ''
                      currency: USD
                      orderDescription: null
                      orderId: null
                      orderIdAlternative: null
                      paymentDescription: null
                      groupNumber: null
                      source: null
                      payabliTransId: null
                      unbundled: null
                      categories: []
                      splitFunding: []
                  transStatus: 1
                  paypointId: 3040
                  totalAmount: 105
                  netAmount: 100
                  feeAmount: 5
                  settlementStatus: 0
                  operation: Sale
                  responseData:
                    response: null
                    resultCode: A0000
                    resultCodeText: Approved
                    responsetext: CAPTURED
                    authcode: AXS425
                    transactionid: TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I
                    avsresponse: 'N'
                    avsresponse_text: No Match, No address or ZIP match
                    cvvresponse: M
                    cvvresponse_text: CVV2/CVC2 match
                    orderid: null
                    type: null
                    response_code: '100'
                    response_code_text: Operation successful
                    customer_vault_id: null
                    emv_auth_response_data: null
                  source: api
                  scheduleReference: 0
                  orgId: 17448
                  refundId: 0
                  returnedId: 0
                  chargebackId: 0
                  retrievalId: 0
                  transAdditionalData: null
                  invoiceData:
                    invoiceNumber: null
                    invoiceDate: null
                    invoiceDueDate: null
                    invoiceEndDate: null
                    invoiceStatus: null
                    invoiceType: null
                    frequency: null
                    paymentTerms: null
                    termsConditions: null
                    notes: null
                    tax: null
                    discount: null
                    invoiceAmount: null
                    freightAmount: null
                    dutyAmount: null
                    purchaseOrder: null
                    firstName: null
                    lastName: null
                    company: null
                    shippingAddress1: null
                    shippingAddress2: null
                    shippingCity: null
                    shippingState: null
                    shippingZip: null
                    shippingCountry: null
                    shippingEmail: null
                    shippingPhone: null
                    shippingFromZip: null
                    summaryCommodityCode: null
                    items: null
                    attachments: null
                    additionalData: null
                  entrypageId: 0
                  externalPaypointID: ''
                  isValidatedACH: false
                  transactionTime: '2025-12-01T09:50:03.559'
                  customer:
                    identifiers: null
                    firstName: David
                    lastName: Beckham
                    companyName: Driving School LLC
                    billingAddress1: Home Address
                    billingAddress2: ''
                    billingCity: ''
                    billingState: ''
                    billingZip: '45157'
                    billingCountry: US
                    billingPhone: '+15555555555'
                    billingEmail: example@payabli.com
                    customerNumber: C-90010
                    shippingAddress1: Home Address
                    shippingAddress2: ''
                    shippingCity: ''
                    shippingState: ''
                    shippingZip: '45157'
                    shippingCountry: US
                    customerId: 4440
                    customerStatus: 0
                    additionalData: null
                  splitFundingInstructions: null
                  cfeeTransactions:
                    - cFeeTransid: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                      transStatus: 1
                      feeAmount: 5
                      settlementStatus: 0
                      operation: Sale
                      responseData: {}
                      refundId: 0
                      transactionTime: '2025-12-01T09:50:03.559'
                  transactionEvents:
                    - transEvent: Created
                      eventData: 0HNHD68HATSUC:00000001
                      eventTime: '2025-12-01T09:50:02.558651'
                    - transEvent: Approved
                      eventData: 0HNHD68HATSUC:00000001
                      eventTime: '2025-12-01T09:50:03.609111'
                  pendingFeeAmount: 0
                  riskFlagged: false
                  riskFlaggedOn: '2025-12-01T09:50:02.5474568'
                  riskStatus: PASSED
                  riskReason: ''
                  riskAction: ''
                  riskActionCode: 0
                  deviceId: ''
                  achSecCode: ''
                  achHolderType: personal
                  ipAddress: 255.255.255.255
                  isSameDayACH: false
                  walletType: null
                token: null
        '400':
          $ref: '#/components/responses/BadRequestRefundResponseErrorV2'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '402':
          $ref: '#/components/responses/DeclinedRefundResponseErrorV2'
        '500':
          $ref: '#/components/responses/InternalServerResponseErrorV2'
  /v2/MoneyIn/refund/{transId}/{amount}:
    post:
      operationId: moneyIn_refundv2amount
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: refundv2amount
      x-fern-request-name: refundv2amountRequest
      summary: Partially refund a settled transaction (v2)
      description: |-
        Refund a transaction that has settled and send money back to the account holder. If `amount` is omitted or set to 0, performs a full refund. When a non-zero `amount` is provided, this endpoint performs a partial refund.

        This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
      security:
        - APIKeyAuth: []
      parameters:
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          examples:
            FullRefundZeroAmount:
              value: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
            RefundAmount:
              value: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
        - name: amount
          in: path
          description: Amount to refund from original transaction, minus any service fees charged on the original transaction. If omitted or set to 0, performs a full refund.
          required: true
          schema:
            type: number
            format: double
          examples:
            FullRefundZeroAmount:
              value: 0
            RefundAmount:
              value: 100.99
      responses:
        '201':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TransactionResponseWrapper'
              examples:
                FullRefundZeroAmount:
                  value:
                    code: A0004
                    reason: Refunded
                    explanation: Transaction refunded
                    action: No action required
                    data:
                      parentOrgName: Mrinal's Pet Supplies
                      paypointDbaname: Mrinal's Pet Shop North
                      paypointLegalname: Mrinal's Pet Shop North
                      paypointEntryname: 495147f647
                      paymentTransId: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                      connectorName: gp
                      externalProcessorInformation: ''
                      gatewayTransId: TRN_Ih68D6UZdip7OEQ2QFXat1yQSLF2nB
                      orderId: null
                      method: card
                      batchNumber: 3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49
                      batchAmount: 420
                      payorId: 4440
                      paymentData:
                        maskedAccount: 4XXXXXXXXXXX5439
                        accountType: visa
                        accountExp: 12/25
                        holderName: John Cassian
                        storedId: null
                        initiator: null
                        storedMethodUsageType: null
                        sequence: null
                        orderDescription: ''
                        accountId: null
                        signatureData: null
                        binData:
                          binMatchedLength: '6'
                          binCardBrand: VISA
                          binCardType: CREDIT
                          binCardCategory: CLASSIC
                          binCardIssuer: ''
                          binCardIssuerCountry: RUSSIAN FEDERATION
                          binCardIssuerCountryCodeA2: RU
                          binCardIssuerCountryNumber: '643'
                          binCardIsRegulated: ''
                          binCardUseCategory: ''
                          binCardIssuerCountryCodeA3: ''
                        paymentDetails:
                          totalAmount: 105
                          serviceFee: 5
                          checkNumber: null
                          checkImage: null
                          checkUniqueId: ''
                          currency: USD
                          orderDescription: null
                          orderId: null
                          orderIdAlternative: null
                          paymentDescription: null
                          groupNumber: null
                          source: null
                          payabliTransId: null
                          unbundled: null
                          categories: []
                          splitFunding: []
                      transStatus: 1
                      paypointId: 3040
                      totalAmount: 105
                      netAmount: 100
                      feeAmount: 5
                      settlementStatus: 0
                      operation: Sale
                      responseData:
                        response: null
                        resultCode: A0000
                        resultCodeText: Approved
                        responsetext: CAPTURED
                        authcode: AXS425
                        transactionid: TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I
                        avsresponse: 'N'
                        avsresponse_text: No Match, No address or ZIP match
                        cvvresponse: M
                        cvvresponse_text: CVV2/CVC2 match
                        orderid: null
                        type: null
                        response_code: '100'
                        response_code_text: Operation successful
                        customer_vault_id: null
                        emv_auth_response_data: null
                      source: api
                      scheduleReference: 0
                      orgId: 17448
                      refundId: 0
                      returnedId: 0
                      chargebackId: 0
                      retrievalId: 0
                      transAdditionalData: null
                      invoiceData:
                        invoiceNumber: null
                        invoiceDate: null
                        invoiceDueDate: null
                        invoiceEndDate: null
                        invoiceStatus: null
                        invoiceType: null
                        frequency: null
                        paymentTerms: null
                        termsConditions: null
                        notes: null
                        tax: null
                        discount: null
                        invoiceAmount: null
                        freightAmount: null
                        dutyAmount: null
                        purchaseOrder: null
                        firstName: null
                        lastName: null
                        company: null
                        shippingAddress1: null
                        shippingAddress2: null
                        shippingCity: null
                        shippingState: null
                        shippingZip: null
                        shippingCountry: null
                        shippingEmail: null
                        shippingPhone: null
                        shippingFromZip: null
                        summaryCommodityCode: null
                        items: null
                        attachments: null
                        additionalData: null
                      entrypageId: 0
                      externalPaypointID: ''
                      isValidatedACH: false
                      transactionTime: '2025-12-01T09:50:03.559'
                      customer:
                        identifiers: null
                        firstName: David
                        lastName: Beckham
                        companyName: Driving School LLC
                        billingAddress1: Home Address
                        billingAddress2: ''
                        billingCity: ''
                        billingState: ''
                        billingZip: '45157'
                        billingCountry: US
                        billingPhone: '+15555555555'
                        billingEmail: example@payabli.com
                        customerNumber: C-90010
                        shippingAddress1: Home Address
                        shippingAddress2: ''
                        shippingCity: ''
                        shippingState: ''
                        shippingZip: '45157'
                        shippingCountry: US
                        customerId: 4440
                        customerStatus: 0
                        additionalData: null
                      splitFundingInstructions: null
                      cfeeTransactions:
                        - cFeeTransid: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                          transStatus: 1
                          feeAmount: 5
                          settlementStatus: 0
                          operation: Sale
                          responseData: {}
                          refundId: 0
                          transactionTime: '2025-12-01T09:50:03.559'
                      transactionEvents:
                        - transEvent: Created
                          eventData: 0HNHD68HATSUC:00000001
                          eventTime: '2025-12-01T09:50:02.558651'
                        - transEvent: Approved
                          eventData: 0HNHD68HATSUC:00000001
                          eventTime: '2025-12-01T09:50:03.609111'
                      pendingFeeAmount: 0
                      riskFlagged: false
                      riskFlaggedOn: '2025-12-01T09:50:02.5474568'
                      riskStatus: PASSED
                      riskReason: ''
                      riskAction: ''
                      riskActionCode: 0
                      deviceId: ''
                      achSecCode: ''
                      achHolderType: personal
                      ipAddress: 255.255.255.255
                      isSameDayACH: false
                      walletType: null
                    token: null
                RefundAmount:
                  value:
                    code: A0004
                    reason: Refunded
                    explanation: Transaction refunded
                    action: No action required
                    data:
                      parentOrgName: Mrinal's Pet Supplies
                      paypointDbaname: Mrinal's Pet Shop North
                      paypointLegalname: Mrinal's Pet Shop North
                      paypointEntryname: 495147f647
                      paymentTransId: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                      connectorName: gp
                      externalProcessorInformation: ''
                      gatewayTransId: TRN_Ih68D6UZdip7OEQ2QFXat1yQSLF2nB
                      orderId: null
                      method: card
                      batchNumber: 3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49
                      batchAmount: 420
                      payorId: 4440
                      paymentData:
                        maskedAccount: 4XXXXXXXXXXX5439
                        accountType: visa
                        accountExp: 12/25
                        holderName: John Cassian
                        storedId: null
                        initiator: null
                        storedMethodUsageType: null
                        sequence: null
                        orderDescription: ''
                        accountId: null
                        signatureData: null
                        binData:
                          binMatchedLength: '6'
                          binCardBrand: VISA
                          binCardType: CREDIT
                          binCardCategory: CLASSIC
                          binCardIssuer: ''
                          binCardIssuerCountry: RUSSIAN FEDERATION
                          binCardIssuerCountryCodeA2: RU
                          binCardIssuerCountryNumber: '643'
                          binCardIsRegulated: ''
                          binCardUseCategory: ''
                          binCardIssuerCountryCodeA3: ''
                        paymentDetails:
                          totalAmount: 105
                          serviceFee: 5
                          checkNumber: null
                          checkImage: null
                          checkUniqueId: ''
                          currency: USD
                          orderDescription: null
                          orderId: null
                          orderIdAlternative: null
                          paymentDescription: null
                          groupNumber: null
                          source: null
                          payabliTransId: null
                          unbundled: null
                          categories: []
                          splitFunding: []
                      transStatus: 1
                      paypointId: 3040
                      totalAmount: 105
                      netAmount: 100
                      feeAmount: 5
                      settlementStatus: 0
                      operation: Sale
                      responseData:
                        response: null
                        resultCode: A0000
                        resultCodeText: Approved
                        responsetext: CAPTURED
                        authcode: AXS425
                        transactionid: TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I
                        avsresponse: 'N'
                        avsresponse_text: No Match, No address or ZIP match
                        cvvresponse: M
                        cvvresponse_text: CVV2/CVC2 match
                        orderid: null
                        type: null
                        response_code: '100'
                        response_code_text: Operation successful
                        customer_vault_id: null
                        emv_auth_response_data: null
                      source: api
                      scheduleReference: 0
                      orgId: 17448
                      refundId: 0
                      returnedId: 0
                      chargebackId: 0
                      retrievalId: 0
                      transAdditionalData: null
                      invoiceData:
                        invoiceNumber: null
                        invoiceDate: null
                        invoiceDueDate: null
                        invoiceEndDate: null
                        invoiceStatus: null
                        invoiceType: null
                        frequency: null
                        paymentTerms: null
                        termsConditions: null
                        notes: null
                        tax: null
                        discount: null
                        invoiceAmount: null
                        freightAmount: null
                        dutyAmount: null
                        purchaseOrder: null
                        firstName: null
                        lastName: null
                        company: null
                        shippingAddress1: null
                        shippingAddress2: null
                        shippingCity: null
                        shippingState: null
                        shippingZip: null
                        shippingCountry: null
                        shippingEmail: null
                        shippingPhone: null
                        shippingFromZip: null
                        summaryCommodityCode: null
                        items: null
                        attachments: null
                        additionalData: null
                      entrypageId: 0
                      externalPaypointID: ''
                      isValidatedACH: false
                      transactionTime: '2025-12-01T09:50:03.559'
                      customer:
                        identifiers: null
                        firstName: David
                        lastName: Beckham
                        companyName: Driving School LLC
                        billingAddress1: Home Address
                        billingAddress2: ''
                        billingCity: ''
                        billingState: ''
                        billingZip: '45157'
                        billingCountry: US
                        billingPhone: '+15555555555'
                        billingEmail: example@payabli.com
                        customerNumber: C-90010
                        shippingAddress1: Home Address
                        shippingAddress2: ''
                        shippingCity: ''
                        shippingState: ''
                        shippingZip: '45157'
                        shippingCountry: US
                        customerId: 4440
                        customerStatus: 0
                        additionalData: null
                      splitFundingInstructions: null
                      cfeeTransactions:
                        - cFeeTransid: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                          transStatus: 1
                          feeAmount: 5
                          settlementStatus: 0
                          operation: Sale
                          responseData: {}
                          refundId: 0
                          transactionTime: '2025-12-01T09:50:03.559'
                      transactionEvents:
                        - transEvent: Created
                          eventData: 0HNHD68HATSUC:00000001
                          eventTime: '2025-12-01T09:50:02.558651'
                        - transEvent: Approved
                          eventData: 0HNHD68HATSUC:00000001
                          eventTime: '2025-12-01T09:50:03.609111'
                      pendingFeeAmount: 0
                      riskFlagged: false
                      riskFlaggedOn: '2025-12-01T09:50:02.5474568'
                      riskStatus: PASSED
                      riskReason: ''
                      riskAction: ''
                      riskActionCode: 0
                      deviceId: ''
                      achSecCode: ''
                      achHolderType: personal
                      ipAddress: 255.255.255.255
                      isSameDayACH: false
                      walletType: null
                    token: null
        '400':
          $ref: '#/components/responses/BadRequestRefundResponseErrorV2'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '402':
          $ref: '#/components/responses/DeclinedRefundResponseErrorV2'
        '500':
          $ref: '#/components/responses/InternalServerResponseErrorV2'
  /v2/MoneyIn/void/{transId}:
    post:
      operationId: moneyIn_voidv2
      tags:
        - MoneyIn
      x-fern-sdk-group-name: moneyIn
      x-fern-sdk-method-name: voidv2
      x-fern-request-name: voidv2Request
      summary: Void a transaction (v2)
      description: Cancel a transaction that hasn't been settled yet. Voiding non-captured authorizations prevents future captures. This is the v2 version of the `api/MoneyIn/void/{transId}` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
      security:
        - APIKeyAuth: []
      parameters:
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          example: 10-3ffa27df-b171-44e0-b251-e95fbfc7a723
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2TransactionResponseWrapper'
              example:
                code: A0003
                reason: Canceled
                explanation: Transaction canceled
                action: No action required
                data:
                  parentOrgName: Mrinal's Pet Supplies
                  paypointDbaname: Mrinal's Pet Shop North
                  paypointLegalname: Mrinal's Pet Shop North
                  paypointEntryname: 495147f647
                  paymentTransId: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                  connectorName: gp
                  externalProcessorInformation: ''
                  gatewayTransId: TRN_Ih68D6UZdip7OEQ2QFXat1yQSLF2nB
                  orderId: null
                  method: card
                  batchNumber: 3040_combined_20251201_3a50747d-6b5c-40ef-9f69-93a9cc7fcb49
                  batchAmount: 420
                  payorId: 4440
                  paymentData:
                    maskedAccount: 4XXXXXXXXXXX5439
                    accountType: visa
                    accountExp: 12/25
                    holderName: John Cassian
                    storedId: null
                    initiator: null
                    storedMethodUsageType: null
                    sequence: null
                    orderDescription: ''
                    accountId: null
                    signatureData: null
                    binData:
                      binMatchedLength: '6'
                      binCardBrand: VISA
                      binCardType: CREDIT
                      binCardCategory: CLASSIC
                      binCardIssuer: ''
                      binCardIssuerCountry: RUSSIAN FEDERATION
                      binCardIssuerCountryCodeA2: RU
                      binCardIssuerCountryNumber: '643'
                      binCardIsRegulated: ''
                      binCardUseCategory: ''
                      binCardIssuerCountryCodeA3: ''
                    paymentDetails:
                      totalAmount: 105
                      serviceFee: 5
                      checkNumber: null
                      checkImage: null
                      checkUniqueId: ''
                      currency: USD
                      orderDescription: null
                      orderId: null
                      orderIdAlternative: null
                      paymentDescription: null
                      groupNumber: null
                      source: null
                      payabliTransId: null
                      unbundled: null
                      categories: []
                      splitFunding: []
                  transStatus: 5
                  paypointId: 3040
                  totalAmount: 105
                  netAmount: 100
                  feeAmount: 5
                  settlementStatus: 0
                  operation: Sale
                  responseData:
                    response: null
                    resultCode: A0000
                    resultCodeText: Approved
                    responsetext: CAPTURED
                    authcode: AXS425
                    transactionid: TRN_Xo4dpKfmx3OxSc9svd2ccI6OOnyB2I
                    avsresponse: 'N'
                    avsresponse_text: No Match, No address or ZIP match
                    cvvresponse: M
                    cvvresponse_text: CVV2/CVC2 match
                    orderid: null
                    type: null
                    response_code: '100'
                    response_code_text: Operation successful
                    customer_vault_id: null
                    emv_auth_response_data: null
                  source: api
                  scheduleReference: 0
                  orgId: 17448
                  refundId: 0
                  returnedId: 0
                  chargebackId: 0
                  retrievalId: 0
                  transAdditionalData: null
                  invoiceData:
                    invoiceNumber: null
                    invoiceDate: null
                    invoiceDueDate: null
                    invoiceEndDate: null
                    invoiceStatus: null
                    invoiceType: null
                    frequency: null
                    paymentTerms: null
                    termsConditions: null
                    notes: null
                    tax: null
                    discount: null
                    invoiceAmount: null
                    freightAmount: null
                    dutyAmount: null
                    purchaseOrder: null
                    firstName: null
                    lastName: null
                    company: null
                    shippingAddress1: null
                    shippingAddress2: null
                    shippingCity: null
                    shippingState: null
                    shippingZip: null
                    shippingCountry: null
                    shippingEmail: null
                    shippingPhone: null
                    shippingFromZip: null
                    summaryCommodityCode: null
                    items: null
                    attachments: null
                    additionalData: null
                  entrypageId: 0
                  externalPaypointID: ''
                  isValidatedACH: false
                  transactionTime: '2025-12-01T09:50:03.559'
                  customer:
                    identifiers: null
                    firstName: David
                    lastName: Beckham
                    companyName: Driving School LLC
                    billingAddress1: Home Address
                    billingAddress2: ''
                    billingCity: ''
                    billingState: ''
                    billingZip: '45157'
                    billingCountry: US
                    billingPhone: '+15555555555'
                    billingEmail: example@payabli.com
                    customerNumber: C-90010
                    shippingAddress1: Home Address
                    shippingAddress2: ''
                    shippingCity: ''
                    shippingState: ''
                    shippingZip: '45157'
                    shippingCountry: US
                    customerId: 4440
                    customerStatus: 0
                    additionalData: null
                  splitFundingInstructions: null
                  cfeeTransactions:
                    - cFeeTransid: 3040-96dfa9a7c4ed4f82a3dd4a4a12ad28ae
                      transStatus: 1
                      feeAmount: 5
                      settlementStatus: 0
                      operation: Sale
                      responseData: {}
                      refundId: 0
                      transactionTime: '2025-12-01T09:50:03.559'
                  transactionEvents:
                    - transEvent: Created
                      eventData: 0HNHD68HATSUC:00000001
                      eventTime: '2025-12-01T09:50:02.558651'
                    - transEvent: Approved
                      eventData: 0HNHD68HATSUC:00000001
                      eventTime: '2025-12-01T09:50:03.609111'
                  pendingFeeAmount: 0
                  riskFlagged: false
                  riskFlaggedOn: '2025-12-01T09:50:02.5474568'
                  riskStatus: PASSED
                  riskReason: ''
                  riskAction: ''
                  riskActionCode: 0
                  deviceId: ''
                  achSecCode: ''
                  achHolderType: personal
                  ipAddress: 255.255.255.255
                  isSameDayACH: false
                  walletType: null
                token: null
        '400':
          $ref: '#/components/responses/BadRequestVoidResponseErrorV2'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '402':
          $ref: '#/components/responses/DeclinedVoidResponseErrorV2'
        '500':
          $ref: '#/components/responses/InternalServerResponseErrorV2'
  /Subscription/{subId}:
    get:
      operationId: subscription_GetSubscription
      tags:
        - Subscription
      x-fern-sdk-group-name: subscription
      x-fern-sdk-method-name: GetSubscription
      x-fern-request-name: GetSubscriptionRequest
      summary: Get a subscription
      description: Retrieves a single subscription's details.
      security:
        - APIKeyAuth: []
      parameters:
        - name: subId
          in: path
          description: The subscription ID.
          required: true
          schema:
            type: integer
          examples:
            GetSubscription:
              value: 263
            GetBalanceDrivenSubscription:
              value: 50317
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionQueryRecords'
              examples:
                GetSubscription:
                  value:
                    CreatedAt: '2022-07-01T15:00:01Z'
                    Customer:
                      AdditionalData: null
                      BillingAddress1: 1111 West 1st Street
                      BillingAddress2: Suite 200
                      BillingCity: Miami
                      BillingCountry: US
                      BillingEmail: example@email.com
                      BillingPhone: '5555555555'
                      BillingState: FL
                      BillingZip: '45567'
                      CompanyName: Sunshine LLC
                      customerId: 4440
                      CustomerNumber: 3456-7645A
                      customerStatus: 1
                      FirstName: John
                      Identifiers:
                        - \"firstname\"
                        - \"lastname\"
                        - \"email\"
                        - \"customId\"
                      LastName: Doe
                      ShippingAddress1: 123 Walnut St
                      ShippingAddress2: STE 900
                      ShippingCity: Johnson City
                      ShippingCountry: US
                      ShippingState: TN
                      ShippingZip: '37619'
                    EndDate: '2025-10-19T00:00:00Z'
                    EntrypageId: 0
                    ExternalPaypointID: Paypoint-100
                    FeeAmount: 3
                    Frequency: monthly
                    IdSub: 396
                    invoiceData:
                      AdditionalData: null
                      attachments:
                        - {}
                      company: ACME, INC
                      discount: 10
                      dutyAmount: 0
                      firstName: Chad
                      freightAmount: 10
                      frequency: onetime
                      invoiceAmount: 105
                      invoiceDate: '2025-07-01'
                      invoiceDueDate: '2025-07-01'
                      invoiceEndDate: '2025-07-01'
                      invoiceNumber: INV-2345
                      invoiceStatus: 1
                      invoiceType: 0
                      items:
                        - itemCost: 5
                          itemProductName: Materials deposit
                          itemQty: 1
                      lastName: Mercia
                      notes: Example notes.
                      paymentTerms: PIA
                      purchaseOrder: PO-345
                      shippingAddress1: 123 Walnut St
                      shippingAddress2: STE 900
                      shippingCity: Johnson City
                      shippingCountry: US
                      shippingEmail: example@email.com
                      shippingFromZip: '30040'
                      shippingPhone: '5555555555'
                      shippingState: TN
                      shippingZip: '37619'
                      summaryCommodityCode: '501718'
                      tax: 2.05
                      termsConditions: Must be paid before work scheduled.
                    LastRun: '2025-10-19T00:00:00Z'
                    LastUpdated: '2022-07-01T15:00:01Z'
                    LeftCycles: 15
                    Method: card
                    NetAmount: 3762.87
                    NextDate: '2025-10-19T00:00:00Z'
                    ParentOrgName: PropertyManager Pro
                    PaymentData:
                      AccountExp: 11/29
                      accountId: accountId
                      AccountType: visa
                      AccountZip: '90210'
                      binData:
                        binMatchedLength: '6'
                        binCardBrand: Visa
                        binCardType: Credit
                        binCardCategory: PLATINUM
                        binCardIssuer: Bank of Example
                        binCardIssuerCountry: United States
                        binCardIssuerCountryCodeA2: US
                        binCardIssuerCountryNumber: '840'
                        binCardIsRegulated: 'false'
                        binCardUseCategory: Consumer
                        binCardIssuerCountryCodeA3: USA
                      HolderName: Chad Mercia
                      Initiator: payor
                      MaskedAccount: 4XXXXXXXX1111
                      orderDescription: Depost for materials for 123 Walnut St
                      paymentDetails:
                        categories:
                          - amount: 1000
                            label: Deposit
                        checkImage:
                          key: value
                        checkNumber: '107'
                        currency: USD
                        serviceFee: 0
                        splitFunding:
                          - {}
                        totalAmount: 100
                      Sequence: subsequent
                      SignatureData: SignatureData
                      StoredId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      StoredMethodUsageType: subscription
                    PaypointDbaname: Sunshine Gutters
                    PaypointEntryname: d193cf9a46
                    PaypointId: 255
                    PaypointLegalname: Sunshine Services, LLC
                    PlanId: 0
                    Source: api
                    StartDate: '2025-10-19T00:00:00Z'
                    SubEvents:
                      - description: TransferCreated
                        eventTime: '2023-07-05T22:31:06Z'
                        extraData: null
                        refData: refData
                        source: api
                    SubStatus: 1
                    SubscriptionType: Regular
                    TotalAmount: 103
                    TotalCycles: 24
                    UntilCancelled: true
                GetBalanceDrivenSubscription:
                  value:
                    CreatedAt: '2026-05-12T15:25:28Z'
                    Customer:
                      AdditionalData: null
                      BillingAddress1: 1111 West 1st Street
                      BillingAddress2: Suite 200
                      BillingCity: Miami
                      BillingCountry: US
                      BillingEmail: example@email.com
                      BillingPhone: '5555555555'
                      BillingState: FL
                      BillingZip: '45567'
                      CompanyName: Sunshine LLC
                      customerId: 4440
                      CustomerNumber: 3456-7645A
                      customerStatus: 1
                      FirstName: John
                      Identifiers:
                        - \"firstname\"
                        - \"lastname\"
                      LastName: Doe
                      ShippingAddress1: 123 Walnut St
                      ShippingAddress2: STE 900
                      ShippingCity: Johnson City
                      ShippingCountry: US
                      ShippingState: TN
                      ShippingZip: '37619'
                    EndDate: '2046-05-01T00:00:00Z'
                    EntrypageId: 0
                    ExternalPaypointID: Paypoint-100
                    FeeAmount: 0
                    Frequency: firstofmonth
                    IdSub: 50317
                    invoiceData: null
                    LastRun: '2026-05-13T14:14:22Z'
                    LastUpdated: '2026-05-12T15:25:28Z'
                    LeftCycles: 238
                    Method: card
                    NetAmount: 0
                    NextDate: '2026-06-01T00:00:00Z'
                    ParentOrgName: PropertyManager Pro
                    PaymentData:
                      AccountExp: 11/29
                      accountId: accountId
                      AccountType: visa
                      AccountZip: '90210'
                      binData:
                        binMatchedLength: '6'
                        binCardBrand: Visa
                        binCardType: Credit
                        binCardCategory: PLATINUM
                        binCardIssuer: Bank of Example
                        binCardIssuerCountry: United States
                        binCardIssuerCountryCodeA2: US
                        binCardIssuerCountryNumber: '840'
                        binCardIsRegulated: 'false'
                        binCardUseCategory: Consumer
                        binCardIssuerCountryCodeA3: USA
                      HolderName: Chad Mercia
                      Initiator: payor
                      MaskedAccount: 4XXXXXXXX1111
                      orderDescription: null
                      paymentDetails:
                        categories: []
                        checkImage: null
                        checkNumber: null
                        currency: USD
                        serviceFee: 0
                        splitFunding: []
                        totalAmount: 0
                      Sequence: subsequent
                      SignatureData: null
                      StoredId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      StoredMethodUsageType: subscription
                    PaypointDbaname: Sunshine Gutters
                    PaypointEntryname: d193cf9a46
                    PaypointId: 255
                    PaypointLegalname: Sunshine Services, LLC
                    PlanId: 0
                    Source: api
                    StartDate: '2026-05-01T00:00:00Z'
                    StoredMethod:
                      IdPmethod: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      Method: card
                      Descriptor: visa
                      MaskedAccount: 4XXXXXXXX1111
                      ExpDate: '1129'
                      HolderName: Chad Mercia
                      AchSecCode: null
                      AchHolderType: null
                      IsValidatedACH: false
                      BIN: ''
                      binData:
                        binMatchedLength: '6'
                        binCardBrand: Visa
                        binCardType: Credit
                        binCardCategory: PLATINUM
                        binCardIssuer: Bank of Example
                        binCardIssuerCountry: United States
                        binCardIssuerCountryCodeA2: US
                        binCardIssuerCountryNumber: '840'
                        binCardIsRegulated: 'false'
                        binCardUseCategory: Consumer
                        binCardIssuerCountryCodeA3: USA
                      ABA: ''
                      PostalCode: '37619'
                      MethodType: Single Merchant
                      LastUpdated: '2026-05-12T15:25:28Z'
                      CardUpdatedOn: '1970-01-01T00:00:00Z'
                    SubEvents:
                      - description: created
                        eventTime: '2026-05-12T15:25:27Z'
                        extraData: null
                        refData: 0HNLG6L6JNIP5:00000001
                        source: null
                      - description: executed
                        eventTime: '2026-05-13T14:14:27Z'
                        extraData: '{"totalAmount":13.5,"serviceFee":1.5}'
                        refData: autopay worker
                        source: null
                    SubStatus: 1
                    SubscriptionType: BalanceDriven
                    TotalAmount: 0
                    TotalCycles: 239
                    UntilCancelled: true
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    delete:
      operationId: subscription_RemoveSubscription
      tags:
        - Subscription
      x-fern-sdk-group-name: subscription
      x-fern-sdk-method-name: RemoveSubscription
      x-fern-request-name: RemoveSubscriptionRequest
      summary: Delete a subscription
      description: Deletes a subscription, autopay, or recurring payment and prevents future charges.
      security:
        - APIKeyAuth: []
      parameters:
        - name: subId
          in: path
          description: The subscription ID.
          required: true
          schema:
            type: integer
          example: 396
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveSubscriptionResponse'
              example:
                isSuccess: true
                responseData: '396'
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: subscription_UpdateSubscription
      tags:
        - Subscription
      x-fern-sdk-group-name: subscription
      x-fern-sdk-method-name: UpdateSubscription
      x-fern-request-name: RequestUpdateSchedule
      summary: Update a subscription
      description: Updates a subscription's details.
      security:
        - APIKeyAuth: []
      parameters:
        - name: subId
          in: path
          description: The subscription ID.
          required: true
          schema:
            type: integer
          examples:
            PauseSubscription:
              value: 231
            UnpauseSubscription:
              value: 231
            UpdateSubscription:
              value: 231
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestUpdateSchedule'
            examples:
              PauseSubscription:
                value:
                  setPause: true
              UnpauseSubscription:
                value:
                  setPause: false
              UpdateSubscription:
                value:
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  scheduleDetails:
                    endDate: 03-20-2025
                    frequency: weekly
                    planId: 1
                    startDate: 09-20-2024
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSubscriptionResponse'
              examples:
                PauseSubscription:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData: 396 paused
                    customerId: 4440
                UnpauseSubscription:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData: 396 unpaused
                    customerId: 4440
                UpdateSubscription:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData: 396 updated
                    customerId: 4440
  /Subscription/add:
    post:
      operationId: subscription_NewSubscription
      tags:
        - Subscription
      x-fern-sdk-group-name: subscription
      x-fern-sdk-method-name: NewSubscription
      x-fern-request-name: RequestSchedule
      summary: Create Subscription
      description: Creates a subscription or scheduled payment to run at a specified time and frequency. You can use stored payment method tokens for card, ACH, and digital wallets by passing them into the `paymentMethod.storedMethodId` field.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
        - name: forceCustomerCreation
          in: query
          required: false
          description: When `true`, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to `false`.
          schema:
            $ref: '#/components/schemas/ForceCustomerCreation'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionRequestBody'
            examples:
              CardSubscription:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    cardcvv: '123'
                    cardexp: 02/25
                    cardHolder: John Cassian
                    cardnumber: '4111111111111111'
                    cardzip: '37615'
                    initiator: payor
                    method: card
                  scheduleDetails:
                    endDate: 03-20-2025
                    frequency: weekly
                    planId: 1
                    startDate: 09-20-2024
              ACHSubscription:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    achAccount: '3453445666'
                    achAccountType: Checking
                    achCode: PPD
                    achHolder: John Cassian
                    achHolderType: personal
                    achRouting: '021000021'
                    method: ach
                  scheduleDetails:
                    endDate: 03-20-2025
                    frequency: weekly
                    planId: 1
                    startDate: 09-20-2024
              StoredMethodSubscription:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    initiator: merchant
                    storedMethodId: 4000e8c6-3add-4200-8ac2-9b8a4f8b1639-1323
                    storedMethodUsageType: recurring
                  scheduleDetails:
                    endDate: 03-20-2025
                    frequency: weekly
                    planId: 1
                    startDate: 09-20-2024
              BalanceDrivenSubscription:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  subscriptionType: BalanceDriven
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 100
                  paymentMethod:
                    cardcvv: '123'
                    cardexp: 02/25
                    cardHolder: John Cassian
                    cardnumber: '4111111111111111'
                    cardzip: '37615'
                    initiator: payor
                    method: card
                  scheduleDetails:
                    frequency: endofmonth
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddSubscriptionResponse'
              examples:
                CardSubscription:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData: 396
                    customerId: 4440
                ACHSubscription:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData: 396
                    customerId: 4440
                StoredMethodSubscription:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData: 396
                    customerId: 4440
                BalanceDrivenSubscription:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData: 396
                    customerId: 4440
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Invoice/{entry}:
    post:
      operationId: invoice_AddInvoice
      tags:
        - Invoice
      x-fern-sdk-group-name: invoice
      x-fern-sdk-method-name: AddInvoice
      x-fern-request-name: AddInvoiceRequest
      summary: Add invoice
      description: Creates an invoice in an entrypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
        - name: forceCustomerCreation
          in: query
          required: false
          description: When `true`, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to `false`.
          schema:
            $ref: '#/components/schemas/ForceCustomerCreation'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvoiceDataRequest'
            example:
              customerData:
                firstName: Tamara
                lastName: Bagratoni
                customerNumber: '3'
              invoiceData:
                items:
                  - itemProductName: Adventure Consult
                    itemDescription: Consultation for Georgian tours
                    itemCost: 100
                    itemQty: 1
                    itemMode: 1
                    itemTotalAmount: 1
                  - itemProductName: 'Deposit '
                    itemDescription: Deposit for trip planning
                    itemCost: 882.37
                    itemQty: 1
                    itemTotalAmount: 1
                invoiceDate: '2025-10-19'
                invoiceType: 0
                invoiceStatus: 1
                frequency: onetime
                invoiceAmount: 982.37
                discount: 10
                invoiceNumber: INV-3
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceResponseWithoutData'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 3625
                responseText: Success
                pageidentifier: null
                roomId: 0
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Invoice/attachedFileFromInvoice/{idInvoice}/{filename}:
    delete:
      operationId: invoice_deleteAttachedFromInvoice
      tags:
        - Invoice
      x-fern-sdk-group-name: invoice
      x-fern-sdk-method-name: deleteAttachedFromInvoice
      x-fern-request-name: deleteAttachedFromInvoiceRequest
      summary: Delete attached file from invoice
      description: Deletes a file attached to an invoice.
      security:
        - APIKeyAuth: []
      parameters:
        - name: filename
          in: path
          description: |-
            The filename in Payabli. Get this from the `zipName` field
            in the `DocumentsRef.filelist` array returned by
            `/api/Invoice/{idInvoice}`. Example: `0_Bill.pdf`.
          required: true
          schema:
            type: string
          example: 0_Bill.pdf
        - name: idInvoice
          in: path
          description: Invoice ID
          required: true
          schema:
            type: integer
          example: 23548884
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceResponseWithoutData'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 3625
                responseText: Success
                pageidentifier: null
                roomId: 0
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    get:
      operationId: invoice_GetAttachedFileFromInvoice
      tags:
        - Invoice
      x-fern-sdk-group-name: invoice
      x-fern-sdk-method-name: GetAttachedFileFromInvoice
      x-fern-request-name: GetAttachedFileFromInvoiceRequest
      summary: Get attached file from an invoice
      description: Retrieves a file attached to an invoice.
      security:
        - APIKeyAuth: []
      parameters:
        - name: filename
          in: path
          description: |-
            The filename in Payabli. Get this from the `zipName` field
            in the `DocumentsRef.filelist` array returned by
            `/api/Invoice/{idInvoice}`. Example: `0_Bill.pdf`.
          required: true
          schema:
            type: string
        - name: idInvoice
          in: path
          description: Invoice ID
          required: true
          schema:
            type: integer
        - name: returnObject
          in: query
          description: When `true`, the request returns the file content as a Base64-encoded string.
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: A successful response returns a binary file when `returnObject` is `false`. When `returnObject` is `true`, the response contains the file content as a Base64-encoded string in an object. Due to technical limitations, only the object response is documented here.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileContent'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Invoice/{idInvoice}:
    delete:
      operationId: invoice_DeleteInvoice
      tags:
        - Invoice
      x-fern-sdk-group-name: invoice
      x-fern-sdk-method-name: DeleteInvoice
      x-fern-request-name: DeleteInvoiceRequest
      summary: Delete invoice
      description: Deletes a single invoice from an entrypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idInvoice
          in: path
          description: Invoice ID
          required: true
          schema:
            type: integer
          example: 23548884
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceResponseWithoutData'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 3625
                responseText: Success
                pageidentifier: null
                roomId: 0
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: invoice_EditInvoice
      tags:
        - Invoice
      x-fern-sdk-group-name: invoice
      x-fern-sdk-method-name: EditInvoice
      x-fern-request-name: EditInvoiceRequest
      summary: Update invoice
      description: Updates details for a single invoice in an entrypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idInvoice
          in: path
          description: Invoice ID
          required: true
          schema:
            type: integer
          example: 332
        - name: forceCustomerCreation
          in: query
          description: When `true`, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.
          required: false
          schema:
            type: boolean
            default: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvoiceDataRequest'
            example:
              invoiceData:
                items:
                  - itemProductName: Deposit
                    itemDescription: Deposit for trip planning
                    itemCost: 882.37
                    itemQty: 1
                invoiceDate: '2025-10-19'
                invoiceAmount: 982.37
                invoiceNumber: INV-6
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceResponseWithoutData'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 332
                responseText: Success
                pageidentifier: null
                roomId: 0
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    get:
      operationId: invoice_GetInvoice
      tags:
        - Invoice
      x-fern-sdk-group-name: invoice
      x-fern-sdk-method-name: GetInvoice
      x-fern-request-name: GetInvoiceRequest
      summary: Get invoice
      description: Retrieves a single invoice by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idInvoice
          in: path
          description: Invoice ID
          required: true
          schema:
            type: integer
          example: 23548884
      responses:
        '200':
          description: Success. Fields marked optional may return `null` if not set.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInvoiceRecord'
              example:
                AdditionalData: null
                billEvents:
                  - description: TransferCreated
                    eventTime: '2023-07-05T22:31:06Z'
                    extraData: null
                    refData: refData
                    source: api
                company: Acme Inc
                createdAt: '2022-07-01T15:00:01Z'
                Customer:
                  AdditionalData: null
                  BillingAddress1: 1111 West 1st Street
                  BillingAddress2: Suite 200
                  BillingCity: Miami
                  BillingCountry: US
                  BillingEmail: example@email.com
                  BillingPhone: '5555555555'
                  BillingState: FL
                  BillingZip: '45567'
                  CompanyName: Sunshine LLC
                  customerId: 4440
                  CustomerNumber: 3456-7645A
                  customerStatus: 1
                  FirstName: John
                  Identifiers:
                    - \"firstname\"
                    - \"lastname\"
                    - \"email\"
                    - \"customId\"
                  LastName: Doe
                  ShippingAddress1: 123 Walnut St
                  ShippingAddress2: STE 900
                  ShippingCity: Johnson City
                  ShippingCountry: US
                  ShippingState: TN
                  ShippingZip: '37619'
                customerId: 4440
                discount: 10
                DocumentsRef:
                  filelist:
                    - {}
                  zipfile: zx45.zip
                dutyAmount: 0
                firstName: firstName
                freightAmount: 10
                frequency: onetime
                invoiceAmount: 105
                invoiceDate: '2025-07-01'
                invoiceDueDate: '2025-07-01'
                invoiceEndDate: '2025-07-01'
                invoiceId: 236
                invoiceNumber: INV-2345
                invoicePaidAmount: 0
                invoiceSentDate: '2025-10-19T00:00:00Z'
                invoiceStatus: 1
                invoiceType: 0
                items:
                  - itemCommodityCode: '010'
                    itemCost: 5
                    itemDescription: Deposit for materials.
                    itemMode: 0
                    itemProductCode: M-DEPOSIT
                    itemProductName: Materials deposit
                    itemQty: 1
                    itemTaxAmount: 7
                    itemTaxRate: 0.075
                    itemTotalAmount: 1.1
                    itemUnitOfMeasure: SqFt
                lastName: lastName
                lastPaymentDate: '2025-10-19T00:00:00Z'
                notes: null
                ParentOrgName: parentOrgName
                paylinkId: paylinkId
                paymentTerms: NET30
                PaypointDbaname: Sinks Inc
                PaypointEntryname: 5789a30009s
                paypointId: 56
                PaypointLegalname: Sinks and Faucets LLC
                purchaseOrder: PO-345
                scheduledOptions:
                  includePaylink: true
                  includePdf: true
                shippingAddress1: 123 Walnut St
                shippingAddress2: STE 900
                shippingCity: Johnson City
                shippingCountry: US
                shippingEmail: example@email.com
                shippingFromZip: '30040'
                shippingPhone: shippingPhone
                shippingState: TN
                shippingZip: '37619'
                summaryCommodityCode: '501718'
                tax: 2.05
                termsConditions: termsConditions
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Invoice/getNumber/{entry}:
    get:
      operationId: invoice_GetInvoiceNumber
      tags:
        - Invoice
      x-fern-sdk-group-name: invoice
      x-fern-sdk-method-name: GetInvoiceNumber
      x-fern-request-name: GetInvoiceNumberRequest
      summary: Get next InvoiceNumber for entrypoint
      description: Retrieves the next available invoice number for a paypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceNumberResponse'
              example:
                isSuccess: true
                responseData: MyInvoice-114434565s32440
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/invoices/{entry}:
    get:
      operationId: invoice_ListInvoices
      tags:
        - Invoice
      x-fern-sdk-group-name: invoice
      x-fern-sdk-method-name: ListInvoices
      x-fern-request-name: ListInvoicesRequest
      summary: Get list of invoices for an entrypoint
      description: Returns a list of invoices for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - name: parameters
          in: query
          description: |-
            Collection of field names, conditions, and values used to filter the query

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:

            - `invoiceDate` (gt, ge, lt, le, eq, ne)
            - `dueDate` (gt, ge, lt, le, eq, ne)
            - `sentDate` (gt, ge, lt, le, eq, ne)
            - `frequency` (in, nin,ne, eq)
            - `invoiceType` (eq, ne)
            - `payTerms` (in, nin, eq, ne)
            - `paypointId` (ne, eq)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `paidAmount` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `invoiceNumber` (ct, nct, eq, ne)
            - `purchaseOrder` (ct, nct, eq, ne)
            - `itemProductCode` (ct, nct)
            - `itemDescription` (ct, nct)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId` (eq)
            - `paylinkId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            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: totalAmount(gt)=20 return all records with totalAmount greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success. Fields marked optional may return `null` if not set.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryInvoiceResponse'
              example:
                Records:
                  - invoiceId: 3674
                    customerId: 1323
                    paypointId: 10
                    invoiceNumber: QA-1709680125
                    invoiceDate: '2025-03-05'
                    invoiceDueDate: '2025-03-05'
                    invoiceSentDate: '2025-03-05'
                    invoiceEndDate: '2025-03-05'
                    lastPaymentDate: null
                    createdAt: '2024-03-05T18:08:45Z'
                    invoiceStatus: 1
                    invoiceType: 0
                    frequency: onetime
                    paymentTerms: NET30
                    termsConditions: null
                    notes: null
                    tax: 0
                    discount: 0
                    invoiceAmount: 50
                    invoicePaidAmount: 0
                    freightAmount: 0
                    dutyAmount: 0
                    purchaseOrder: null
                    firstName: Amirah
                    lastName: Tan
                    company: null
                    shippingAddress1: 1234 Rainier Ave
                    shippingAddress2: Apt 567
                    shippingCity: Seattle
                    shippingState: WA
                    shippingZip: '98101'
                    shippingFromZip: ''
                    shippingCountry: US
                    shippingEmail: amirah.tan@example.com
                    shippingPhone: ''
                    summaryCommodityCode: null
                    items:
                      - itemCost: 50
                        itemDescription: service
                        itemProductName: Internet
                        itemQty: 1
                    Customer:
                      AdditionalData:
                        key1: value
                        key2: value
                        key3: value
                      BillingPhone: '1234567890'
                      customerId: 1323
                    paylinkId: 3674-cf15b881-f276-4b69-bdc8-841b2d123XXXXXX
                    billEvents:
                      - description: Invoice created
                        eventTime: '2024-03-05T23:08:45Z'
                        refData: 00-802fa578504a7af6f3dd890a3802f7ef-61b4bedXXXX1234
                    scheduledOptions: null
                    PaypointLegalname: Emerald City LLC
                    PaypointDbaname: Emerald City Trading
                    PaypointEntryname: 47a30009s
                    ParentOrgId: 123
                    ParentOrgName: Emerald Enterprises
                    AdditionalData: null
                    DocumentsRef: null
                    externalPaypointID: seattletrade01-10
                    pageIdentifier: null
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 77.22
                  totalNetAmount: 77.22
                  totalPages: 2
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/invoices/org/{orgId}:
    get:
      operationId: invoice_ListInvoicesOrg
      tags:
        - Invoice
      x-fern-sdk-group-name: invoice
      x-fern-sdk-method-name: ListInvoicesOrg
      x-fern-request-name: ListInvoicesOrgRequest
      summary: Get list of invoices for an organization
      description: Returns a list of invoices for an org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - name: parameters
          in: query
          description: |-
            Collection of field names, conditions, and values used to filter the query

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:

            - `invoiceDate` (gt, ge, lt, le, eq, ne)
            - `dueDate` (gt, ge, lt, le, eq, ne)
            - `sentDate` (gt, ge, lt, le, eq, ne)
            - `frequency` (in, nin,ne, eq)
            - `invoiceType` (eq, ne)
            - `payTerms` (in, nin, eq, ne)
            - `paypointId` (ne, eq)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `paidAmount` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `invoiceNumber` (ct, nct, eq, ne)
            - `purchaseOrder` (ct, nct, eq, ne)
            - `itemProductCode` (ct, nct)
            - `itemDescription` (ct, nct)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId` (eq)
            - `paylinkId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            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: totalAmount(gt)=20 return all records with totalAmount greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success. Fields marked optional may return `null` if not set.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryInvoiceResponse'
              example:
                Records:
                  - billEvents:
                      - description: Invoice created
                        eventTime: '2024-03-05T23:08:45Z'
                        refData: 00-802fa578504a7af6f3dd890a3802f7ef-61b4bedXXXX1234
                    createdAt: '2024-03-05T18:08:45Z'
                    Customer:
                      AdditionalData:
                        key1: value
                        key2: value
                        key3: value
                      BillingPhone: '1234567890'
                      customerId: 1323
                    customerId: 1323
                    discount: 0
                    dutyAmount: 0
                    externalPaypointID: seattletrade01-10
                    firstName: Amirah
                    freightAmount: 0
                    frequency: onetime
                    termsConditions: null
                    notes: null
                    invoiceAmount: 50
                    invoiceDate: '2025-03-05'
                    invoiceDueDate: '2025-03-05'
                    invoiceSentDate: '2025-03-05'
                    invoiceEndDate: '2025-03-05'
                    invoiceId: 3674
                    invoiceNumber: QA-1709680125
                    invoicePaidAmount: 0
                    invoiceStatus: 1
                    invoiceType: 0
                    items:
                      - itemCost: 50
                        itemDescription: service
                        itemProductName: Internet
                        itemQty: 1
                    lastName: Tan
                    ParentOrgName: Emerald Enterprises
                    ParentOrgId: 123
                    paylinkId: 3674-cf15b881-f276-4b69-bdc8-841b2d123XXXXXX
                    paymentTerms: NET30
                    PaypointDbaname: Emerald City Trading
                    PaypointEntryname: 47a30009s
                    paypointId: 10
                    PaypointLegalname: Emerald City LLC
                    shippingAddress1: 1234 Rainier Ave
                    shippingAddress2: Apt 567
                    shippingCity: Seattle
                    shippingCountry: US
                    shippingEmail: amirah.tan@example.com
                    shippingFromZip: ''
                    shippingPhone: ''
                    shippingState: WA
                    shippingZip: '98101'
                    tax: 0
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 77.22
                  totalNetAmount: 77.22
                  totalPages: 2
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Invoice/send/{idInvoice}:
    get:
      operationId: invoice_SendInvoice
      tags:
        - Invoice
      x-fern-sdk-group-name: invoice
      x-fern-sdk-method-name: SendInvoice
      x-fern-request-name: SendInvoiceRequest
      summary: Send invoice via email
      description: Sends an invoice from an entrypoint via email.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idInvoice
          in: path
          description: Invoice ID
          required: true
          schema:
            type: integer
          example: 23548884
        - name: attachfile
          in: query
          description: When `true`, attaches a PDF version of invoice to the email.
          required: false
          schema:
            type: boolean
            default: false
          example: true
        - name: mail2
          in: query
          description: Email address where the invoice will be sent to. If this parameter isn't included, Payabli uses the email address on file for the customer owner of the invoice.
          required: false
          schema:
            type: string
          example: tamara@example.com
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendInvoiceResponse'
              example:
                isSuccess: true
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/invoicePdf/{idInvoice}:
    get:
      operationId: invoice_GetInvoicePDF
      tags:
        - Invoice
      x-fern-sdk-group-name: invoice
      x-fern-sdk-method-name: GetInvoicePDF
      x-fern-request-name: GetInvoicePDFRequest
      summary: Export Invoice PDF
      description: Export a single invoice in PDF format.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idInvoice
          in: path
          description: Invoice ID
          required: true
          schema:
            type: integer
          example: 23548884
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentLink/{idInvoice}:
    post:
      operationId: paymentLink_AddPayLinkFromInvoice
      tags:
        - PaymentLink
      x-fern-sdk-group-name: paymentLink
      x-fern-sdk-method-name: AddPayLinkFromInvoice
      x-fern-request-name: PayLinkDataInvoice
      summary: Generate payment link from Invoice
      description: Generates a payment link for an invoice from the invoice ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idInvoice
          in: path
          description: Invoice ID
          required: true
          schema:
            type: integer
          example: 23548884
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
        - name: amountFixed
          in: query
          description: Indicates whether customer can modify the payment amount. A value of `true` means the amount isn't modifiable, a value `false` means the payor can modify the amount to pay.
          required: false
          schema:
            type: boolean
            default: true
        - name: mail2
          in: query
          description: List of recipient email addresses. When there is more than one, separate them by a semicolon (;).
          required: false
          schema:
            type: string
          example: jo@example.com; ceo@example.com
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentPageRequestBody'
            example:
              contactUs:
                emailLabel: Email
                enabled: true
                header: Contact Us
                order: 0
                paymentIcons: true
                phoneLabel: Phone
              invoices:
                enabled: true
                invoiceLink:
                  enabled: true
                  label: View Invoice
                  order: 0
                order: 0
                viewInvoiceDetails:
                  enabled: true
                  label: Invoice Details
                  order: 0
              logo:
                enabled: true
                order: 0
              messageBeforePaying:
                enabled: true
                label: Please review your payment details
                order: 0
              notes:
                enabled: true
                header: Additional Notes
                order: 0
                placeholder: Enter any additional notes here
                value: ''
              page:
                description: Complete your payment securely
                enabled: true
                header: Payment Page
                order: 0
              paymentButton:
                enabled: true
                label: Pay Now
                order: 0
              paymentMethods:
                allMethodsChecked: true
                enabled: true
                header: Payment Methods
                methods:
                  amex: true
                  applePay: true
                  discover: true
                  eCheck: true
                  mastercard: true
                  visa: true
                order: 0
                settings:
                  applePay:
                    buttonStyle: black
                    buttonType: pay
                    language: en-US
              payor:
                enabled: true
                fields:
                  - display: true
                    fixed: true
                    identifier: true
                    label: Full Name
                    name: fullName
                    order: 0
                    required: true
                    validation: alpha
                    value: ''
                    width: 0
                header: Payor Information
                order: 0
              review:
                enabled: true
                header: Review Payment
                order: 0
              settings:
                color: '#000000'
                customCssUrl: https://example.com/custom.css
                language: en
                pageLogo:
                  fContent: PHN2ZyB2aWV3Qm94PSIwIDAgODAwIDEwMDAiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CiAgPCEtLSBCYWNrZ3JvdW5kIC0tPgogIDxyZWN0IHdpZHRoPSI4MDAiIGhlaWdodD0iMTAwMCIgZmlsbD0id2hpdGUiLz4KICAKICA8IS0tIENvbXBhbnkgSGVhZGVyIC0tPgogIDx0ZXh0IHg9IjQwIiB5PSI2MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjI0IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0iIzJjM2U1MCI+R3J1enlhIEFkdmVudHVyZSBPdXRmaXR0ZXJzPC90ZXh0PgogIDxsaW5lIHgxPSI0MCIgeTE9IjgwIiB4Mj0iNzYwIiB5Mj0iODAiIHN0cm9rZT0iIzJjM2U1MCIgc3Ryb2tlLXdpZHRoPSIyIi8+CiAgCiAgPCEtLSBDb21wYW55IERldGFpbHMgLS0+CiAgPHRleHQgeD0iNDAiIHk9IjExMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4xMjMgTW91bnRhaW4gVmlldyBSb2FkPC90ZXh0PgogIDx0ZXh0IHg9IjQwIiB5PSIxMzAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+VGJpbGlzaSwgR2VvcmdpYSAwMTA1PC90ZXh0PgogIDx0ZXh0IHg9IjQwIiB5PSIxNTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+VGVsOiArOTk1IDMyIDEyMyA0NTY3PC90ZXh0PgogIDx0ZXh0IHg9IjQwIiB5PSIxNzAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+RW1haWw6IGluZm9AZ3J1enlhYWR2ZW50dXJlcy5jb208L3RleHQ+CgogIDwhLS0gSW52b2ljZSBUaXRsZSAtLT4KICA8dGV4dCB4PSI2MDAiIHk9IjExMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjI0IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0iIzJjM2U1MCI+SU5WT0lDRTwvdGV4dD4KICA8dGV4dCB4PSI2MDAiIHk9IjE0MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj5EYXRlOiAxMi8xMS8yMDI0PC90ZXh0PgogIDx0ZXh0IHg9IjYwMCIgeT0iMTYwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPkludm9pY2UgIzogR1JaLTIwMjQtMTEyMzwvdGV4dD4KCiAgPCEtLSBCaWxsIFRvIFNlY3Rpb24gLS0+CiAgPHRleHQgeD0iNDAiIHk9IjIyMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE2IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0iIzJjM2U1MCI+QklMTCBUTzo8L3RleHQ+CiAgPHJlY3QgeD0iNDAiIHk9IjIzNSIgd2lkdGg9IjMwMCIgaGVpZ2h0PSI4MCIgZmlsbD0iI2Y3ZjlmYSIvPgogIDx0ZXh0IHg9IjUwIiB5PSIyNjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+W0N1c3RvbWVyIE5hbWVdPC90ZXh0PgogIDx0ZXh0IHg9IjUwIiB5PSIyODAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+W0FkZHJlc3MgTGluZSAxXTwvdGV4dD4KICA8dGV4dCB4PSI1MCIgeT0iMzAwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPltDaXR5LCBDb3VudHJ5XTwvdGV4dD4KCiAgPCEtLSBUYWJsZSBIZWFkZXJzIC0tPgogIDxyZWN0IHg9IjQwIiB5PSIzNDAiIHdpZHRoPSI3MjAiIGhlaWdodD0iMzAiIGZpbGw9IiMyYzNlNTAiLz4KICA8dGV4dCB4PSI1MCIgeT0iMzYwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZvbnQtd2VpZ2h0PSJib2xkIiBmaWxsPSJ3aGl0ZSI+RGVzY3JpcHRpb248L3RleHQ+CiAgPHRleHQgeD0iNDUwIiB5PSIzNjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IndoaXRlIj5RdWFudGl0eTwvdGV4dD4KICA8dGV4dCB4PSI1NTAiIHk9IjM2MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0id2hpdGUiPlJhdGU8L3RleHQ+CiAgPHRleHQgeD0iNjgwIiB5PSIzNjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IndoaXRlIj5BbW91bnQ8L3RleHQ+CgogIDwhLS0gVGFibGUgUm93cyAtLT4KICA8cmVjdCB4PSI0MCIgeT0iMzcwIiB3aWR0aD0iNzIwIiBoZWlnaHQ9IjMwIiBmaWxsPSIjZjdmOWZhIi8+CiAgPHRleHQgeD0iNTAiIHk9IjM5MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj5Nb3VudGFpbiBDbGltYmluZyBFcXVpcG1lbnQgUmVudGFsPC90ZXh0PgogIDx0ZXh0IHg9IjQ1MCIgeT0iMzkwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPjE8L3RleHQ+CiAgPHRleHQgeD0iNTUwIiB5PSIzOTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+JDI1MC4wMDwvdGV4dD4KICA8dGV4dCB4PSI2ODAiIHk9IjM5MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4kMjUwLjAwPC90ZXh0PgoKICA8cmVjdCB4PSI0MCIgeT0iNDAwIiB3aWR0aD0iNzIwIiBoZWlnaHQ9IjMwIiBmaWxsPSJ3aGl0ZSIvPgogIDx0ZXh0IHg9IjUwIiB5PSI0MjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+R3VpZGVkIFRyZWsgUGFja2FnZSAtIDIgRGF5czwvdGV4dD4KICA8dGV4dCB4PSI0NTAiIHk9IjQyMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4xPC90ZXh0PgogIDx0ZXh0IHg9IjU1MCIgeT0iNDIwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPiQ0MDAuMDA8L3RleHQ+CiAgPHRleHQgeD0iNjgwIiB5PSI0MjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+JDQwMC4wMDwvdGV4dD4KCiAgPHJlY3QgeD0iNDAiIHk9IjQzMCIgd2lkdGg9IjcyMCIgaGVpZ2h0PSIzMCIgZmlsbD0iI2Y3ZjlmYSIvPgogIDx0ZXh0IHg9IjUwIiB5PSI0NTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+U2FmZXR5IEVxdWlwbWVudCBQYWNrYWdlPC90ZXh0PgogIDx0ZXh0IHg9IjQ1MCIgeT0iNDUwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPjE8L3RleHQ+CiAgPHRleHQgeD0iNTUwIiB5PSI0NTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+JDE1MC4wMDwvdGV4dD4KICA8dGV4dCB4PSI2ODAiIHk9IjQ1MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4kMTUwLjAwPC90ZXh0PgoKICA8IS0tIFRvdGFscyAtLT4KICA8bGluZSB4MT0iNDAiIHkxPSI0ODAiIHgyPSI3NjAiIHkyPSI0ODAiIHN0cm9rZT0iIzJjM2U1MCIgc3Ryb2tlLXdpZHRoPSIxIi8+CiAgPHRleHQgeD0iNTUwIiB5PSI1MTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IiMzNDQ5NWUiPlN1YnRvdGFsOjwvdGV4dD4KICA8dGV4dCB4PSI2ODAiIHk9IjUxMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4kODAwLjAwPC90ZXh0PgogIDx0ZXh0IHg9IjU1MCIgeT0iNTM1IiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZvbnQtd2VpZ2h0PSJib2xkIiBmaWxsPSIjMzQ0OTVlIj5UYXggKDE4JSk6PC90ZXh0PgogIDx0ZXh0IHg9IjY4MCIgeT0iNTM1IiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPiQxNDQuMDA8L3RleHQ+CiAgPHRleHQgeD0iNTUwIiB5PSI1NzAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNiIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IiMyYzNlNTAiPlRvdGFsOjwvdGV4dD4KICA8dGV4dCB4PSI2ODAiIHk9IjU3MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE2IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0iIzJjM2U1MCI+JDk0NC4wMDwvdGV4dD4KCiAgPCEtLSBQYXltZW50IFRlcm1zIC0tPgogIDx0ZXh0IHg9IjQwIiB5PSI2NDAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNiIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IiMyYzNlNTAiPlBheW1lbnQgVGVybXM8L3RleHQ+CiAgPHRleHQgeD0iNDAiIHk9IjY3MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj5QYXltZW50IGlzIGR1ZSB3aXRoaW4gMzAgZGF5czwvdGV4dD4KICA8dGV4dCB4PSI0MCIgeT0iNjkwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPlBsZWFzZSBpbmNsdWRlIGludm9pY2UgbnVtYmVyIG9uIHBheW1lbnQ8L3RleHQ+CgogIDwhLS0gQmFuayBEZXRhaWxzIC0tPgogIDx0ZXh0IHg9IjQwIiB5PSI3MzAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNiIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IiMyYzNlNTAiPkJhbmsgRGV0YWlsczwvdGV4dD4KICA8dGV4dCB4PSI0MCIgeT0iNzYwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPkJhbms6IEJhbmsgb2YgR2VvcmdpYTwvdGV4dD4KICA8dGV4dCB4PSI0MCIgeT0iNzgwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPklCQU46IEdFMTIzNDU2Nzg5MDEyMzQ1Njc4PC90ZXh0PgogIDx0ZXh0IHg9IjQwIiB5PSI4MDAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+U1dJRlQ6IEJBR0FHRTIyPC90ZXh0PgoKICA8IS0tIEZvb3RlciAtLT4KICA8bGluZSB4MT0iNDAiIHkxPSI5MDAiIHgyPSI3NjAiIHkyPSI5MDAiIHN0cm9rZT0iIzJjM2U1MCIgc3Ryb2tlLXdpZHRoPSIxIi8+CiAgPHRleHQgeD0iNDAiIHk9IjkzMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjEyIiBmaWxsPSIjN2Y4YzhkIj5UaGFuayB5b3UgZm9yIGNob29zaW5nIEdydXp5YSBBZHZlbnR1cmUgT3V0Zml0dGVyczwvdGV4dD4KICA8dGV4dCB4PSI0MCIgeT0iOTUwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTIiIGZpbGw9IiM3ZjhjOGQiPnd3dy5ncnV6eWFhZHZlbnR1cmVzLmNvbTwvdGV4dD4KPC9zdmc+Cg==
                  filename: logo.jpg
                  ftype: jpg
                  furl: ''
                redirectAfterApprove: true
                redirectAfterApproveUrl: https://example.com/success
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
              example:
                isSuccess: true
                responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentLink/bill/{billId}:
    post:
      operationId: paymentLink_AddPayLinkFromBill
      tags:
        - PaymentLink
      x-fern-sdk-group-name: paymentLink
      x-fern-sdk-method-name: AddPayLinkFromBill
      x-fern-request-name: PayLinkDataBill
      summary: Generate payment link from Bill
      description: Generates a payment link for a bill from the bill ID. The vendor receives a secure page where they can select their preferred payment method (ACH, virtual card, or check) and complete the payment.
      security:
        - APIKeyAuth: []
      parameters:
        - name: billId
          in: path
          description: The Payabli ID for the bill.
          required: true
          schema:
            type: integer
          examples:
            GeneratePaymentLink:
              value: 23548884
            GeneratePaymentLinkNoSend:
              value: 23548884
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
        - name: amountFixed
          in: query
          description: Indicates whether customer can modify the payment amount. A value of `true` means the amount isn't modifiable, a value `false` means the payor can modify the amount to pay.
          required: false
          schema:
            type: boolean
            default: true
        - name: mail2
          in: query
          description: List of recipient email addresses. When there is more than one, separate them by a semicolon (;).
          required: false
          schema:
            type: string
          examples:
            GeneratePaymentLink:
              value: jo@example.com; ceo@example.com
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentPageRequestBodyOut'
            examples:
              GeneratePaymentLink:
                value:
                  contactUs:
                    emailLabel: Email
                    enabled: true
                    header: Contact Us
                    order: 0
                    paymentIcons: true
                    phoneLabel: Phone
                  logo:
                    enabled: true
                    order: 0
                  messageBeforePaying:
                    enabled: true
                    label: Please review your payment details
                    order: 0
                  notes:
                    enabled: true
                    header: Additional Notes
                    order: 0
                    placeholder: Enter any additional notes here
                    value: ''
                  page:
                    description: Get paid securely
                    enabled: true
                    header: Payment Page
                    order: 0
                  paymentButton:
                    enabled: true
                    label: Pay Now
                    order: 0
                  paymentMethods:
                    allMethodsChecked: true
                    allowMultipleMethods: true
                    defaultMethod: vcard
                    enabled: true
                    header: Payment Methods
                    methods:
                      ach: true
                      check: true
                      vcard: true
                    order: 0
                    showPreviewVirtualCard: true
                  review:
                    enabled: true
                    header: Review Payment
                    order: 0
                  settings:
                    color: '#000000'
                    language: en
              GeneratePaymentLinkNoSend:
                value:
                  contactUs:
                    emailLabel: Email
                    enabled: true
                    header: Contact Us
                    order: 0
                    paymentIcons: true
                    phoneLabel: Phone
                  logo:
                    enabled: true
                    order: 0
                  messageBeforePaying:
                    enabled: true
                    label: Please review your payment details
                    order: 0
                  notes:
                    enabled: true
                    header: Additional Notes
                    order: 0
                    placeholder: Enter any additional notes here
                    value: ''
                  page:
                    description: Get paid securely
                    enabled: true
                    header: Payment Page
                    order: 0
                  paymentButton:
                    enabled: true
                    label: Pay Now
                    order: 0
                  paymentMethods:
                    allMethodsChecked: true
                    allowMultipleMethods: true
                    defaultMethod: vcard
                    enabled: true
                    header: Payment Methods
                    methods:
                      ach: true
                      check: true
                      vcard: true
                    order: 0
                    showPreviewVirtualCard: true
                  review:
                    enabled: true
                    header: Review Payment
                    order: 0
                  settings:
                    color: '#000000'
                    language: en
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
              examples:
                GeneratePaymentLink:
                  value:
                    isSuccess: true
                    responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                    responseText: Success
                GeneratePaymentLinkNoSend:
                  value:
                    isSuccess: true
                    responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                    responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentLink/{payLinkId}:
    delete:
      operationId: paymentLink_deletePayLinkFromId
      tags:
        - PaymentLink
      x-fern-sdk-group-name: paymentLink
      x-fern-sdk-method-name: deletePayLinkFromId
      x-fern-request-name: deletePayLinkFromIdRequest
      summary: Delete payment link
      description: Deletes a payment link by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: payLinkId
          in: path
          description: ID for the payment link.
          required: true
          schema:
            type: string
          example: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
              example:
                isSuccess: true
                responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentLink/load/{paylinkId}:
    get:
      operationId: paymentLink_getPayLinkFromId
      tags:
        - PaymentLink
      x-fern-sdk-group-name: paymentLink
      x-fern-sdk-method-name: getPayLinkFromId
      x-fern-request-name: getPayLinkFromIdRequest
      summary: Get payment link from ID
      description: Retrieves a payment link by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: paylinkId
          in: path
          description: ID for payment link
          required: true
          schema:
            type: string
          example: paylinkId
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPayLinkFromIdResponse'
              example:
                isSuccess: true
                responseData:
                  AdditionalData:
                    key1:
                      key: value
                    key2:
                      key: value
                    key3:
                      key: value
                  Credentials:
                    - {}
                  LastAccess: '2022-06-30T15:01:00Z'
                  PageContent:
                    amount:
                      enabled: true
                    autopay:
                      enabled: true
                    contactUs:
                      enabled: true
                    entry: entry
                    invoices:
                      enabled: true
                    logo:
                      enabled: true
                    messageBeforePaying:
                      enabled: true
                    name: name
                    notes:
                      enabled: true
                    page:
                      enabled: true
                    paymentButton:
                      enabled: true
                    paymentMethods:
                      enabled: true
                    payor:
                      enabled: true
                    review:
                      enabled: true
                    subdomain: mypage-1
                  pageIdentifier: 'null'
                  PageSettings:
                    color: color
                    customCssUrl: customCssUrl
                    language: language
                    redirectAfterApprove: true
                    redirectAfterApproveUrl: redirectAfterApproveUrl
                  published: 1
                  ReceiptContent:
                    amount:
                      enabled: true
                    contactUs:
                      enabled: true
                    details:
                      enabled: true
                    logo:
                      enabled: true
                    messageBeforeButton:
                      enabled: true
                    page:
                      enabled: true
                    paymentButton:
                      enabled: true
                    paymentInformation:
                      enabled: true
                    settings:
                      enabled: true
                  Subdomain: mypage-1
                  totalAmount: 1.1
                  validationCode: validationCode
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentLink/push/{payLinkId}:
    post:
      operationId: paymentLink_pushPayLinkFromId
      tags:
        - PaymentLink
      x-fern-sdk-group-name: paymentLink
      x-fern-sdk-method-name: pushPayLinkFromId
      x-fern-request-name: pushPayLinkFromIdRequest
      summary: Send payment link
      description: Send a payment link to the specified email addresses or phone numbers.
      security:
        - APIKeyAuth: []
      parameters:
        - name: payLinkId
          in: path
          description: ID for the payment link.
          required: true
          schema:
            type: string
          examples:
            SendSMS:
              value: payLinkId
            SendEmail:
              value: payLinkId
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PushPayLinkRequest'
            examples:
              SendSMS:
                value:
                  channel: sms
              SendEmail:
                value:
                  additionalEmails:
                    - admin@example.com
                    - accounting@example.com
                  attachFile: true
                  channel: email
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
              examples:
                SendSMS:
                  value:
                    isSuccess: true
                    responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                    responseText: Success
                SendEmail:
                  value:
                    isSuccess: true
                    responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                    responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentLink/refresh/{payLinkId}:
    get:
      operationId: paymentLink_refreshPayLinkFromId
      tags:
        - PaymentLink
      x-fern-sdk-group-name: paymentLink
      x-fern-sdk-method-name: refreshPayLinkFromId
      x-fern-request-name: refreshPayLinkFromIdRequest
      summary: Refresh payment link content
      description: Refresh a payment link's content after an update.
      security:
        - APIKeyAuth: []
      parameters:
        - name: payLinkId
          in: path
          description: ID for the payment link.
          required: true
          schema:
            type: string
          example: payLinkId
        - name: amountFixed
          in: query
          description: Indicates whether customer can modify the payment amount. A value of `true` means the amount isn't modifiable, a value `false` means the payor can modify the amount to pay.
          required: false
          schema:
            type: boolean
            default: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
              example:
                isSuccess: true
                responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentLink/send/{payLinkId}:
    get:
      operationId: paymentLink_sendPayLinkFromId
      tags:
        - PaymentLink
      x-fern-sdk-group-name: paymentLink
      x-fern-sdk-method-name: sendPayLinkFromId
      x-fern-request-name: sendPayLinkFromIdRequest
      summary: Send payment link email
      description: Sends a payment link to the specified email addresses.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: payLinkId
          in: path
          description: ID for the payment link.
          required: true
          schema:
            type: string
          example: payLinkId
        - name: attachfile
          in: query
          description: When `true`, attaches a PDF version of invoice to the email.
          required: false
          schema:
            type: boolean
            default: false
        - name: mail2
          in: query
          description: List of recipient email addresses. When there is more than one, separate them by a semicolon (;).
          required: false
          schema:
            type: string
          example: jo@example.com; ceo@example.com
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
              example:
                isSuccess: true
                responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentLink/update/{payLinkId}:
    put:
      operationId: paymentLink_updatePayLinkFromId
      tags:
        - PaymentLink
      x-fern-sdk-group-name: paymentLink
      x-fern-sdk-method-name: updatePayLinkFromId
      x-fern-request-name: PayLinkUpdateData
      summary: Update payment link
      description: Updates a payment link's details.
      security:
        - APIKeyAuth: []
      parameters:
        - name: payLinkId
          in: path
          description: ID for the payment link.
          required: true
          schema:
            type: string
          example: 332-c277b704-1301
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayLinkUpdateData'
            example:
              notes:
                enabled: true
                header: Additional Notes
                order: 0
                placeholder: Enter any additional notes here
                value: ''
              paymentButton:
                enabled: true
                label: Pay Now
                order: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
              example:
                isSuccess: true
                responseData: 332-c277b704-1301
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentLink/bill/lotNumber/{lotNumber}:
    post:
      operationId: paymentLink_AddPayLinkFromBillLotNumber
      tags:
        - PaymentLink
      x-fern-sdk-group-name: paymentLink
      x-fern-sdk-method-name: AddPayLinkFromBillLotNumber
      x-fern-request-name: PayLinkDataOut
      summary: Generate payment link from lot number
      description: Generates a vendor payment link for a specific bill lot number. This allows you to pay all bills with the same lot number for a vendor with a single payment link.
      x-fern-availability: in-development
      security:
        - APIKeyAuth: []
      parameters:
        - name: lotNumber
          in: path
          description: Lot number of the bills to pay. All bills with this lot number will be included.
          required: true
          schema:
            type: string
          example: LOT-2024-001
        - name: entryPoint
          in: query
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: billing
        - name: vendorNumber
          in: query
          description: The vendor number for the vendor being paid with this payment link.
          required: true
          schema:
            type: string
          example: VENDOR-123
        - name: mail2
          in: query
          description: List of recipient email addresses. When there is more than one, separate them by a semicolon (;).
          required: false
          schema:
            type: string
          example: customer@example.com; billing@example.com
        - name: amountFixed
          in: query
          description: Indicates whether customer can modify the payment amount. A value of `true` means the amount isn't modifiable, a value `false` means the payor can modify the amount to pay.
          required: false
          schema:
            type: string
            default: 'true'
          example: 'true'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentPageRequestBodyOut'
            example:
              contactUs:
                emailLabel: Email
                enabled: true
                header: Contact Us
                order: 0
                paymentIcons: true
                phoneLabel: Phone
              logo:
                enabled: true
                order: 0
              messageBeforePaying:
                enabled: true
                label: Please review your payment details
                order: 0
              notes:
                enabled: true
                header: Additional Notes
                order: 0
                placeholder: Enter any additional notes here
                value: ''
              page:
                description: Get paid securely
                enabled: true
                header: Payment Page
                order: 0
              paymentButton:
                enabled: true
                label: Pay Now
                order: 0
              paymentMethods:
                allMethodsChecked: true
                allowMultipleMethods: true
                defaultMethod: vcard
                enabled: true
                header: Payment Methods
                methods:
                  ach: true
                  check: true
                  vcard: true
                order: 0
                showPreviewVirtualCard: true
              review:
                enabled: true
                header: Review Payment
                order: 0
              settings:
                color: '#000000'
                language: en
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
              example:
                isSuccess: true
                responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                responseText: Success
  /PaymentLink/out/{paylinkId}:
    patch:
      operationId: paymentLink_patchOutPaymentLink
      tags:
        - PaymentLink
      x-fern-sdk-group-name: paymentLink
      x-fern-sdk-method-name: patchOutPaymentLink
      x-fern-request-name: PatchOutPaymentLinkRequest
      summary: Update Pay Out payment link
      description: Partially updates a Pay Out payment link's content, expiration date, and/or status. Use this to modify the payment page configuration, extend or change the expiration, or cancel a link. Updating the expiration date of an expired link reactivates it to Active status.
      security:
        - APIKeyAuth: []
      parameters:
        - name: paylinkId
          in: path
          description: ID for the payment link.
          required: true
          schema:
            type: string
          examples:
            ReactivateExpiredLink:
              value: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
            CancelPaymentLink:
              value: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
            UpdatePageContent:
              value: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchOutPaymentLinkRequest'
            examples:
              ReactivateExpiredLink:
                value:
                  expirationDate: '2026-06-01T00:00:00Z'
                  status: Active
              CancelPaymentLink:
                value:
                  status: Canceled
              UpdatePageContent:
                value:
                  billPageData:
                    page:
                      description: You have a payment waiting
                      enabled: true
                      header: Vendor Payment
                      order: 0
                    paymentButton:
                      enabled: true
                      label: Select Payment Method
                      order: 0
                    paymentMethods:
                      allMethodsChecked: true
                      allowMultipleMethods: true
                      defaultMethod: ach
                      enabled: true
                      header: Payment Methods
                      methods:
                        ach: true
                        check: true
                        vcard: true
                      order: 0
                      showPreviewVirtualCard: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
              examples:
                ReactivateExpiredLink:
                  value:
                    isSuccess: true
                    responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                    responseText: Success
                CancelPaymentLink:
                  value:
                    isSuccess: true
                    responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                    responseText: Success
                UpdatePageContent:
                  value:
                    isSuccess: true
                    responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                    responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentLink/updateOut/{paylinkId}:
    patch:
      operationId: paymentLink_updatePayLinkOutFromId
      tags:
        - PaymentLink
      x-fern-sdk-group-name: paymentLink
      x-fern-sdk-method-name: updatePayLinkOutFromId
      x-fern-request-name: updatePayLinkOutFromIdRequest
      summary: Update Pay Out payment link content
      description: Updates the payment page content for a Pay Out payment link. Use this to change the branding, messaging, payment methods offered, or other page configuration.
      security:
        - APIKeyAuth: []
      parameters:
        - name: paylinkId
          in: path
          description: ID for the payment link.
          required: true
          schema:
            type: string
          examples:
            UpdatePayLinkOutFull:
              value: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
            ChangeOfferedMethods:
              value: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentPageRequestBodyOut'
            examples:
              UpdatePayLinkOutFull:
                value:
                  contactUs:
                    emailLabel: Email
                    enabled: true
                    header: Contact Us
                    order: 0
                    paymentIcons: true
                    phoneLabel: Phone
                  logo:
                    enabled: true
                    order: 0
                  messageBeforePaying:
                    enabled: true
                    label: Please review your payment details
                    order: 0
                  notes:
                    enabled: true
                    header: Additional Notes
                    order: 0
                    placeholder: Enter any additional notes here
                    value: ''
                  page:
                    description: Get paid securely
                    enabled: true
                    header: Payment Page
                    order: 0
                  paymentButton:
                    enabled: true
                    label: Pay Now
                    order: 0
                  paymentMethods:
                    allMethodsChecked: true
                    allowMultipleMethods: true
                    defaultMethod: vcard
                    enabled: true
                    header: Payment Methods
                    methods:
                      ach: true
                      check: true
                      vcard: true
                    order: 0
                    showPreviewVirtualCard: true
                  review:
                    enabled: true
                    header: Review Payment
                    order: 0
                  settings:
                    color: '#000000'
                    language: en
              ChangeOfferedMethods:
                value:
                  paymentMethods:
                    allMethodsChecked: false
                    allowMultipleMethods: true
                    defaultMethod: vcard
                    enabled: true
                    header: Payment Methods
                    methods:
                      ach: true
                      check: false
                      vcard: true
                    order: 0
                    showPreviewVirtualCard: true
                  paymentButton:
                    enabled: true
                    label: Choose Payment Method
                    order: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponsePaymentLinks'
              examples:
                UpdatePayLinkOutFull:
                  value:
                    isSuccess: true
                    responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                    responseText: Success
                ChangeOfferedMethods:
                  value:
                    isSuccess: true
                    responseData: 2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234
                    responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /TokenStorage/add:
    post:
      operationId: tokenStorage_AddMethod
      tags:
        - TokenStorage
      x-fern-sdk-group-name: tokenStorage
      x-fern-sdk-method-name: AddMethod
      x-fern-request-name: AddMethodRequest
      summary: Save a payment method (tokenize)
      description: Saves a payment method for reuse. This call exchanges sensitive payment information for a token that can be used to process future transactions. The `ReferenceId` value in the response is the `storedMethodId` to use with transactions.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
        - name: achValidation
          in: query
          required: false
          description: When `true`, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.
          schema:
            $ref: '#/components/schemas/AchValidation'
          examples:
            TokenizeACH:
              value: true
            TokenizeVendorACH:
              value: true
        - name: createAnonymous
          in: query
          required: false
          description: When `true`, creates a saved method with no associated customer information. The token will be associated with customer information the first time it's used to make a payment. Defaults to `false`.
          schema:
            $ref: '#/components/schemas/CreateAnonymous'
          examples:
            TokenizeCardAnonymous:
              value: true
        - name: forceCustomerCreation
          in: query
          required: false
          description: When `true`, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to `false`.
          schema:
            $ref: '#/components/schemas/ForceCustomerCreation'
        - name: temporary
          in: query
          required: false
          description: Creates a temporary, one-time-use token for the payment method that expires in 12 hours. Defaults to `false`.
          schema:
            $ref: '#/components/schemas/Temporary'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestTokenStorage'
            examples:
              TokenizeCard:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  fallbackAuth: true
                  fallbackAuthAmount: 100
                  methodDescription: Primary Visa card
                  paymentMethod:
                    cardcvv: '123'
                    cardexp: 02/25
                    cardHolder: John Doe
                    cardnumber: '4111111111111111'
                    cardzip: '12345'
                    method: card
                  source: api
              TokenizeCardAnonymous:
                value:
                  entryPoint: f743aed24a
                  fallbackAuth: true
                  paymentMethod:
                    cardcvv: '123'
                    cardexp: 02/25
                    cardHolder: John Doe
                    cardnumber: '4111111111111111'
                    cardzip: '12345'
                    method: card
              TemptoPermanent:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  fallbackAuth: true
                  methodDescription: Main card
                  paymentMethod:
                    method: card
                    tokenId: c9700e93-b2ed-4b75-b1e4-ca4fb04fbe45-224
              TokenizeACH:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  paymentMethod:
                    achAccount: '1111111111111'
                    achAccountType: Checking
                    achCode: WEB
                    achHolder: John Doe
                    achHolderType: personal
                    achRouting: '123456780'
                    method: ach
              TokenizeVendorACH:
                value:
                  entryPoint: f743aed24a
                  paymentMethod:
                    achAccount: '1111111111111'
                    achAccountType: Checking
                    achCode: WEB
                    achHolder: John Doe
                    achHolderType: personal
                    achRouting: '123456780'
                    method: ach
                  vendorData:
                    vendorId: 7890
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddMethodResponse'
              examples:
                TokenizeCard:
                  value:
                    isSuccess: true
                    responseData:
                      customerId: 4400
                      methodReferenceId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      referenceId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      resultCode: 1
                      resultText: Approved
                    responseText: Success
                TokenizeCardAnonymous:
                  value:
                    isSuccess: true
                    responseData:
                      customerId: null
                      methodReferenceId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      referenceId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      resultCode: 1
                      resultText: Approved
                    responseText: Success
                TemptoPermanent:
                  value:
                    isSuccess: true
                    responseData:
                      customerId: 4440
                      methodReferenceId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      referenceId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      resultCode: 1
                      resultText: Approved
                    responseText: Success
                TokenizeACH:
                  value:
                    isSuccess: true
                    responseData:
                      customerId: 4440
                      methodReferenceId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      referenceId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      resultCode: 1
                      resultText: Approved
                    responseText: Success
                TokenizeVendorACH:
                  value:
                    isSuccess: true
                    responseData:
                      customerId: 4440
                      methodReferenceId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      referenceId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                      resultCode: 1
                      resultText: Approved
                    responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /TokenStorage/{methodId}:
    get:
      operationId: tokenStorage_GetMethod
      tags:
        - TokenStorage
      x-fern-sdk-group-name: tokenStorage
      x-fern-sdk-method-name: GetMethod
      x-fern-request-name: GetMethodRequest
      summary: Get payment method
      description: Retrieves details for a saved payment method.
      security:
        - APIKeyAuth: []
      parameters:
        - name: methodId
          in: path
          description: The saved payment method ID.
          required: true
          schema:
            type: string
          examples:
            GetCardMethod:
              value: 32-8877drt00045632-678
            GetACHMethod:
              value: 32-8877drt00045632-678
            GetVendorACHMethod:
              value: 749e236c-59a3-49c7-ab47-73e06f9e94aa-199689
        - name: cardExpirationFormat
          in: query
          description: |-
            Format for card expiration dates in the response.

            Accepted values:

            - 0: default, no formatting. Expiration dates are returned in the format they're saved in.

            - 1: MMYY

            - 2: MM/YY
          required: false
          schema:
            type: integer
            default: 0
          examples:
            GetCardMethod:
              value: 1
            GetACHMethod:
              value: 1
            GetVendorACHMethod:
              value: 1
        - name: includeTemporary
          in: query
          description: When `true`, the request will include temporary tokens in the search and return details for a matching temporary token. The default behavior searches only for permanent tokens.
          required: false
          schema:
            type: boolean
            default: false
          examples:
            GetCardMethod:
              value: false
            GetACHMethod:
              value: false
            GetVendorACHMethod:
              value: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMethodResponse'
              examples:
                GetCardMethod:
                  value:
                    isSuccess: true
                    responseData:
                      aba: ''
                      achHolderType: personal
                      achSecCode: achSecCode
                      bin: '401288'
                      binData:
                        binMatchedLength: '6'
                        binCardBrand: Visa
                        binCardType: Credit
                        binCardCategory: PLATINUM
                        binCardIssuer: Bank of Example
                        binCardIssuerCountry: United States
                        binCardIssuerCountryCodeA2: US
                        binCardIssuerCountryNumber: '840'
                        binCardIsRegulated: 'false'
                        binCardUseCategory: Consumer
                        binCardIssuerCountryCodeA3: USA
                      customers:
                        - additionalData:
                            key1:
                              key: value
                            key2:
                              key: value
                            key3:
                              key: value
                          balance: 250
                          billingPhone: '1234567890'
                          company: Bluesky Tech Inc
                          created: '2023-06-01T14:30:00Z'
                          customerId: 1456
                          customerNumber: CS789
                          customerStatus: 1
                          customerUsername: Marcus
                          identifierFields:
                            - firstname
                            - email
                          lastUpdated: '2024-12-15T09:45:32Z'
                          mfa: true
                          mfaMode: 1
                          parentOrgId: 5
                          parentOrgName: TechCorp
                          paypointDbaname: Bluesky Tech
                          paypointEntryname: 45782932fcc
                          paypointLegalname: Bluesky Technologies LLC
                          shippingAddress1: Suite 500
                          shippingCity: San Francisco
                          shippingCountry: US
                          shippingState: CA
                          shippingZip: '94105'
                          timeZone: -8
                      descriptor: visa
                      expDate: 926
                      holderName: Marcus Chen
                      idPmethod: 81f7fde1-dd8b-4892-b2e1-cd60dd91f6b4-XXXC
                      lastUpdated: '2025-01-15T16:30:22Z'
                      maskedAccount: 4XXXXXXX2345
                      method: card
                      methodType: Single Merchant
                      postalCode: '94105'
                    responseText: Success
                GetACHMethod:
                  value:
                    isSuccess: true
                    responseData:
                      aba: '021000021'
                      achHolderType: personal
                      achSecCode: PPD
                      bin: ''
                      customers:
                        - additionalData:
                            key1:
                              key: value
                            key2:
                              key: value
                            key3:
                              key: value
                          balance: 250
                          billingPhone: '1234567890'
                          company: Bluesky Tech Inc
                          created: '2023-06-01T14:30:00Z'
                          customerId: 1456
                          customerNumber: CS789
                          customerStatus: 1
                          customerUsername: Marcus
                          identifierFields:
                            - firstname
                            - email
                          lastUpdated: '2024-12-15T09:45:32Z'
                          mfa: true
                          mfaMode: 1
                          parentOrgId: 5
                          parentOrgName: TechCorp
                          paypointDbaname: Bluesky Tech
                          paypointEntryname: 45782932fcc
                          paypointLegalname: Bluesky Technologies LLC
                          shippingAddress1: Suite 500
                          shippingCity: San Francisco
                          shippingCountry: US
                          shippingState: CA
                          shippingZip: '94105'
                          snIdentifier: 'null'
                          snProvider: google
                          timeZone: -8
                      descriptor: Checking
                      expDate: ''
                      holderName: Marcus Chen
                      idPmethod: 81f7fde1-dd8b-4892-b2e1-cd60dd91f6b4-XXXX
                      lastUpdated: '2025-01-15T16:30:22Z'
                      maskedAccount: 8XXXXXX8654
                      method: ach
                      methodType: Single Merchant
                      postalCode: ''
                    responseText: Success
                GetVendorACHMethod:
                  value:
                    isSuccess: true
                    responseData:
                      aba: '122105278'
                      achHolderType: business
                      achSecCode: PPD
                      bin: ''
                      cardUpdatedOn: null
                      customers: []
                      descriptor: checking
                      expDate: ''
                      holderName: John Doe
                      idPmethod: 749e236c-59a3-49c7-ab47-73e06f9e94aa-123xxx
                      isValidatedACH: false
                      lastUpdated: '2026-01-02T19:11:27.634704'
                      maskedAccount: 0XXXXXX0022
                      method: ach
                      methodType: Multiple Universal
                      postalCode: ''
                      vendors:
                        - vendorNumber: V-3037-2
                          name1: Connie's Concrete
                          name2: ''
                          ein: XXXXX4789
                          phone: (123) 456-7890
                          email: conniesconcrete@payabli.com
                          remitEmail: null
                          address1: Suite 500
                          address2: ''
                          city: San Francisco
                          state: CA
                          zip: '94021'
                          country: US
                          mcc: ''
                          locationCode: WEST
                          contacts:
                            - contactName: John Doe
                              contactEmail: johndoe@payabli.com
                              contactTitle: Finance Manager
                              contactPhone: '5555551234'
                          billingData: null
                          paymentMethod: ach
                          vendorStatus: 1
                          vendorId: 7890
                          enrollmentStatus: null
                          summary: null
                          paypointLegalname: Gruzya Adventure Outfitters LLC
                          paypointId: '123'
                          paypointDbaname: Gruzya Adventure Outfitters LLC
                          paypointEntryname: 47ac12de2
                          parentOrgName: Payabli
                          parentOrgId: 3
                          createdDate: '2025-09-17T00:13:40.174402'
                          lastUpdated: '2025-09-18T15:40:55.181681'
                          remitAddress1: Suite 500
                          remitAddress2: ''
                          remitCity: San Francisco
                          remitState: CA
                          remitZip: '94021'
                          remitCountry: US
                          payeeName1: null
                          payeeName2: null
                          customField1: null
                          customField2: null
                          customerVendorAccount: null
                          internalReferenceId: 30986
                          additionalData: null
                          externalPaypointID: '3037'
                          storedMethods: null
                    responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    delete:
      operationId: tokenStorage_RemoveMethod
      tags:
        - TokenStorage
      x-fern-sdk-group-name: tokenStorage
      x-fern-sdk-method-name: RemoveMethod
      x-fern-request-name: RemoveMethodRequest
      summary: Remove a payment method
      description: Deletes a saved payment method.
      security:
        - APIKeyAuth: []
      parameters:
        - name: methodId
          in: path
          description: The saved payment method ID.
          required: true
          schema:
            type: string
          example: 32-8877drt00045632-678
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponsePaymethodDelete'
              example:
                isSuccess: true
                responseData:
                  referenceId: 32-8877drt65345632-678
                  resultCode: 1
                  resultText: Removed
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: tokenStorage_UpdateMethod
      tags:
        - TokenStorage
      x-fern-sdk-group-name: tokenStorage
      x-fern-sdk-method-name: UpdateMethod
      x-fern-request-name: UpdateMethodRequest
      summary: Update a payment method
      description: Updates a saved payment method.
      security:
        - APIKeyAuth: []
      parameters:
        - name: methodId
          in: path
          description: The saved payment method ID.
          required: true
          schema:
            type: string
          examples:
            UpdateCardMethod:
              value: 32-8877drt00045632-678
            UpdateACHMethod:
              value: 32-8877drt00045632-678
            UpdateACHMethodVendor:
              value: 32-8877drt00045632-678
        - name: achValidation
          in: query
          required: false
          description: When `true`, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.
          schema:
            $ref: '#/components/schemas/AchValidation'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestTokenStorage'
            examples:
              UpdateCardMethod:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  fallbackAuth: true
                  paymentMethod:
                    cardcvv: '123'
                    cardexp: 02/25
                    cardHolder: John Doe
                    cardnumber: '4111111111111111'
                    cardzip: '12345'
                    method: card
              UpdateACHMethod:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  paymentMethod:
                    achAccount: '1111111111111'
                    achAccountType: Checking
                    achCode: WEB
                    achHolder: John Doe
                    achHolderType: personal
                    achRouting: '123456780'
                    method: ach
              UpdateACHMethodVendor:
                value:
                  customerData:
                    customerId: 4440
                  entryPoint: f743aed24a
                  paymentMethod:
                    achAccount: '1111111111111'
                    achAccountType: Checking
                    achCode: WEB
                    achHolder: John Doe
                    achHolderType: personal
                    achRouting: '123456780'
                    method: ach
                  vendorData:
                    vendorId: 7890
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponsePaymethodDelete'
              examples:
                UpdateCardMethod:
                  value:
                    isSuccess: true
                    responseData:
                      referenceId: 1b502b79-e319-4159-8c29-a9f8d9f105c8-1323
                      resultCode: 1
                      resultText: Updated
                    responseText: Success
                UpdateACHMethod:
                  value:
                    isSuccess: true
                    responseData:
                      referenceId: 1b502b79-e319-4159-8c29-a9f8d9f105c8-1323
                      resultCode: 1
                      resultText: Updated
                    responseText: Success
                UpdateACHMethodVendor:
                  value:
                    isSuccess: true
                    responseData:
                      referenceId: 1b502b79-e319-4159-8c29-a9f8d9f105c8-1323
                      resultCode: 1
                      resultText: Updated
                    responseText: Success
  /Paypoint/basic/{entry}:
    get:
      operationId: paypoint_getBasicEntry
      tags:
        - Paypoint
      x-fern-sdk-group-name: paypoint
      x-fern-sdk-method-name: getBasicEntry
      x-fern-request-name: getBasicEntryRequest
      summary: Get basic paypoint details
      description: Gets the basic details for a paypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBasicEntryResponse'
              example:
                isSuccess: true
                responseCode: 1
                responseData:
                  EntryName: abc123def
                  EntryPages:
                    - AdditionalData:
                        key1:
                          key: value
                        key2:
                          key: value
                        key3:
                          key: value
                  IdEntry: 11111
                  Paypoint:
                    Address1: 123 Ocean Drive
                    Address2: Suite 400
                    BankData:
                      - bankAccountFunction: 0
                        bankAccountHolderName: Gruzya Adventure Outfitters LLC
                        nickname: Business Checking 1234
                    BoardingId: 340
                    City: Bristol
                    Contacts:
                      - {}
                    Country: US
                    Credentials:
                      - {}
                    DbaName: Sunshine Gutters
                    externalPaypointID: ''
                    Fax: '5555555555'
                    IdPaypoint: 1000000
                    LegalName: Sunshine Services, LLC
                    ParentOrg:
                      orgName: Pilgrim Planner
                      orgStatus: 1
                      orgType: 0
                    PaypointStatus: 1
                    Phone: '5555555555'
                    State: GA
                    summary:
                      amountSubs: 0
                      amountTx: 0
                      countSubs: 0
                      countTx: 0
                      customers: 1
                    TimeZone: -5
                    WebsiteAddress: www.example.com
                    Zip: '31113'
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Paypoint/basicById/{IdPaypoint}:
    get:
      operationId: paypoint_getBasicEntryById
      tags:
        - Paypoint
      x-fern-sdk-group-name: paypoint
      x-fern-sdk-method-name: getBasicEntryById
      x-fern-request-name: getBasicEntryByIdRequest
      summary: Get paypoint details by ID
      description: Retrieves the basic details for a paypoint by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: IdPaypoint
          in: path
          description: Paypoint ID. You can find this value by querying `/api/Query/paypoints/{orgId}`
          required: true
          schema:
            type: string
          example: '198'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBasicEntryByIdResponse'
              example:
                isSuccess: true
                responseCode: 1
                responseData:
                  EntryName: abc123def
                  EntryPages:
                    - AdditionalData:
                        key1:
                          key: value
                        key2:
                          key: value
                        key3:
                          key: value
                  IdEntry: 11111
                  Paypoint:
                    Address1: 123 Ocean Drive
                    Address2: Suite 400
                    BankData:
                      - bankAccountFunction: 0
                        bankAccountHolderName: Gruzya Adventure Outfitters LLC
                        nickname: Business Checking 1234
                    BoardingId: 340
                    City: Bristol
                    Contacts:
                      - {}
                    Country: US
                    Credentials:
                      - {}
                    DbaName: Sunshine Gutters
                    externalPaypointID: ''
                    Fax: '5555555555'
                    IdPaypoint: 1000000
                    LegalName: Sunshine Services, LLC
                    ParentOrg:
                      orgName: Pilgrim Planner
                      orgStatus: 1
                      orgType: 0
                    PaypointStatus: 1
                    Phone: '5555555555'
                    State: GA
                    summary:
                      amountSubs: 0
                      amountTx: 0
                      countSubs: 0
                      countTx: 0
                      customers: 1
                    TimeZone: -5
                    WebsiteAddress: www.example.com
                    Zip: '31113'
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Paypoint/load/{entry}/{subdomain}:
    get:
      operationId: hostedPaymentPages_loadPage
      tags:
        - HostedPaymentPages
      x-fern-sdk-group-name: hostedPaymentPages
      x-fern-sdk-method-name: loadPage
      x-fern-request-name: loadPageRequest
      summary: Get all payment page details
      description: Loads all of a payment page's details including `pageIdentifier` and `validationCode`. This endpoint requires an `application` API token.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: subdomain
          in: path
          description: Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in `https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
          required: true
          schema:
            type: string
          example: pay-your-fees-1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliPages'
              example:
                AdditionalData:
                  key1:
                    key: value
                  key2:
                    key: value
                  key3:
                    key: value
                Credentials:
                  - accountId: accountId
                    cfeeFix: 1.1
                    cfeeFloat: 1.1
                    cfeeMax: 1.1
                    cfeeMin: 1.1
                    maxticket: 1.1
                    minticket: 1.1
                    mode: 1
                    referenceId: 1000000
                    service: service
                LastAccess: '2022-06-30T15:01:00Z'
                PageContent:
                  amount:
                    categories:
                      - {}
                    enabled: true
                    order: 1
                  autopay:
                    enabled: true
                    frequencySelected: frequencySelected
                    header: header
                    order: 1
                    startDate: 1, 5-10
                  contactUs:
                    emailLabel: emailLabel
                    enabled: true
                    header: header
                    order: 1
                    paymentIcons: true
                    phoneLabel: phoneLabel
                  entry: entry
                  invoices:
                    enabled: true
                    invoiceLink:
                      enabled: true
                    order: 1
                    viewInvoiceDetails:
                      enabled: true
                  logo:
                    enabled: true
                    order: 1
                  messageBeforePaying:
                    enabled: true
                    label: label
                    order: 1
                  name: name
                  notes:
                    enabled: true
                    header: header
                    order: 1
                    placeholder: placeholder
                    value: value
                  page:
                    description: description
                    enabled: true
                    header: header
                    order: 1
                  paymentButton:
                    enabled: true
                    label: label
                    order: 1
                  paymentMethods:
                    allMethodsChecked: true
                    enabled: true
                    header: header
                    methods:
                      amex: true
                      applePay: true
                      discover: false
                      eCheck: false
                      mastercard: true
                      visa: true
                    order: 1
                  payor:
                    enabled: true
                    fields:
                      - {}
                    header: header
                    order: 1
                  review:
                    enabled: true
                    header: header
                    order: 1
                  subdomain: mypage-1
                pageIdentifier: 'null'
                PageSettings:
                  color: color
                  customCssUrl: customCssUrl
                  language: language
                  pageLogo:
                    fContent: TXkgdGVzdCBmaWxlHJ==...
                    filename: my-doc.pdf
                    ftype: pdf
                    furl: https://mysite.com/my-doc.pdf
                  paymentButton:
                    label: label
                    size: sm
                  redirectAfterApprove: true
                  redirectAfterApproveUrl: redirectAfterApproveUrl
                published: 1
                ReceiptContent:
                  amount:
                    enabled: true
                    order: 1
                  contactUs:
                    enabled: true
                    order: 1
                  details:
                    enabled: true
                    order: 1
                  logo:
                    enabled: true
                    order: 1
                  messageBeforeButton:
                    enabled: true
                    label: label
                    order: 1
                  page:
                    description: description
                    enabled: true
                    header: header
                    order: 1
                  paymentButton:
                    enabled: true
                    label: label
                    order: 1
                  paymentInformation:
                    enabled: true
                    order: 1
                  settings:
                    enabled: true
                    fields:
                      - {}
                    order: 1
                    sendAuto: true
                    sendManual: true
                Subdomain: mypage-1
                totalAmount: 1.1
                validationCode: validationCode
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Paypoint/logo/{entry}:
    put:
      operationId: paypoint_saveLogo
      tags:
        - Paypoint
      x-fern-sdk-group-name: paypoint
      x-fern-sdk-method-name: saveLogo
      x-fern-request-name: saveLogoRequest
      summary: Update paypoint logo
      description: Updates a paypoint logo.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileContent'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
              example:
                isSuccess: true
                pageIdentifier: 'null'
                responseCode: 1
                responseData: responseData
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Paypoint/migrate:
    post:
      operationId: paypoint_migrate
      tags:
        - Paypoint
      x-fern-sdk-group-name: paypoint
      x-fern-sdk-method-name: migrate
      x-fern-request-name: PaypointMoveRequest
      summary: Migrate paypoint
      description: Migrates a paypoint to a new parent organization.
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaypointMoveRequest'
            example:
              entryPoint: 473abc123def
              newParentOrganizationId: 123
              notificationRequest:
                notificationUrl: https://webhook-test.yoursie.com
                webHeaderParameters:
                  - key: testheader
                    value: '1234567890'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MigratePaypointResponse'
              example:
                isSuccess: true
                responseCode: 1
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Paypoint/settings/{entry}:
    get:
      operationId: paypoint_settingsPage
      tags:
        - Paypoint
      x-fern-sdk-group-name: paypoint
      x-fern-sdk-method-name: settingsPage
      x-fern-request-name: settingsPageRequest
      summary: Get paypoint settings
      description: Retrieves a paypoint's basic settings like custom fields, identifiers, and invoicing settings.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsQueryRecord'
              example:
                customFields:
                  - key: customerID
                    readOnly: false
                    value: ''
                  - key: test
                    readOnly: false
                    value: ''
                  - key: newfield
                    readOnly: false
                    value: ''
                  - key: testfield
                    readOnly: false
                    value: ''
                forInvoices:
                  - key: brandColor
                    value: '#0594fad1'
                  - key: requiredInvoiceNumber
                    value: 'true'
                  - key: invoicePrefix
                    value: INV-
                  - key: invoiceNumber
                    value: '1'
                  - key: dueDate
                    value: NET30
                  - key: dueDateCustom
                    value: Invalid Date
                  - key: memoNote
                    value: Thank you for your business!
                  - key: footerNote
                    value: default footer testing
                  - key: includePaymentLink
                    value: 'true'
                  - key: paylinkHeader
                    value: Gruzya Adventure Outfitters
                  - key: paylinkDescription
                    value: Pay Invoice
                  - key: contactUsText
                    value: Contact Us
                  - key: contactUsEmail
                    value: support@gruzyaadventureoutfitters.com
                  - key: contactUsPhone
                    value: '5551234567'
                  - key: invoiceNumbering
                    value: autoapply
                  - key: paymentVisa
                    value: 'true'
                  - key: paymentMastercard
                    value: 'true'
                  - key: paymentDiscover
                    value: 'true'
                  - key: paymentAmex
                    value: 'true'
                  - key: paymentAch
                    value: 'true'
                  - key: paymentApplePay
                    value: 'false'
                  - key: paymentGooglePay
                    value: 'false'
                  - key: requireInvoiceNumber
                    value: 'false'
                  - key: autoCreateInvoice
                    value: 'true'
                  - key: ''
                    value: ''
                forPayOuts:
                  - key: autoCapture
                    readOnly: false
                    value: 'true'
                  - key: autoPay
                    readOnly: false
                    value: 'true'
                  - key: autoDownloadCheckImage
                    readOnly: false
                    value: 'false'
                forWallets:
                  - key: isApplePayEnabled
                    readOnly: false
                    value: 'false'
                general:
                  - key: currency
                    readOnly: true
                    value: USD
                  - key: disableAutoReceipt
                    readOnly: true
                    value: 'true'
                  - key: sendApprovedReceipt
                    readOnly: false
                    value: 'true'
                  - key: sendDeclinedReceipt
                    readOnly: false
                    value: 'true'
                  - key: ''
                    readOnly: true
                    value: ''
                identifiers:
                  - key: key
                    readOnly: false
                    value: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Paypoint/{entry}:
    get:
      operationId: paypoint_getEntryConfig
      tags:
        - Paypoint
      x-fern-sdk-group-name: paypoint
      x-fern-sdk-method-name: getEntryConfig
      x-fern-request-name: getEntryConfigRequest
      summary: Get paypoint details
      description: Gets the details for a single paypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: entrypages
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEntryConfigResponse'
              example:
                isSuccess: true
                responseCode: 1
                responseData:
                  EntryName: abc123def
                  EntryPages:
                    - AdditionalData:
                        key1:
                          key: value
                        key2:
                          key: value
                        key3:
                          key: value
                  IdEntry: 11111
                  Paypoint:
                    Address1: 123 Ocean Drive
                    Address2: Suite 400
                    BankData:
                      - bankAccountFunction: 0
                        bankAccountHolderName: Gruzya Adventure Outfitters LLC
                        nickname: Business Checking 1234
                    BoardingId: 340
                    City: Bristol
                    Contacts:
                      - {}
                    Country: US
                    Credentials:
                      - {}
                    DbaName: Sunshine Gutters
                    externalPaypointID: ''
                    Fax: '5555555555'
                    IdPaypoint: 1000000
                    LegalName: Sunshine Services, LLC
                    ParentOrg:
                      orgName: Pilgrim Planner
                      orgStatus: 1
                      orgType: 0
                    PaypointStatus: 1
                    Phone: '5555555555'
                    State: GA
                    summary:
                      amountSubs: 0
                      amountTx: 0
                      countSubs: 0
                      countTx: 0
                      customers: 1
                    TimeZone: -5
                    WebsiteAddress: www.example.com
                    Zip: '31113'
                    StatementEmail:
                      sender: acme-partners@payabli.com
                      recipients:
                        - billing@example.com
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    post:
      operationId: hostedPaymentPages_newPage
      tags:
        - HostedPaymentPages
      x-fern-sdk-group-name: hostedPaymentPages
      x-fern-sdk-method-name: newPage
      x-fern-request-name: newPageRequest
      summary: Create payment page
      description: |-
        Creates a new payment page for a paypoint.
        Note: this operation doesn't create a new paypoint, just a payment page for an existing paypoint. Paypoints are created by the Payabli team when a boarding application is approved.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
          example: 6B29FC40-CA47-1067-B31D-00DD010662DA
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayabliPages'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
              example:
                isSuccess: true
                pageIdentifier: 'null'
                responseCode: 1
                responseData: responseData
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Paypoint/{entry}/{subdomain}:
    get:
      operationId: paypoint_getPage
      tags:
        - Paypoint
      x-fern-sdk-group-name: paypoint
      x-fern-sdk-method-name: getPage
      x-fern-request-name: getPageRequest
      summary: Get payment page details
      description: Gets the details for a single payment page for a paypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: subdomain
          in: path
          description: Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in `https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
          required: true
          schema:
            type: string
          example: pay-your-fees-1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliPages'
              example:
                AdditionalData:
                  key1:
                    key: value
                  key2:
                    key: value
                  key3:
                    key: value
                Credentials:
                  - accountId: accountId
                    cfeeFix: 1.1
                    cfeeFloat: 1.1
                    cfeeMax: 1.1
                    cfeeMin: 1.1
                    maxticket: 1.1
                    minticket: 1.1
                    mode: 1
                    referenceId: 1000000
                    service: service
                    greaterValueAllowed: true
                    absorbDifference: false
                    allowOverride: false
                LastAccess: '2022-06-30T15:01:00Z'
                PageContent:
                  amount:
                    categories:
                      - {}
                    enabled: true
                    order: 1
                  autopay:
                    enabled: true
                    frequencySelected: frequencySelected
                    header: header
                    order: 1
                    startDate: 1, 5-10
                  contactUs:
                    emailLabel: emailLabel
                    enabled: true
                    header: header
                    order: 1
                    paymentIcons: true
                    phoneLabel: phoneLabel
                  entry: entry
                  invoices:
                    enabled: true
                    invoiceLink:
                      enabled: true
                    order: 1
                    viewInvoiceDetails:
                      enabled: true
                  logo:
                    enabled: true
                    order: 1
                  messageBeforePaying:
                    enabled: true
                    label: label
                    order: 1
                  name: name
                  notes:
                    enabled: true
                    header: header
                    order: 1
                    placeholder: placeholder
                    value: value
                  page:
                    description: description
                    enabled: true
                    header: header
                    order: 1
                  paymentButton:
                    enabled: true
                    label: label
                    order: 1
                  paymentMethods:
                    allMethodsChecked: true
                    enabled: true
                    header: header
                    methods:
                      amex: true
                      applePay: true
                      discover: false
                      eCheck: false
                      mastercard: true
                      visa: true
                    order: 1
                  payor:
                    enabled: true
                    fields:
                      - {}
                    header: header
                    order: 1
                  review:
                    enabled: true
                    header: header
                    order: 1
                  subdomain: mypage-1
                pageIdentifier: 'null'
                PageSettings:
                  color: color
                  customCssUrl: customCssUrl
                  language: language
                  pageLogo:
                    fContent: TXkgdGVzdCBmaWxlHJ==...
                    filename: my-doc.pdf
                    ftype: pdf
                    furl: https://mysite.com/my-doc.pdf
                  paymentButton:
                    label: label
                    size: sm
                  redirectAfterApprove: true
                  redirectAfterApproveUrl: redirectAfterApproveUrl
                published: 1
                ReceiptContent:
                  amount:
                    enabled: true
                    order: 1
                  contactUs:
                    enabled: true
                    order: 1
                  details:
                    enabled: true
                    order: 1
                  logo:
                    enabled: true
                    order: 1
                  messageBeforeButton:
                    enabled: true
                    label: label
                    order: 1
                  page:
                    description: description
                    enabled: true
                    header: header
                    order: 1
                  paymentButton:
                    enabled: true
                    label: label
                    order: 1
                  paymentInformation:
                    enabled: true
                    order: 1
                  settings:
                    enabled: true
                    fields:
                      - {}
                    order: 1
                    sendAuto: true
                    sendManual: true
                Subdomain: mypage-1
                totalAmount: 1.1
                validationCode: validationCode
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    delete:
      operationId: paypoint_removePage
      tags:
        - Paypoint
      x-fern-sdk-group-name: paypoint
      x-fern-sdk-method-name: removePage
      x-fern-request-name: removePageRequest
      summary: Delete a payment page
      description: Deletes a payment page in a paypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: subdomain
          in: path
          description: Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in `https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
          required: true
          schema:
            type: string
          example: pay-your-fees-1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
              example:
                isSuccess: true
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: hostedPaymentPages_savePage
      tags:
        - HostedPaymentPages
      x-fern-sdk-group-name: hostedPaymentPages
      x-fern-sdk-method-name: savePage
      x-fern-request-name: savePageRequest
      summary: Update a payment page
      description: Updates a payment page in a paypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: subdomain
          in: path
          description: Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in `https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
          required: true
          schema:
            type: string
          example: pay-your-fees-1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayabliPages'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
              example:
                isSuccess: true
                responseCode: 1
                responseData: string
                responseText: Updated
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentMethodDomain:
    post:
      operationId: paymentMethodDomain_AddPaymentMethodDomain
      tags:
        - PaymentMethodDomain
      x-fern-sdk-group-name: paymentMethodDomain
      x-fern-sdk-method-name: AddPaymentMethodDomain
      x-fern-request-name: AddPaymentMethodDomainRequest
      summary: Add a payment method domain
      description: Add a payment method domain to an organization or paypoint.
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddPaymentMethodDomainRequest'
            example:
              domainName: checkout.example.com
              entityId: 109
              entityType: paypoint
              applePay:
                isEnabled: true
              googlePay:
                isEnabled: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddPaymentMethodDomainApiResponse'
              example:
                isSuccess: true
                pageidentifier: pageidentifier
                responseData:
                  id: pmd_a4c7e39d15f24b8c8d6259f174e3d081
                  type: PaymentMethodDomains
                  entityId: 109
                  entityType: paypoint
                  domainName: checkout.example.com
                  applePay:
                    isEnabled: true
                    data: null
                  googlePay:
                    isEnabled: true
                    data: null
                  ownerEntityId: 109
                  ownerEntityType: paypoint
                  cascades:
                    - jobId: '1030398'
                      jobStatus: completed
                      jobErrorMessage: null
                      createdAt: '2025-04-25T15:37:28.685Z'
                      updatedAt: '2025-04-25T15:37:33.228Z'
                    - jobId: '611502'
                      jobStatus: completed
                      jobErrorMessage: null
                      createdAt: '2026-09-26T22:25:45.095Z'
                      updatedAt: '2026-09-26T22:25:46.187Z'
                    - jobId: '611172'
                      jobStatus: completed
                      jobErrorMessage: null
                      createdAt: '2026-09-26T19:46:40.075Z'
                      updatedAt: '2026-09-26T19:47:13.548Z'
                  createdAt: '2025-04-25T15:44:17.016Z'
                  updatedAt: '2025-04-25T15:44:17.016Z'
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentMethodDomain/{domainId}/cascade:
    post:
      operationId: paymentMethodDomain_CascadePaymentMethodDomain
      tags:
        - PaymentMethodDomain
      x-fern-sdk-group-name: paymentMethodDomain
      x-fern-sdk-method-name: CascadePaymentMethodDomain
      x-fern-request-name: CascadePaymentMethodDomainRequest
      summary: Cascade a payment method domain to the child entities
      description: Cascades a payment method domain to all child entities. All paypoints and suborganization under this parent will inherit this domain and its settings.
      security:
        - APIKeyAuth: []
      parameters:
        - name: domainId
          in: path
          description: The payment method domain's ID in Payabli.
          required: true
          schema:
            type: string
          example: pmd_b8237fa45c964d8a9ef27160cd42b8c5
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMethodDomainGeneralResponse'
              example:
                isSuccess: true
                pageidentifier: 'null'
                responseData:
                  id: pmd_b8237fa45c964d8a9ef27160cd42b8c5
                  type: PaymentMethodDomains
                  entityId: 78
                  entityType: organization
                  domainName: checkout.example.com
                  applePay:
                    isEnabled: true
                    data: null
                  googlePay:
                    isEnabled: true
                    data: null
                  ownerEntityId: 78
                  ownerEntityType: organization
                  cascades:
                    - jobId: '1245697'
                      jobStatus: completed
                      jobErrorMessage: null
                      createdAt: '2025-04-25T15:37:28.685Z'
                      updatedAt: '2025-04-25T15:37:33.228Z'
                  createdAt: '2025-03-15T10:24:36.207Z'
                  updatedAt: '2025-04-25T15:38:46.804Z'
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentMethodDomain/{domainId}:
    delete:
      operationId: paymentMethodDomain_DeletePaymentMethodDomain
      tags:
        - PaymentMethodDomain
      x-fern-sdk-group-name: paymentMethodDomain
      x-fern-sdk-method-name: DeletePaymentMethodDomain
      x-fern-request-name: DeletePaymentMethodDomainRequest
      summary: Delete a payment method domain
      description: Delete a payment method domain. You can't delete an inherited domain, you must delete a domain at the organization level.
      security:
        - APIKeyAuth: []
      parameters:
        - name: domainId
          in: path
          description: The payment method domain's ID in Payabli.
          required: true
          schema:
            type: string
          example: pmd_b8237fa45c964d8a9ef27160cd42b8c5
      responses:
        '200':
          description: Success response for a deleted payment method domain.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePaymentMethodDomainResponse'
              example:
                isSuccess: true
                pageIdentifier: 'null'
                responseData: pmd_b8237fa45c964d8a9ef27160cd42b8c5
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    get:
      operationId: paymentMethodDomain_GetPaymentMethodDomain
      tags:
        - PaymentMethodDomain
      x-fern-sdk-group-name: paymentMethodDomain
      x-fern-sdk-method-name: GetPaymentMethodDomain
      x-fern-request-name: GetPaymentMethodDomainRequest
      summary: Get payment method domain details
      description: Get the details for a payment method domain.
      security:
        - APIKeyAuth: []
      parameters:
        - name: domainId
          in: path
          description: The payment method domain's ID in Payabli.
          required: true
          schema:
            type: string
          example: pmd_b8237fa45c964d8a9ef27160cd42b8c5
      responses:
        '200':
          description: Success response that includes a payment method domain's details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMethodDomainApiResponse'
              example:
                id: pmd_b8237fa45c964d8a9ef27160cd42b8c5
                type: PaymentMethodDomains
                entityId: 78
                entityType: organization
                domainName: checkout.example.com
                applePay:
                  isEnabled: true
                  data: null
                googlePay:
                  isEnabled: true
                  data: null
                ownerEntityId: 78
                ownerEntityType: organization
                cascades:
                  - jobId: '1245697'
                    jobStatus: completed
                    createdAt: '2025-04-25T15:37:28.685Z'
                    updatedAt: '2025-04-25T15:37:33.228Z'
                createdAt: '2025-03-15T10:24:36.207Z'
                updatedAt: '2025-04-25T15:38:46.804Z'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    patch:
      operationId: paymentMethodDomain_UpdatePaymentMethodDomain
      tags:
        - PaymentMethodDomain
      x-fern-sdk-group-name: paymentMethodDomain
      x-fern-sdk-method-name: UpdatePaymentMethodDomain
      x-fern-request-name: UpdatePaymentMethodDomainRequest
      summary: Update payment method domain configuration
      description: Update a payment method domain's configuration values.
      security:
        - APIKeyAuth: []
      parameters:
        - name: domainId
          in: path
          description: The payment method domain's ID in Payabli.
          required: true
          schema:
            type: string
          example: pmd_b8237fa45c964d8a9ef27160cd42b8c5
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePaymentMethodDomainRequest'
            example:
              applePay:
                isEnabled: false
              googlePay:
                isEnabled: false
      responses:
        '200':
          description: Success response for configuration update.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMethodDomainGeneralResponse'
              example:
                isSuccess: true
                pageidentifier: 'null'
                responseData:
                  id: pmd_b8237fa45c964d8a9ef27160cd42b8c5
                  type: PaymentMethodDomains
                  entityId: 78
                  entityType: organization
                  domainName: checkout.example.com
                  applePay:
                    isEnabled: false
                    data: null
                  googlePay:
                    isEnabled: false
                    data: null
                  ownerEntityId: 78
                  ownerEntityType: organization
                  cascades:
                    - jobId: '1245697'
                      jobStatus: completed
                      jobErrorMessage: null
                      createdAt: '2025-04-25T15:37:28.685Z'
                      updatedAt: '2025-04-25T15:37:33.228Z'
                  createdAt: '2025-03-15T10:24:36.207Z'
                  updatedAt: '2025-04-25T16:05:12.345Z'
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentMethodDomain/list:
    get:
      operationId: paymentMethodDomain_ListPaymentMethodDomains
      tags:
        - PaymentMethodDomain
      x-fern-sdk-group-name: paymentMethodDomain
      x-fern-sdk-method-name: ListPaymentMethodDomains
      x-fern-request-name: ListPaymentMethodDomainsRequest
      summary: List payment method domains for an entity
      description: Get a list of payment method domains that belong to a PSP, organization, or paypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entityId
          in: query
          description: |-
            Identifier for the organization or paypoint.
            - For organization, provide the organization ID - For paypoint, provide the paypoint ID
          required: false
          schema:
            type: integer
            format: int64
          examples:
            PaypointDomains:
              value: 1147
            OrgDomains:
              value: 39
        - name: entityType
          in: query
          description: |-
            The type of entity. Valid values:
              - organization
              - paypoint
              - psp
          required: false
          schema:
            type: string
          examples:
            PaypointDomains:
              value: paypoint
            OrgDomains:
              value: organization
        - name: fromRecord
          in: query
          description: Number of records to skip. Defaults to `0`.
          required: false
          schema:
            type: integer
            default: 0
        - name: limitRecord
          in: query
          description: Max number of records for query response. Defaults to `20`.
          required: false
          schema:
            type: integer
            default: 20
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentMethodDomainsResponse'
              examples:
                PaypointDomains:
                  value:
                    records:
                      - id: pmd_7b4b3ca0f6b74f02853dfcee5ec090a3
                        type: PaymentMethodDomains
                        entityId: 1147
                        entityType: paypoint
                        domainName: payment.example.com
                        applePay:
                          isEnabled: true
                        googlePay:
                          isEnabled: true
                        ownerEntityId: 1147
                        ownerEntityType: paypoint
                        createdAt: '2025-02-13T18:31:07.023Z'
                        updatedAt: '2025-03-18T13:48:39.056Z'
                      - id: pmd_1f799c8ab7dd432dbc2052ce332c101c
                        type: PaymentMethodDomains
                        entityId: 1147
                        entityType: paypoint
                        domainName: checkout.example.com
                        applePay:
                          isEnabled: true
                        googlePay:
                          isEnabled: true
                        ownerEntityId: 1147
                        ownerEntityType: paypoint
                        createdAt: '2025-02-13T18:04:50.207Z'
                        updatedAt: '2025-02-13T18:04:50.207Z'
                      - id: pmd_135ac1be6fab4a97850aadbbba77ce1b
                        type: PaymentMethodDomains
                        entityId: 1147
                        entityType: paypoint
                        domainName: pay.example.com
                        applePay:
                          isEnabled: true
                        googlePay:
                          isEnabled: false
                        ownerEntityId: 1147
                        ownerEntityType: paypoint
                        createdAt: '2026-09-06T03:55:32.213Z'
                        updatedAt: '2026-09-06T03:55:47.586Z'
                    summary:
                      pageIdentifier: t.wlbQ4YZ3/JJkaP2/muAxibhlwdVz1Ve89QtI40H9KPhf...
                      pageSize: 20
                      totalPages: 1
                      totalRecords: 17
                OrgDomains:
                  value:
                    records:
                      - id: pmd_1bed085c821e432fa71ae0817c571dd6
                        type: PaymentMethodDomains
                        entityId: 39
                        entityType: organization
                        domainName: checkout.example.com
                        applePay:
                          isEnabled: true
                        googlePay:
                          isEnabled: false
                        ownerEntityId: 39
                        ownerEntityType: organization
                        createdAt: '2026-09-27T01:20:17.486Z'
                        updatedAt: '2025-03-26T23:55:36.876Z'
                      - id: pmd_dab1e3d2a3774216920bdc2afd62c307
                        type: PaymentMethodDomains
                        entityId: 39
                        entityType: organization
                        domainName: checkout.example.com
                        applePay:
                          isEnabled: true
                        googlePay:
                          isEnabled: false
                        ownerEntityId: 39
                        ownerEntityType: organization
                        createdAt: '2026-08-23T03:42:06.673Z'
                        updatedAt: '2025-03-26T23:56:15.708Z'
                    summary:
                      pageIdentifier: pageIdentifier
                      pageSize: 20
                      totalPages: 1
                      totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PaymentMethodDomain/{domainId}/verify:
    post:
      operationId: paymentMethodDomain_VerifyPaymentMethodDomain
      tags:
        - PaymentMethodDomain
      x-fern-sdk-group-name: paymentMethodDomain
      x-fern-sdk-method-name: VerifyPaymentMethodDomain
      x-fern-request-name: VerifyPaymentMethodDomainRequest
      summary: Verify a payment method domain
      description: Verify a new payment method domain. If verification is successful, Apple Pay is automatically activated for the domain.
      security:
        - APIKeyAuth: []
      parameters:
        - name: domainId
          in: path
          description: The payment method domain's ID in Payabli.
          required: true
          schema:
            type: string
          examples:
            VerifySuccess:
              value: pmd_b8237fa45c964d8a9ef27160cd42b8c5
            VerifyFailure:
              value: pmd_b8237fa45c964d8a9ef27160cd42b8c5
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMethodDomainGeneralResponse'
              examples:
                VerifySuccess:
                  value:
                    isSuccess: true
                    pageidentifier: 'null'
                    responseData:
                      id: pmd_b8237fa45c964d8a9ef27160cd42b8c5
                      type: PaymentMethodDomains
                      entityId: 78
                      entityType: organization
                      domainName: checkout.example.com
                      applePay:
                        isEnabled: true
                        data: null
                      googlePay:
                        isEnabled: true
                        data: null
                      ownerEntityId: 78
                      ownerEntityType: organization
                      cascades:
                        - jobId: '1245697'
                          jobStatus: completed
                          jobErrorMessage: null
                          createdAt: '2025-04-25T15:37:28.685Z'
                          updatedAt: '2025-04-25T15:37:33.228Z'
                      createdAt: '2025-03-15T10:24:36.207Z'
                      updatedAt: '2025-04-25T15:45:21.517Z'
                    responseText: Success
                VerifyFailure:
                  value:
                    isSuccess: false
                    pageidentifier: 'null'
                    responseData:
                      id: pmd_b8237fa45c964d8a9ef27160cd42b8c5
                      type: PaymentMethodDomains
                      entityId: 78
                      entityType: organization
                      domainName: checkout.example.com
                      applePay:
                        isEnabled: true
                        data:
                          errorMessage: Unable to validate the domain. Verification file not found at https://checkout.example.com/.well-known/apple-developer-merchantid-domain-association
                          metadata:
                            isFileAvailable: false
                            isFileContentValid: false
                            statusCode: 404
                            redirectUrl: null
                            redirectDomainName: null
                      googlePay:
                        isEnabled: true
                        data:
                          errorMessage: Unable to validate the domain. Domain not found.
                          metadata:
                            statusCode: 404
                            redirectUrl: null
                            redirectDomainName: null
                      ownerEntityId: 78
                      ownerEntityType: organization
                      cascades:
                        - jobId: '1245697'
                          jobStatus: completed
                          jobErrorMessage: null
                          createdAt: '2025-04-25T15:37:28.685Z'
                          updatedAt: '2025-04-25T15:37:33.228Z'
                      createdAt: '2025-03-15T10:24:36.207Z'
                      updatedAt: '2025-04-25T15:45:21.517Z'
                    responseText: Failed
  /Import/billsForm/{entry}:
    post:
      operationId: import_ImportBills
      tags:
        - Import
      x-fern-sdk-group-name: import
      x-fern-sdk-method-name: ImportBills
      x-fern-request-name: ImportBillsRequest
      summary: Import list of bills
      description: Import a list of bills from a CSV file. See the [Import Guide](/developers/developer-guides/bills-add#import-bills) for more help and an example file.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ImportBillsRequest'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseImport'
              example:
                isSuccess: true
                pageIdentifier: 'null'
                responseCode: 1
                responseData:
                  added: 26
                  errors:
                    - errors
                    - errors
                  rejected: 2
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Import/customersForm/{entry}:
    post:
      operationId: import_ImportCustomer
      tags:
        - Import
      x-fern-sdk-group-name: import
      x-fern-sdk-method-name: ImportCustomer
      x-fern-request-name: ImportCustomerRequest
      summary: Import list of customers
      description: Import a list of customers from a CSV file. See the [Import Guide](/developers/developer-guides/entities-customers#import-customers) for more help and example files.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entrypoint identifier.
          schema:
            $ref: '#/components/schemas/Entrypointfield'
          example: 8cfec329267
        - name: replaceExisting
          in: query
          description: 'Flag indicating to replace existing customer with a new record. Possible values: 0 (do not replace), 1 (replace). Default is 0'
          required: false
          schema:
            type: integer
            default: 0
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ImportCustomerRequest'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseImport'
              example:
                isSuccess: true
                pageIdentifier: 'null'
                responseCode: 1
                responseData:
                  added: 26
                  errors:
                    - errors
                    - errors
                  rejected: 2
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Import/vendorsForm/{entry}:
    post:
      operationId: import_ImportVendor
      tags:
        - Import
      x-fern-sdk-group-name: import
      x-fern-sdk-method-name: ImportVendor
      x-fern-request-name: ImportVendorRequest
      summary: Import list of vendors
      description: Import a list of vendors from a CSV file. See the [Import Guide](/developers/developer-guides/entities-vendors#import-vendors) for more help and example files.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entrypoint identifier.
          schema:
            $ref: '#/components/schemas/Entrypointfield'
          example: 8cfec329267
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ImportVendorRequest'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseImport'
              example:
                isSuccess: true
                pageIdentifier: 'null'
                responseCode: 1
                responseData:
                  added: 26
                  errors:
                    - errors
                    - errors
                  rejected: 2
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/batchDetails/{entry}:
    get:
      operationId: query_ListBatchDetails
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListBatchDetails
      x-fern-request-name: ListBatchDetailsRequest
      summary: Get a list of settled and unsettled transactions in batches for a paypoint
      description: |-
        Retrieve a list of batches and their details, including settled and
        unsettled transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.

            **List of field names accepted:**

            - `settlementDate` (gt, ge, lt, le, eq, ne)
            - `depositDate` (gt, ge, lt, le, eq, ne)
            - `transId`  (ne, eq, ct, nct)
            - `gatewayTransId`  (ne, eq, ct, nct)
            - `method`   (in, nin, eq, ne)
            - `settledAmount`  (gt, ge, lt, le, eq, ne)
            - `operation`    (in, nin, eq, ne)
            - `source`   (in, nin, eq, ne)
            - `batchNumber`  (ct, nct, eq, ne)
            - `payaccountLastfour`   (nct, ct)
            - `payaccountType`   (ne, eq, in, nin)
            - `customerFirstname`   (ct, nct, eq, ne)
            - `customerLastname`    (ct, nct, eq, ne)
            - `customerName`   (ct, nct)
            - `customerId`  (eq, ne)
            - `customerNumber`  (ct, nct, eq, ne)
            - `customerCompanyname`    (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity`    (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity`    (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId`  (eq) *mandatory when entry=org*
            - `isHold` (eq, ne)
            - `paypointId`  (ne, eq)
            - `paypointLegal`  (ne, eq, ct, nct)
            - `paypointDba`  (ne, eq, ct, nct)
            - `orgName`  (ne, eq, ct, nct)
            - `batchId` (ct, nct, eq, neq)
            - `additional-xxx`  (ne, eq, ct, nct) where xxx is the additional field name

            **List of comparison accepted:**
            - `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 separated by "|"
            - `nin` => not inside array separated by "|"

            **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: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00.
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryBatchesDetailResponse'
              example:
                Records:
                  - Id: 25048
                    Method: ach
                    WalletType: null
                    SettledAmount: 0.5
                    Type: credit
                    BatchNumber: batch-100-20-2024
                    BatchAmount: 32
                    PaymentTransId: 245-9e4072eef77e45979ea0e49f680000X
                    PaymentTransStatus: 1
                    ScheduleReference: 0
                    GatewayTransId: TRN_XXXXX
                    OrderId: ''
                    TransMethod: ach
                    PaymentData:
                      AccountType: Checking
                      HolderName: Lydia Marshall
                      MaskedAccount: 1XXXXXX5678
                      paymentDetails:
                        categories:
                          - amount: 1000
                            label: Deposit
                        currency: USD
                        serviceFee: 0
                        splitFunding:
                          - {}
                        totalAmount: 2
                    NetAmount: 2
                    Operation: Sale
                    Category: auth
                    Source: api
                    Status: 1
                    TransactionTime: '2024-11-19T15:58:01Z'
                    Customer:
                      AdditionalData: null
                      BillingAddress1: 100 Golden Ridge Drive
                      BillingAddress2: STE 100
                      BillingCity: Mendota
                      BillingCountry: US
                      BillingEmail: lydia@example.com
                      BillingPhone: '+12345678'
                      BillingState: VA
                      BillingZip: '20147'
                      customerId: 2707
                      CustomerNumber: '901102'
                      customerStatus: 1
                      FirstName: Lydia
                      LastName: Marshall
                    SettlementDate: '2024-11-20T00:00:00Z'
                    PaymentSettlementStatus: 1
                    BatchStatus: 1
                    DepositDate: '2024-11-22T00:00:00Z'
                    ExpectedDepositDate: '2024-11-22T00:00:00Z'
                    MaskedAccount: 1XXXXXX5678
                    CreatedAt: '2024-11-19T15:58:01Z'
                    PaypointLegalname: Gruzya Adventure Outfitters, LLC
                    ResponseData:
                      authcode: ' '
                      avsresponse: ' '
                      avsresponse_text: ''
                      cvvresponse: ' '
                      cvvresponse_text: ' '
                      emv_auth_response_data: ' '
                      orderid: null
                      response: Success
                      response_code: '100'
                      response_code_text: Transaction was approved.
                      responsetext: CAPTURED
                      resultCode: A0000
                      resultCodeText: Approved
                      transactionid: TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0
                    PaypointDbaname: Gruzya Adventure Outfitters, LLC
                    ParentOrgName: Pilgrim Planner
                    ParentOrgId: 123
                    PaypointEntryname: 7f1a3816XX
                    DeviceId: ''
                    RetrievalId: 0
                    ChargebackId: 0
                    AchHolderType: personal
                    AchSecCode: PPD
                    ConnectorName: DefaultConnector
                    EntrypageId: 0
                    FeeAmount: 0
                    OrgId: 123
                    PayorId: 2707
                    PaypointId: 123
                    PendingFeeAmount: 0
                    RefundId: 0
                    ReturnedId: 0
                    splitFundingInstructions: []
                    TotalAmount: 2
                    CfeeTransactions: []
                    invoiceData: null
                    TransactionEvents:
                      - EventTime: '2024-11-19T15:57:40Z'
                        TransEvent: Created
                      - EventData:
                          account_id: TRA_XXXXX
                          account_name: '123456'
                          action:
                            app_id: XXXXX
                            app_name: PayAbli
                            id: ACT_XXXXX
                            result_code: SUCCESS
                            time_created: '2024-11-19T20:58:01.583Z'
                            type: AUTHORIZE
                          amount: '200'
                          batch_id: ''
                          capture_mode: AUTO
                          channel: CNP
                          country: US
                          currency: USD
                          fees:
                            amount: '0'
                            rate: '0.00'
                            total_amount: '0'
                          id: TRN_XXXXX
                          merchant_amount: '200'
                          merchant_id: MER_XXXXX
                          merchant_name: Henriette97
                          order:
                            reference: ''
                          payment_method:
                            bank_transfer:
                              account_type: CHECKING
                              bank:
                                name: ''
                              masked_account_number_last4: XXXX5678
                            entry_mode: ECOM
                            message: Success
                            narrative: Lydia Marshall
                            result: '00'
                          reference: 245-XXXXX
                          status: CAPTURED
                          time_created: '2024-11-19T20:58:01.583Z'
                          type: SALE
                        EventTime: '2024-11-19T20:58:01Z'
                        TransEvent: Approved
                      - EventTime: '2024-11-20T03:05:10Z'
                        TransEvent: ClosedBatch
                    externalPaypointID: ext-paypoint-123
                    isHold: 0
                Summary:
                  serviceFees: 852.48
                  transferAmount: 0
                  refunds: -3521.85
                  heldAmount: 3.7
                  totalRecords: 21872
                  totalAmount: 61645.74
                  totalNetAmount: 61645.74
                  totalPages: 21872
                  pageSize: 0
                  pageidentifier: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/batchDetails/org/{orgId}:
    get:
      operationId: query_ListBatchDetailsOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListBatchDetailsOrg
      x-fern-request-name: ListBatchDetailsOrgRequest
      summary: Get list of settled and unsettled transactions in batches for an org
      description: Retrieve a list of batches and their details, including settled and unsettled transactions for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.

            **List of field names accepted:**

            - `settlementDate` (gt, ge, lt, le, eq, ne)
            - `depositDate` (gt, ge, lt, le, eq, ne)
            - `transId`  (ne, eq, ct, nct)
            - `gatewayTransId`  (ne, eq, ct, nct)
            - `method`   (in, nin, eq, ne)
            - `settledAmount`  (gt, ge, lt, le, eq, ne)
            - `operation`    (in, nin, eq, ne)
            - `source`   (in, nin, eq, ne)
            - `batchNumber`  (ct, nct, eq, ne)
            - `payaccountLastfour`   (nct, ct)
            - `payaccountType`   (ne, eq, in, nin)
            - `customerFirstname`   (ct, nct, eq, ne)
            - `customerLastname`    (ct, nct, eq, ne)
            - `customerName`   (ct, nct)
            - `customerId`  (eq, ne)
            - `customerNumber`  (ct, nct, eq, ne)
            - `customerCompanyname`    (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity`    (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity`    (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId`  (eq) *mandatory when entry=org*
            - `isHold` (eq, ne)
            - `paypointId`  (ne, eq)
            - `paypointLegal`  (ne, eq, ct, nct)
            - `paypointDba`  (ne, eq, ct, nct)
            - `orgName`  (ne, eq, ct, nct)
            - `batchId` (ct, nct, eq, neq)
            - `additional-xxx`  (ne, eq, ct, nct) where xxx is the additional field name

            **List of comparison accepted:**
            - `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 separated by "|"
            - `nin` => not inside array separated by "|"

            **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: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00.
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryBatchesDetailResponse'
              example:
                Records:
                  - Id: 25048
                    Method: ach
                    WalletType: null
                    SettledAmount: 0.5
                    Type: credit
                    BatchNumber: batch-100-20-2024
                    BatchAmount: 32
                    PaymentTransId: 245-9e4072eef77e45979ea0e49f680000X
                    PaymentTransStatus: 1
                    ScheduleReference: 0
                    GatewayTransId: TRN_XXXXX
                    OrderId: ''
                    TransMethod: ach
                    PaymentData:
                      AccountType: Checking
                      HolderName: Lydia Marshall
                      MaskedAccount: 1XXXXXX5678
                      paymentDetails:
                        categories:
                          - amount: 1000
                            label: Deposit
                        currency: USD
                        serviceFee: 0
                        splitFunding:
                          - {}
                        totalAmount: 2
                    NetAmount: 2
                    Operation: Sale
                    Category: auth
                    Source: api
                    Status: 1
                    TransactionTime: '2024-11-19T15:58:01Z'
                    Customer:
                      AdditionalData: null
                      BillingAddress1: 100 Golden Ridge Drive
                      BillingAddress2: STE 100
                      BillingCity: Mendota
                      BillingCountry: US
                      BillingEmail: lydia@example.com
                      BillingPhone: '+12345678'
                      BillingState: VA
                      BillingZip: '20147'
                      customerId: 2707
                      CustomerNumber: '901102'
                      customerStatus: 1
                      FirstName: Lydia
                      LastName: Marshall
                    SettlementDate: '2024-11-20T00:00:00Z'
                    PaymentSettlementStatus: 1
                    BatchStatus: 1
                    DepositDate: '2024-11-22T00:00:00Z'
                    ExpectedDepositDate: '2024-11-22T00:00:00Z'
                    MaskedAccount: 1XXXXXX5678
                    CreatedAt: '2024-11-19T15:58:01Z'
                    PaypointLegalname: Gruzya Adventure Outfitters, LLC
                    ResponseData:
                      authcode: ' '
                      avsresponse: ' '
                      avsresponse_text: ''
                      cvvresponse: ' '
                      cvvresponse_text: ' '
                      emv_auth_response_data: ' '
                      orderid: null
                      response: Success
                      response_code: '100'
                      response_code_text: Transaction was approved.
                      responsetext: CAPTURED
                      resultCode: A0000
                      resultCodeText: Approved
                      transactionid: TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0
                    PaypointDbaname: Gruzya Adventure Outfitters, LLC
                    ParentOrgName: Pilgrim Planner
                    ParentOrgId: 123
                    PaypointEntryname: 7f1a3816XX
                    DeviceId: ''
                    RetrievalId: 0
                    ChargebackId: 0
                    AchHolderType: personal
                    AchSecCode: PPD
                    ConnectorName: DefaultConnector
                    EntrypageId: 0
                    FeeAmount: 0
                    OrgId: 123
                    PayorId: 2707
                    PaypointId: 123
                    PendingFeeAmount: 0
                    RefundId: 0
                    ReturnedId: 0
                    splitFundingInstructions: []
                    TotalAmount: 2
                    CfeeTransactions: []
                    invoiceData: null
                    TransactionEvents:
                      - EventTime: '2024-11-19T15:57:40Z'
                        TransEvent: Created
                      - EventData:
                          account_id: TRA_XXXXX
                          account_name: '123456'
                          action:
                            app_id: XXXXX
                            app_name: PayAbli
                            id: ACT_XXXXX
                            result_code: SUCCESS
                            time_created: '2024-11-19T20:58:01.583Z'
                            type: AUTHORIZE
                          amount: '200'
                          batch_id: ''
                          capture_mode: AUTO
                          channel: CNP
                          country: US
                          currency: USD
                          fees:
                            amount: '0'
                            rate: '0.00'
                            total_amount: '0'
                          id: TRN_XXXXX
                          merchant_amount: '200'
                          merchant_id: MER_XXXXX
                          merchant_name: Henriette97
                          order:
                            reference: ''
                          payment_method:
                            bank_transfer:
                              account_type: CHECKING
                              bank:
                                name: ''
                              masked_account_number_last4: XXXX5678
                            entry_mode: ECOM
                            message: Success
                            narrative: Lydia Marshall
                            result: '00'
                          reference: 245-XXXXX
                          status: CAPTURED
                          time_created: '2024-11-19T20:58:01.583Z'
                          type: SALE
                        EventTime: '2024-11-19T20:58:01Z'
                        TransEvent: Approved
                      - EventTime: '2024-11-20T03:05:10Z'
                        TransEvent: ClosedBatch
                    externalPaypointID: ext-paypoint-123
                    isHold: 0
                Summary:
                  heldAmount: 3.7
                  pageSize: 0
                  refunds: -3521.85
                  serviceFees: 852.48
                  totalAmount: 61645.74
                  totalNetAmount: 61645.74
                  totalPages: 21872
                  totalRecords: 21872
                  transferAmount: 0
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/batches/{entry}:
    get:
      operationId: query_ListBatches
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListBatches
      x-fern-request-name: ListBatchesRequest
      summary: Get list of batches for a paypoint
      description: Retrieve a list of batches for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.

            **List of field names accepted:**

            - `batchDate` (gt, ge, lt, le, eq, ne)
            - `batchNumber` (ne, eq)
            - `method` (in, nin, eq, ne)
            - `connectorName` (ne, eq, ct, nct)
            - `batchAmount` (gt, ge, lt, le, eq, ne)
            - `feeBatchAmount` (gt, ge, lt, le, eq, ne)
            - `netBatchAmount` (gt, ge, lt, le, eq, ne)
            - `releaseAmount` (gt, ge, lt, le, eq, ne)
            - `heldAmount` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `paypointId` (ne, eq)
            - `externalPaypointID` (ct, nct, eq, ne)
            - `expectedDepositDate` (gt, ge, lt, le, eq, ne)
            - `depositDate` (gt, ge, lt, le, eq, ne)
            - `batchRecords` (gt, ge, lt, le, eq, ne)
            - `transferId` (ne, eq)
            - `transferDate` (gt, ge, lt, le, eq, ne)
            - `grossAmount` (gt, ge, lt, le, eq, ne)
            - `chargeBackAmount` (gt, ge, lt, le, eq, ne)
            - `returnedAmount` (gt, ge, lt, le, eq, ne)
            - `billingFeeAmount` (gt, ge, lt, le, eq, ne)
            - `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)
            - `netFundedAmount` (gt, ge, lt, le, eq, ne)
            - `adjustmentAmount` (gt, ge, lt, le, eq, ne)
            - `processor` (ne, eq, ct, nct)
            - `transferStatus` (ne, eq, in, nin)

            **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: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryBatchesResponse'
              example:
                Summary:
                  pageidentifier: null
                  pageSize: 20
                  totalAmount: 54049.71
                  totalNetAmount: 0
                  totalPages: 3
                  totalRecords: 3
                Records:
                  - IdBatch: 1049
                    BatchNumber: batch_2857_combined_08-26-2025_001
                    TransferIdentifier: null
                    EventsData:
                      - description: Created
                        eventTime: '2025-08-25T03:19:27.6190027-04:00'
                        refData: null
                        extraData: null
                        source: api
                    ConnectorName: GP
                    BatchDate: '2025-08-25T20:00:00'
                    BatchAmount: 0
                    BatchFeesAmount: 0
                    BatchAuthAmount: 0
                    BatchReleasedAmount: 0
                    BatchHoldAmount: 0
                    BatchReturnedAmount: 0
                    BatchRefundAmount: 0
                    BatchSplitAmount: 0
                    BatchStatus: 2
                    BatchRecords: 2
                    PaypointId: 187
                    PaypointName: Gruzya Adventure Outfitters, LLC
                    PaypointDba: Gruzya Adventure Outfitters
                    ParentOrgName: Pilgrim Planner
                    ParentOrgId: 105
                    externalPaypointID: null
                    EntryName: 47f4f8c7e1
                    BankName: Riverdale Community Bank
                    BatchType: 0
                    Method: combined
                    ExpectedDepositDate: '2025-08-26T00:00:00Z'
                    DepositDate: null
                    TransferDate: '2025-08-26T00:00:00Z'
                    Transfer: null
                  - IdBatch: 1043
                    BatchNumber: BT-2023041817-187
                    TransferIdentifier: null
                    EventsData: null
                    ConnectorName: null
                    BatchDate: '2023-04-18T17:01:03Z'
                    BatchAmount: 219.02
                    BatchFeesAmount: 0
                    BatchAuthAmount: 0
                    BatchReleasedAmount: 0
                    BatchHoldAmount: 0
                    BatchReturnedAmount: 0
                    BatchRefundAmount: 0
                    BatchSplitAmount: 0
                    BatchStatus: 2
                    BatchRecords: 1
                    PaypointId: 187
                    PaypointName: Gruzya Adventure Outfitters, LLC
                    PaypointDba: Gruzya Adventure Outfitters
                    ParentOrgName: Pilgrim Planner
                    ParentOrgId: 105
                    externalPaypointID: null
                    EntryName: d193cf9a46
                    BankName: Riverdale Community Bank
                    BatchType: 0
                    Method: card
                    ExpectedDepositDate: '2023-04-19T00:00:00Z'
                    DepositDate: null
                    TransferDate: '2025-09-02T00:00:00Z'
                    Transfer: null
                  - IdBatch: 1012
                    BatchNumber: BT-2023041421-187
                    TransferIdentifier: ec310c3d-d4bf-4670-9524-00fcc4ab6a2a
                    EventsData:
                      - description: Created
                        eventTime: '2023-04-14T21:01:03Z'
                        refData: null
                        extraData: null
                        source: api
                      - description: Closed
                        eventTime: '2023-04-15T03:05:10Z'
                        refData: 'batchId: 1012'
                        extraData: null
                        source: worker
                    ConnectorName: GP
                    BatchDate: '2023-04-14T21:01:03Z'
                    BatchAmount: 1080.44
                    BatchFeesAmount: 0
                    BatchAuthAmount: 1080.44
                    BatchReleasedAmount: 0
                    BatchHoldAmount: 0
                    BatchReturnedAmount: 0
                    BatchRefundAmount: 0
                    BatchSplitAmount: 0
                    BatchStatus: 2
                    BatchRecords: 4
                    PaypointId: 187
                    PaypointName: Gruzya Adventure Outfitters, LLC
                    PaypointDba: Gruzya Adventure Outfitters
                    ParentOrgName: Pilgrim Planner
                    ParentOrgId: 105
                    externalPaypointID: null
                    EntryName: d193cf9a46
                    BankName: Riverdale Community Bank
                    BatchType: 0
                    Method: card
                    ExpectedDepositDate: '2023-04-15T00:00:00Z'
                    DepositDate: null
                    TransferDate: '2025-09-02T00:00:00Z'
                    Transfer:
                      TransferId: 5998
                      TransferDate: '2025-09-02T00:00:00Z'
                      Processor: gp
                      TransferStatus: 1
                      GrossAmount: 1080.44
                      ChargeBackAmount: 0
                      ReturnedAmount: 0
                      RefundAmount: 0
                      HoldAmount: 0
                      ReleasedAmount: 0
                      BillingFeesAmount: 0
                      ThirdPartyPaidAmount: 0
                      AdjustmentsAmount: 0
                      NetFundedAmount: 1080.44
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/batches/org/{orgId}:
    get:
      operationId: query_ListBatchesOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListBatchesOrg
      x-fern-request-name: ListBatchesOrgRequest
      summary: Get list of batches for an organization
      description: Retrieve a list of batches for an org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.

            **List of field names accepted:**

            - `batchDate` (gt, ge, lt, le, eq, ne)
            - `batchNumber` (ne, eq)
            - `method` (in, nin, eq, ne)
            - `connectorName` (ne, eq, ct, nct)
            - `batchAmount` (gt, ge, lt, le, eq, ne)
            - `feeBatchAmount` (gt, ge, lt, le, eq, ne)
            - `netBatchAmount` (gt, ge, lt, le, eq, ne)
            - `releaseAmount` (gt, ge, lt, le, eq, ne)
            - `heldAmount` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `paypointId` (ne, eq)
            - `externalPaypointID` (ct, nct, eq, ne)
            - `expectedDepositDate` (gt, ge, lt, le, eq, ne)
            - `depositDate` (gt, ge, lt, le, eq, ne)
            - `batchRecords` (gt, ge, lt, le, eq, ne)
            - `transferId` (ne, eq)
            - `transferDate` (gt, ge, lt, le, eq, ne)
            - `grossAmount` (gt, ge, lt, le, eq, ne)
            - `chargeBackAmount` (gt, ge, lt, le, eq, ne)
            - `returnedAmount` (gt, ge, lt, le, eq, ne)
            - `billingFeeAmount` (gt, ge, lt, le, eq, ne)
            - `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)
            - `netFundedAmount` (gt, ge, lt, le, eq, ne)
            - `adjustmentAmount` (gt, ge, lt, le, eq, ne)
            - `processor` (ne, eq, ct, nct)
            - `transferStatus` (ne, eq, in, nin)

            **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: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryBatchesResponse'
              example:
                Summary:
                  pageidentifier: null
                  pageSize: 20
                  totalAmount: 54049.71
                  totalNetAmount: 0
                  totalPages: 3
                  totalRecords: 3
                Records:
                  - IdBatch: 1049
                    BatchNumber: batch_2857_combined_08-26-2025_001
                    TransferIdentifier: null
                    EventsData:
                      - description: Created
                        eventTime: '2025-08-25T03:19:27.6190027-04:00'
                        refData: null
                        extraData: null
                        source: api
                    ConnectorName: GP
                    BatchDate: '2025-08-25T20:00:00'
                    BatchAmount: 0
                    BatchFeesAmount: 0
                    BatchAuthAmount: 0
                    BatchReleasedAmount: 0
                    BatchHoldAmount: 0
                    BatchReturnedAmount: 0
                    BatchRefundAmount: 0
                    BatchSplitAmount: 0
                    BatchStatus: 2
                    BatchRecords: 2
                    PaypointId: 187
                    PaypointName: Gruzya Adventure Outfitters, LLC
                    PaypointDba: Gruzya Adventure Outfitters
                    ParentOrgName: Pilgrim Planner
                    ParentOrgId: 105
                    externalPaypointID: null
                    EntryName: 47f4f8c7e1
                    BankName: Riverdale Community Bank
                    BatchType: 0
                    Method: combined
                    ExpectedDepositDate: '2025-08-26T00:00:00Z'
                    DepositDate: null
                    TransferDate: '2025-08-26T00:00:00Z'
                    Transfer: null
                  - IdBatch: 1043
                    BatchNumber: BT-2023041817-187
                    TransferIdentifier: null
                    EventsData: null
                    ConnectorName: null
                    BatchDate: '2023-04-18T17:01:03Z'
                    BatchAmount: 219.02
                    BatchFeesAmount: 0
                    BatchAuthAmount: 0
                    BatchReleasedAmount: 0
                    BatchHoldAmount: 0
                    BatchReturnedAmount: 0
                    BatchRefundAmount: 0
                    BatchSplitAmount: 0
                    BatchStatus: 2
                    BatchRecords: 1
                    PaypointId: 187
                    PaypointName: Gruzya Adventure Outfitters, LLC
                    PaypointDba: Gruzya Adventure Outfitters
                    ParentOrgName: Pilgrim Planner
                    ParentOrgId: 105
                    externalPaypointID: null
                    EntryName: d193cf9a46
                    BankName: Riverdale Community Bank
                    BatchType: 0
                    Method: card
                    ExpectedDepositDate: '2023-04-19T00:00:00Z'
                    DepositDate: null
                    TransferDate: '2025-09-02T00:00:00Z'
                    Transfer: null
                  - IdBatch: 1012
                    BatchNumber: BT-2023041421-187
                    TransferIdentifier: ec310c3d-d4bf-4670-9524-00fcc4ab6a2a
                    EventsData:
                      - description: Created
                        eventTime: '2023-04-14T21:01:03Z'
                        refData: null
                        extraData: null
                        source: api
                      - description: Closed
                        eventTime: '2023-04-15T03:05:10Z'
                        refData: 'batchId: 1012'
                        extraData: null
                        source: worker
                    ConnectorName: GP
                    BatchDate: '2023-04-14T21:01:03Z'
                    BatchAmount: 1080.44
                    BatchFeesAmount: 0
                    BatchAuthAmount: 1080.44
                    BatchReleasedAmount: 0
                    BatchHoldAmount: 0
                    BatchReturnedAmount: 0
                    BatchRefundAmount: 0
                    BatchSplitAmount: 0
                    BatchStatus: 2
                    BatchRecords: 4
                    PaypointId: 187
                    PaypointName: Gruzya Adventure Outfitters, LLC
                    PaypointDba: Gruzya Adventure Outfitters
                    ParentOrgName: Pilgrim Planner
                    ParentOrgId: 105
                    externalPaypointID: null
                    EntryName: d193cf9a46
                    BankName: Riverdale Community Bank
                    BatchType: 0
                    Method: card
                    ExpectedDepositDate: '2023-04-15T00:00:00Z'
                    DepositDate: null
                    TransferDate: '2025-09-02T00:00:00Z'
                    Transfer:
                      TransferId: 5998
                      TransferDate: '2025-09-02T00:00:00Z'
                      Processor: gp
                      TransferStatus: 1
                      GrossAmount: 1080.44
                      ChargeBackAmount: 0
                      ReturnedAmount: 0
                      RefundAmount: 0
                      HoldAmount: 0
                      ReleasedAmount: 0
                      BillingFeesAmount: 0
                      ThirdPartyPaidAmount: 0
                      AdjustmentsAmount: 0
                      NetFundedAmount: 1080.44
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/batchesOut/{entry}:
    get:
      operationId: query_ListBatchesOut
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListBatchesOut
      x-fern-request-name: ListBatchesOutRequest
      summary: Get list of MoneyOut batches for a paypoint
      description: Retrieve a list of MoneyOut batches for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - name: parameters
          in: query
          description: |-
            Collection of field names, conditions, and values used to filter the query. See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.

            **List of field names accepted**:

            - `batchDate` (gt, ge, lt, le, eq, ne)
            - `batchNumber` (ne, eq)
            - `batchAmount` (gt, ge, lt, le, eq, ne)
            - `parentOrgId` (ne, eq, nin, in)
            - `status` (in, nin, eq, ne)
            - `orgId` (eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `paypointId` (ne, eq)
            - `externalPaypointID` (ct, nct, eq, ne)
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryBatchesOutResponse'
              example:
                Records:
                  - AchAmount: 0
                    AchRecords: 0
                    AchStatus: 0
                    AchStatusText: AchStatusText
                    BatchAmount: 4
                    BatchCancelledAmount: 0
                    BatchCancelledRecords: 0
                    BatchDate: '2024-01-01T00:00:00Z'
                    BatchNumber: 10-20240101-PAYABLITST
                    BatchPaidAmount: 0
                    BatchPaidRecords: 0
                    BatchProcessedAmount: 0
                    BatchProcessedRecords: 0
                    BatchProcessingAmount: 0
                    BatchProcessingRecords: 0
                    BatchRecords: 1
                    BatchStatus: 1
                    BatchStatusText: Waiting Funds
                    CardAmount: 0
                    CardRecords: 0
                    CardStatus: 0
                    CardStatusText: CardStatusText
                    CheckAmount: 0
                    CheckRecords: 0
                    CheckStatus: 0
                    CheckStatusText: CheckStatusText
                    EntryName: d193cf9a46
                    externalPaypointID: Paypoint-100
                    IdBatch: 239
                    ParentOrgName: FitnessManager
                    PaypointDba: Athlete Factory LLC
                    PaypointId: 123
                    PaypointName: Athlete Factory LLC
                    VcardAmount: 0
                    VcardRecords: 0
                    VcardStatus: 0
                    VcardStatusText: VcardStatusText
                    WireAmount: 0
                    WireRecords: 0
                    WireStatus: 0
                    WireStatusText: WireStatusText
                Summary:
                  pageidentifier: 'null'
                  pageSize: 20
                  totalAmount: 0.01
                  totalNetAmount: 0
                  totalPages: 1
                  totalRecords: 46
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/batchesOut/org/{orgId}:
    get:
      operationId: query_ListBatchesOutOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListBatchesOutOrg
      x-fern-request-name: ListBatchesOutOrgRequest
      summary: Get list of MoneyOut batches for an org
      description: Retrieve a list of MoneyOut batches for an org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.

            **List of field names accepted**:

            - `batchDate` (gt, ge, lt, le, eq, ne)
            - `batchNumber` (ne, eq)
            - `batchAmount` (gt, ge, lt, le, eq, ne)
            - `parentOrgId` (ne, eq, nin, in)
            - `status` (in, nin, eq, ne)
            - `orgId` (eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `paypointId` (ne, eq)
            - `externalPaypointID` (ct, nct, eq, ne)
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryBatchesOutResponse'
              example:
                Records:
                  - AchAmount: 0
                    AchRecords: 0
                    AchStatus: 0
                    AchStatusText: AchStatusText
                    BatchAmount: 4
                    BatchCancelledAmount: 0
                    BatchCancelledRecords: 0
                    BatchDate: '2024-01-01T00:00:00Z'
                    BatchNumber: 10-20240101-PAYABLITST
                    BatchPaidAmount: 0
                    BatchPaidRecords: 0
                    BatchProcessedAmount: 0
                    BatchProcessedRecords: 0
                    BatchProcessingAmount: 0
                    BatchProcessingRecords: 0
                    BatchRecords: 1
                    BatchStatus: 1
                    BatchStatusText: Waiting Funds
                    CardAmount: 0
                    CardRecords: 0
                    CardStatus: 0
                    CardStatusText: CardStatusText
                    CheckAmount: 0
                    CheckRecords: 0
                    CheckStatus: 0
                    CheckStatusText: CheckStatusText
                    EntryName: d193cf9a46
                    externalPaypointID: Paypoint-100
                    IdBatch: 239
                    ParentOrgName: FitnessManager
                    PaypointDba: Athlete Factory LLC
                    PaypointId: 123
                    PaypointName: Athlete Factory LLC
                    VcardAmount: 0
                    VcardRecords: 0
                    VcardStatus: 0
                    VcardStatusText: VcardStatusText
                    WireAmount: 0
                    WireRecords: 0
                    WireStatus: 0
                    WireStatusText: WireStatusText
                Summary:
                  pageidentifier: 'null'
                  pageSize: 20
                  totalAmount: 0.01
                  totalNetAmount: 0
                  totalPages: 1
                  totalRecords: 46
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/chargebacks/{entry}:
    get:
      operationId: query_ListChargebacks
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListChargebacks
      x-fern-request-name: ListChargebacksRequest
      summary: Get list of chargebacks and returned transactions for a paypoint
      description: Retrieves a list of chargebacks and returned transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            **List of field names accepted:**
            - `chargebackDate` (gt, ge, lt, le, eq, ne)
            - `transId`  (ne, eq, ct, nct)
            - `method`   (in, nin, eq, ne)
            - `netAmount`  (gt, ge, lt, le, eq, ne)
            - `reasonCode`   (in, nin, eq, ne)
            - `reason`  (ct, nct, eq, ne)
            - `replyDate` (gt, ge, lt, le, eq, ne)
            - `caseNumber`  (ct, nct, eq, ne)
            - `status`   (in, nin, eq, ne)
            - `accountType`   (in, nin, eq, ne)
            - `payaccountLastfour`   (nct, ct)
            - `payaccountType`   (ne, eq, in, nin)
            - `customerFirstname`   (ct, nct, eq, ne)
            - `customerLastname`    (ct, nct, eq, ne)
            - `customerName`   (ct, nct)
            - `customerId`  (eq, ne)
            - `customerNumber`  (ct, nct, eq, ne)
            - `customerCompanyname`    (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity`    (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity`    (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId`  (eq) *mandatory when entry=org*
            - `paypointId`  (ne, eq)
            - `paypointLegal`  (ne, eq, ct, nct)
            - `paypointDba`  (ne, eq, ct, nct)
            - `orgName`  (ne, eq, ct, nct)
            - `additional-xxx`  (ne, eq, ct, nct) where xxx is the additional field name

            **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 separated by "|"
            - `nin` => not inside array separated by "|"

            **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: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryChargebacksResponse'
              example:
                Records:
                  - AccountType: 4XXXXXX0003
                    CaseNumber: '00001'
                    ChargebackDate: '2023-02-08T00:00:00Z'
                    CreatedAt: '2023-02-20T15:36:49Z'
                    Customer:
                      AdditionalData: null
                      BillingAddress1: 321 Big Sky Road
                      BillingAddress2: ''
                      BillingCity: Helena
                      BillingCountry: US
                      BillingEmail: janis.berzins@example.com
                      BillingPhone: 406-555-0123
                      BillingState: MT
                      BillingZip: '59601'
                      CompanyName: Big Sky Imports
                      customerId: 1324
                      CustomerNumber: '12345'
                      customerStatus: 1
                      FirstName: Janis
                      Identifiers:
                        - firstname
                        - email
                      LastName: Berzins
                      ShippingAddress1: 321 Big Sky Road
                      ShippingAddress2: ''
                      ShippingCity: Helena
                      ShippingCountry: US
                      ShippingState: MT
                      ShippingZip: '59601'
                    externalPaypointID: f743aed24a-10
                    Id: 578
                    LastFour: 4XXXXXX0003
                    Method: card
                    NetAmount: 1.5
                    OrderId: ''
                    ParentOrgName: Par
                    PaymentData:
                      AccountExp: '0330'
                      AccountType: visa
                      HolderName: Janis Berzins
                      MaskedAccount: 4XXXXXX0003
                      paymentDetails:
                        totalAmount: 100
                      StoredId: stored-id-123
                    PaymentTransId: 10-bfcd5a17861d4a8690ca53c00000X
                    PaypointDbaname: Global Factory LLC
                    PaypointEntryname: f743aed24a
                    PaypointLegalname: Global Factory LLC
                    Reason: Testing
                    ReasonCode: '00001'
                    ReferenceNumber: 10-bfcd5a17861d4a8690ca53c00000X
                    ReplyBy: '2023-03-02T15:36:49Z'
                    ScheduleReference: 0
                    Status: 3
                    Transaction:
                      BatchAmount: 0
                      Customer:
                        AdditionalData: null
                        BillingAddress1: 321 Big Sky Road
                        BillingAddress2: ''
                        BillingCity: Helena
                        BillingCountry: US
                        BillingEmail: janis.berzins@example.com
                        BillingPhone: 406-555-0123
                        BillingState: MT
                        BillingZip: '59601'
                        CompanyName: Big Sky Imports
                        customerId: 1324
                        CustomerNumber: '12345'
                        customerStatus: 1
                        FirstName: Janis
                        Identifiers:
                          - firstname
                          - email
                        LastName: Berzins
                        ShippingAddress1: 321 Big Sky Road
                        ShippingAddress2: ''
                        ShippingCity: Helena
                        ShippingCountry: US
                        ShippingState: MT
                        ShippingZip: '59601'
                      EntrypageId: 0
                      FeeAmount: 0.06
                      GatewayTransId: '8082800000'
                      Method: card
                      NetAmount: 1.5
                      Operation: Sale
                      OrderId: ''
                      OrgId: 0
                      PaymentData:
                        AccountExp: '0330'
                        AccountType: visa
                        HolderName: Lisandra Sosa
                        MaskedAccount: 4XXXXXX0003
                        paymentDetails:
                          currency: USD
                          serviceFee: 0.06
                          totalAmount: 1.56
                      PaymentTransId: 10-bfcd5a17861d4a8690ca53c00000X
                      PayorId: 0
                      PaypointId: 0
                      RefundId: 0
                      ResponseData:
                        authcode: '123456'
                        avsresponse: 'N'
                        avsresponse_text: No address or ZIP match only
                        cvvresponse: 'N'
                        cvvresponse_text: CVV2/CVC2 no match
                        orderid: 10-bfcd5a17861d4a8690ca53c00000X
                        response_code: '100'
                        response_code_text: Transaction was approved.
                        responsetext: SUCCESS
                        transactionid: '8082800000'
                      ReturnedId: 0
                      ScheduleReference: 0
                      SettlementStatus: 0
                      Source: api
                      splitCount: 0
                      TotalAmount: 1.56
                      TransactionEvents:
                        - EventTime: '2023-02-20T15:36:47Z'
                          TransEvent: created
                        - EventData: response=1&responsetext=SUCCESS&authcode=123456&transactionid=8082800000&avsresponse=N&cvvresponse=N&orderid=10-bfcd5a17861d4a8690ca53c00000X&type=sale&response_code=100
                          EventTime: '2023-02-20T15:36:49Z'
                          TransEvent: Approved
                      TransactionTime: '2023-02-20T15:36:47Z'
                      TransStatus: 1
                    TransactionTime: '2023-02-20T15:36:47Z'
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 1.56
                  totalNetAmount: 1.5
                  totalPages: 1
                  totalRecords: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/chargebacks/org/{orgId}:
    get:
      operationId: query_ListChargebacksOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListChargebacksOrg
      x-fern-request-name: ListChargebacksOrgRequest
      summary: Get list of chargebacks and returned transactions for an org
      description: Retrieve a list of chargebacks and returned transactions for an org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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> See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            **List of field names accepted:**

            - `chargebackDate` (gt, ge, lt, le, eq, ne)
            - `transId`  (ne, eq, ct, nct)
            - `method`   (in, nin, eq, ne)
            - `netAmount`  (gt, ge, lt, le, eq, ne)
            - `reasonCode`   (in, nin, eq, ne)
            - `reason`  (ct, nct, eq, ne)
            - `replyDate` (gt, ge, lt, le, eq, ne)
            - `caseNumber`  (ct, nct, eq, ne)
            - `status`   (in, nin, eq, ne)
            - `accountType`   (in, nin, eq, ne)
            - `payaccountLastfour`   (nct, ct)
            - `payaccountType`   (ne, eq, in, nin)
            - `customerFirstname`   (ct, nct, eq, ne)
            - `customerLastname`    (ct, nct, eq, ne)
            - `customerName`   (ct, nct)
            - `customerId`  (eq, ne)
            - `customerNumber`  (ct, nct, eq, ne)
            - `customerCompanyname`    (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity`    (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity`    (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId`  (eq) *mandatory when entry=org*
            - `paypointId`  (ne, eq)
            - `paypointLegal`  (ne, eq, ct, nct)
            - `paypointDba`  (ne, eq, ct, nct)
            - `orgName`  (ne, eq, ct, nct)
            - `additional-xxx`  (ne, eq, ct, nct) where xxx is the additional field name

            **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 separated by "|"
            - `nin` => not inside array separated by "|"

            **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: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryChargebacksResponse'
              example:
                Records:
                  - AccountType: 4XXXXXX0003
                    CaseNumber: '00001'
                    ChargebackDate: '2023-02-08T00:00:00Z'
                    CreatedAt: '2022-07-01T15:00:01Z'
                    externalPaypointID: Paypoint-100
                    Id: 578
                    LastFour: 4XXXXXX0003
                    Method: card
                    NetAmount: 1.5
                    OrderId: O-5140
                    pageidentifier: 'null'
                    ParentOrgName: PropertyManager Pro
                    PaymentData:
                      paymentDetails:
                        totalAmount: 100
                    PaymentTransId: 10-bfcd5a17861d4a8690ca53c142ca3810
                    PaypointDbaname: Sunshine Gutters
                    PaypointEntryname: d193cf9a46
                    PaypointLegalname: Sunshine Services, LLC
                    Reason: Testing
                    ReasonCode: '00001'
                    ReferenceNumber: 10-bfcd5a17861d4a8690ca53c142ca3810
                    ReplyBy: '2022-07-11T15:00:01Z'
                    Responses: Responses
                    ScheduleReference: 0
                    Status: 3
                    Transaction:
                      EntrypageId: 0
                      FeeAmount: 1
                      PayorId: 1551
                      PaypointId: 226
                      SettlementStatus: 2
                      splitCount: 0
                      TotalAmount: 30.22
                      TransStatus: 1
                    TransactionTime: '2024-01-15T09:30:00Z'
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 77.22
                  totalNetAmount: 77.22
                  totalPages: 2
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/customers/{entry}:
    get:
      operationId: query_ListCustomers
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListCustomers
      x-fern-request-name: ListCustomersRequest
      summary: Get list of customers for a paypoint
      description: Retrieves a list of customers for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more details.

            **List of Accepted Field Names:**

            - `createdDate` (gt, ge, lt, le, eq, ne)
            - `customernumber` (ne, eq, ct, nct)
            - `firstname` (ne, eq, ct, nct)
            - `lastname` (ne, eq, ct, nct)
            - `name` (ct, nct)
            - `address` (ne, eq, ct, nct)
            - `city` (ne, eq, ct, nct)
            - `country` (ne, eq, ct, nct)
            - `zip` (ne, eq, ct, nct)
            - `state` (ne, eq, ct, nct)
            - `shippingaddress` (ne, eq, ct, nct)
            - `shippingcity` (ne, eq, ct, nct)
            - `shippingcountry` (ne, eq, ct, nct)
            - `shippingzip` (ne, eq, ct, nct)
            - `shippingstate` (ne, eq, ct, nct)
            - `phone` (ne, eq, ct, nct)
            - `email` (ne, eq, ct, nct)
            - `company` (ne, eq, ct, nct)
            - `username` (ne, eq, ct, nct)
            - `balance` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
            - `orgId` (eq) *mandatory when entry=org*
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)

            **List of Accepted Comparisons:**

            - `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 separated by "|"
            - `nin` => not inside array separated by "|"

            **Accepted Parameters:**
            - `limitRecord`: Max number of records for query (default="20", "0" or negative value for all)
            - `fromRecord`: Initial record in query

            **Example Usage:**
            `balance(gt)=20` will return all records with a balance greater than 20.00.
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCustomerResponse'
              example:
                Records:
                  - Address: 1234 Bayou Road
                    Address1: Suite 2
                    Balance: 0
                    City: Lafayette
                    Company: Boudreaux's Shop
                    Country: US
                    Created: '2023-12-20T13:07:48Z'
                    customerId: 2876
                    customerNumber: '425436530000'
                    customerStatus: 0
                    customerSummary:
                      NumberofTransactions: 30
                      TotalAmountTransactions: 1500
                      TotalNetAmountTransactions: 1500
                    Email: thibodeaux.hebert@bayoumail.com
                    externalPaypointID: pay-10
                    Firstname: Thibodeaux
                    IdentifierFields:
                      - email
                    Lastname: Hebert
                    LastUpdated: '2023-12-20T13:07:48Z'
                    MFA: false
                    MFAMode: 0
                    ParentOrgName: SupplyPro
                    PaypointDbaname: Global Factory LLC
                    PaypointEntryname: 4872acb376a
                    PaypointLegalname: Global Factory LLC
                    Phone: (504) 823-4566
                    ShippingAddress: 1234 Bayou Road
                    ShippingAddress1: Suite 2
                    ShippingCity: Lafayette
                    ShippingCountry: US
                    ShippingState: LA
                    ShippingZip: '70501'
                    State: LA
                    TimeZone: 0
                    Zip: '70501'
                Summary:
                  pageIdentifier: XXXXXXXXXXXXXX
                  pageSize: 20
                  totalAmount: 0
                  totalNetAmount: 0
                  totalPages: 26
                  totalRecords: 510
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/customers/org/{orgId}:
    get:
      operationId: query_ListCustomersOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListCustomersOrg
      x-fern-request-name: ListCustomersOrgRequest
      summary: Get list of customers for an org
      description: Retrieves a list of customers for an org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more details.

            **List of Accepted Field Names:**

            - `createdDate` (gt, ge, lt, le, eq, ne)
            - `customernumber` (ne, eq, ct, nct)
            - `firstname` (ne, eq, ct, nct)
            - `lastname` (ne, eq, ct, nct)
            - `name` (ct, nct)
            - `address` (ne, eq, ct, nct)
            - `city` (ne, eq, ct, nct)
            - `country` (ne, eq, ct, nct)
            - `zip` (ne, eq, ct, nct)
            - `state` (ne, eq, ct, nct)
            - `shippingaddress` (ne, eq, ct, nct)
            - `shippingcity` (ne, eq, ct, nct)
            - `shippingcountry` (ne, eq, ct, nct)
            - `shippingzip` (ne, eq, ct, nct)
            - `shippingstate` (ne, eq, ct, nct)
            - `phone` (ne, eq, ct, nct)
            - `email` (ne, eq, ct, nct)
            - `company` (ne, eq, ct, nct)
            - `username` (ne, eq, ct, nct)
            - `balance` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
            - `orgId` (eq) *mandatory when entry=org*
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)

            **List of Accepted Comparisons:**

            - `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 separated by "|"
            - `nin` => not inside array separated by "|"

            **Accepted Parameters:**
            - `limitRecord`: Max number of records for query (default="20", "0" or negative value for all)
            - `fromRecord`: Initial record in query

            **Example Usage:**
            `balance(gt)=20` will return all records with a balance greater than 20.00.
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCustomerResponse'
              example:
                Records:
                  - Address: 1234 Bayou Road
                    Address1: Suite 2
                    Balance: 0
                    City: Lafayette
                    Company: Boudreaux's Shop
                    Country: US
                    Created: '2023-12-20T13:07:48Z'
                    customerId: 2876
                    customerNumber: '425436530000'
                    customerStatus: 0
                    customerSummary:
                      NumberofTransactions: 30
                      TotalAmountTransactions: 1500
                      TotalNetAmountTransactions: 1500
                    Email: thibodeaux.hebert@bayoumail.com
                    externalPaypointID: pay-10
                    Firstname: Thibodeaux
                    IdentifierFields:
                      - email
                    Lastname: Hebert
                    LastUpdated: '2023-12-20T13:07:48Z'
                    MFA: false
                    MFAMode: 0
                    ParentOrgName: SupplyPro
                    PaypointDbaname: Global Factory LLC
                    PaypointEntryname: 4872acb376a
                    PaypointLegalname: Global Factory LLC
                    Phone: (504) 823-4566
                    ShippingAddress: 1234 Bayou Road
                    ShippingAddress1: Suite 2
                    ShippingCity: Lafayette
                    ShippingCountry: US
                    ShippingState: LA
                    ShippingZip: '70501'
                    State: LA
                    TimeZone: 0
                    Zip: '70501'
                Summary:
                  pageIdentifier: XXXXXXXXXXXXXX
                  pageSize: 20
                  totalAmount: 0
                  totalNetAmount: 0
                  totalPages: 26
                  totalRecords: 510
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/devices/{entry}:
    get:
      operationId: query_ListDevices
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListDevices
      x-fern-request-name: ListDevicesRequest
      summary: Get list of devices for a paypoint
      description: Returns a list of cloud devices for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 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
          example: 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/devices/8cfec329267?parameters=status=1&limitRecord=20

              should become:

              --url https://api-sandbox.payabli.com/api/Query/devices/8cfec329267?status=1&limitRecord=20
            </Info>

            See [Filters and Conditions
            Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
            for more information.

            **List of field names accepted:**


            - `deviceId` (eq, ne, ct, nct)

            - `serialNumber` (eq, ne, ct, nct)

            - `friendlyName` (eq, ne, ct, nct)

            - `description` (eq, ne, ct, nct)

            - `model` (eq, ne, ct, nct)

            - `make` (eq, ne, ct, nct)

            - `macAddress` (eq, ne, ct, nct)

            - `registrationCode` (eq, ne, ct, nct)

            - `status` (eq, ne, in, nin)

            - `deviceType` (eq, ne, in, nin)

            - `deviceOs` (eq, ne, in, nin)

            - `activationAttempts` (eq, ne, gt, ge, lt, le)

            - `createdDate` (gt, ge, lt, le, eq, ne)

            - `updatedDate` (gt, ge, lt, le, eq, ne)

            - `lastHealthCheck` (gt, ge, lt, le, eq, ne)

            - `activationExpiry` (gt, ge, lt, le, eq, ne). This filter corresponds to the `activationCodeExpiry` response field.

            - `paypointId` (eq, ne)

            - `paypointDba` (eq, ne, ct, nct)

            - `paypointLegal` (eq, ne, ct, nct)

            - `paypointEntry` (eq, ne, ct, nct)

            - `externalPaypointId` (eq, ne, ct, nct)

            - `parentOrgId` (eq, ne)

            - `parentOrgName` (eq, ne, ct, nct)


            **List of comparison operators accepted:**

            - `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
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(createdAt)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryDeviceResponse'
              example:
                Summary:
                  pageIdentifier: null
                  pageSize: 20
                  totalAmount: 0
                  totalNetAmount: 0
                  totalPages: 2
                  totalRecords: 28
                Records:
                  - deviceId: DEV-A1B2C3D4
                    idCloud: 142
                    description: Front Counter Terminal
                    serialNumber: SN-90210-XR
                    friendlyName: Front Counter Terminal
                    make: Ingenico
                    model: LK2500
                    deviceType: 1
                    deviceStatus: 1
                    deviceOs: null
                    macAddress: 1A2B3C4D5E6F
                    lastHealthCheck: '2026-04-09T14:49:42Z'
                    registrationCode: REG-A1B2C3D4
                    activationAttempts: 0
                    activationCodeExpiry: '2026-04-09T14:49:42Z'
                    createdAt: '2026-04-09T01:14:37Z'
                    updatedAt: '2026-04-09T14:49:42Z'
                    paypointId: 12345
                    paypointDba: Gruzya Adventure Outfitters
                    paypointLegal: Gruzya Adventure Outfitters, LLC
                    paypointEntry: 8cfec329267
                    externalPaypointId: GRUZYA-01
                    parentOrgId: 100
                    parentOrgName: Example Corp
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/devices/org/{orgId}:
    get:
      operationId: query_ListDevicesOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListDevicesOrg
      x-fern-request-name: ListDevicesOrgRequest
      summary: Get list of devices for an org
      description: Returns a list of cloud devices for a single organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 100
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 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
          example: 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/devices/org/236?parameters=status=1&limitRecord=20

              should become:

              --url https://api-sandbox.payabli.com/api/Query/devices/org/236?status=1&limitRecord=20
            </Info>

            See [Filters and Conditions
            Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
            for more information.

            **List of field names accepted:**


            - `deviceId` (eq, ne, ct, nct)

            - `serialNumber` (eq, ne, ct, nct)

            - `friendlyName` (eq, ne, ct, nct)

            - `description` (eq, ne, ct, nct)

            - `model` (eq, ne, ct, nct)

            - `make` (eq, ne, ct, nct)

            - `macAddress` (eq, ne, ct, nct)

            - `registrationCode` (eq, ne, ct, nct)

            - `status` (eq, ne, in, nin)

            - `deviceType` (eq, ne, in, nin)

            - `deviceOs` (eq, ne, in, nin)

            - `activationAttempts` (eq, ne, gt, ge, lt, le)

            - `createdDate` (gt, ge, lt, le, eq, ne)

            - `updatedDate` (gt, ge, lt, le, eq, ne)

            - `lastHealthCheck` (gt, ge, lt, le, eq, ne)

            - `activationExpiry` (gt, ge, lt, le, eq, ne). This filter corresponds to the `activationCodeExpiry` response field.

            - `paypointId` (eq, ne)

            - `paypointDba` (eq, ne, ct, nct)

            - `paypointLegal` (eq, ne, ct, nct)

            - `paypointEntry` (eq, ne, ct, nct)

            - `externalPaypointId` (eq, ne, ct, nct)

            - `parentOrgId` (eq, ne)

            - `parentOrgName` (eq, ne, ct, nct)


            **List of comparison operators accepted:**

            - `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
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(createdAt)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryDeviceResponse'
              example:
                Summary:
                  pageIdentifier: null
                  pageSize: 20
                  totalAmount: 0
                  totalNetAmount: 0
                  totalPages: 2
                  totalRecords: 28
                Records:
                  - deviceId: DEV-A1B2C3D4
                    idCloud: 142
                    description: Front Counter Terminal
                    serialNumber: SN-90210-XR
                    friendlyName: Front Counter Terminal
                    make: Ingenico
                    model: LK2500
                    deviceType: 1
                    deviceStatus: 1
                    deviceOs: null
                    macAddress: 1A2B3C4D5E6F
                    lastHealthCheck: '2026-04-09T14:49:42Z'
                    registrationCode: REG-A1B2C3D4
                    activationAttempts: 0
                    activationCodeExpiry: '2026-04-09T14:49:42Z'
                    createdAt: '2026-04-09T01:14:37Z'
                    updatedAt: '2026-04-09T14:49:42Z'
                    paypointId: 12345
                    paypointDba: Gruzya Adventure Outfitters
                    paypointLegal: Gruzya Adventure Outfitters, LLC
                    paypointEntry: 8cfec329267
                    externalPaypointId: GRUZYA-01
                    parentOrgId: 100
                    parentOrgName: Example Corp
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/notificationReports/{entry}:
    get:
      operationId: query_ListNotificationReports
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListNotificationReports
      x-fern-request-name: ListNotificationReportsRequest
      summary: Get list of reports generated in last 60 days for entrypoint
      description: Returns a list of all reports generated in the last 60 days for a single entrypoint. Use filters to limit results.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - 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
          example: 251
        - 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
          example: 0
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `reportName` (ct, nct, eq, ne)
            - `createdAt` (gt, ge, lt, le, eq, ne)

            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: reportName(ct)=tr  return all records containing the string "tr"
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseNotificationReports'
              example:
                Records:
                  - createdAt: '2024-02-20T01:48:04Z'
                    id: 4881
                    isDownloadable: true
                    reportName: Transaction-2024-02-20-000000-0-2.csv
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 0
                  totalNetAmount: 0
                  totalPages: 1
                  totalRecords: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/notificationReports/org/{orgId}:
    get:
      operationId: query_ListNotificationReportsOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListNotificationReportsOrg
      x-fern-request-name: ListNotificationReportsOrgRequest
      summary: Get list of reports generated in last 60 days for organization
      description: Returns a list of all reports generated in the last 60 days for an organization. Use filters to limit results.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - 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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `reportName` (ct, nct, eq, ne)
            - `createdAt` (gt, ge, lt, le, eq, ne)

            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: reportName(ct)=tr  return all records containing the string "tr"
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseNotificationReports'
              example:
                Records:
                  - createdAt: '2024-02-20T01:48:04Z'
                    id: 4881
                    isDownloadable: true
                    reportName: Transaction-2024-02-20-000000-0-2.csv
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 0
                  totalNetAmount: 0
                  totalPages: 1
                  totalRecords: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/notifications/{entry}:
    get:
      operationId: query_ListNotifications
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListNotifications
      x-fern-request-name: ListNotificationsRequest
      summary: Get list of notifications for an entrypoint
      description: Returns a list of notifications for an entrypoint. Use filters to limit results.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - 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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `frequency` (in, nin,ne, eq)
            - `method` (in, nin, eq, ne)
            - `event` (in, nin, eq, ne)
            - `target` (ct, nct, eq, ne)
            - `status` (eq, ne)

            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: totalAmount(gt)=20  return all records with totalAmount greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseNotifications'
              example:
                Records:
                  - content:
                      eventType: ReceivedChargeBack
                      timeZone: 0
                    createdAt: '2022-06-07T05:00:00Z'
                    frequency: untilcancelled
                    lastUpdated: '2022-06-07T05:00:00Z'
                    method: email
                    notificationId: 88976
                    ownerId: 123
                    ownerName: Pilgrim Planner
                    ownerType: 2
                    source: api
                    status: 1
                    target: example@example.com
                  - content:
                      eventType: ReceivedAchReturn
                      timeZone: 0
                    createdAt: '2022-06-07T05:00:00Z'
                    frequency: untilcancelled
                    lastUpdated: '2022-06-07T05:00:00Z'
                    method: email
                    notificationId: 88975
                    ownerId: 123
                    ownerName: Pilgrim Planner
                    ownerType: 2
                    source: api
                    status: 1
                    target: example@example.com
                Summary:
                  pageSize: 20
                  totalAmount: 0
                  totalNetAmount: 0
                  totalPages: 1
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/notifications/org/{orgId}:
    get:
      operationId: query_ListNotificationsOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListNotificationsOrg
      x-fern-request-name: ListNotificationsOrgRequest
      summary: Get list of notifications for organization
      description: Return a list of notifications for an organization. Use filters to limit results.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - 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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `frequency` (in, nin,ne, eq)
            - `method` (in, nin, eq, ne)
            - `event` (in, nin, eq, ne)
            - `target` (ct, nct, eq, ne)
            - `status` (eq, ne)

            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: totalAmount(gt)=20  return all records with totalAmount greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseNotifications'
              example:
                Records:
                  - content:
                      eventType: ReceivedChargeBack
                      timeZone: 0
                    createdAt: '2022-06-07T05:00:00Z'
                    frequency: untilcancelled
                    lastUpdated: '2022-06-07T05:00:00Z'
                    method: email
                    notificationId: 88976
                    ownerId: 123
                    ownerName: Pilgrim Planner
                    ownerType: 2
                    source: api
                    status: 1
                    target: example@example.com
                  - content:
                      eventType: ReceivedAchReturn
                      timeZone: 0
                    createdAt: '2022-06-07T05:00:00Z'
                    frequency: untilcancelled
                    lastUpdated: '2022-06-07T05:00:00Z'
                    method: email
                    notificationId: 88975
                    ownerId: 123
                    ownerName: Pilgrim Planner
                    ownerType: 2
                    source: api
                    status: 1
                    target: example@example.com
                Summary:
                  pageSize: 20
                  totalAmount: 0
                  totalNetAmount: 0
                  totalPages: 1
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/organizations/{orgId}:
    get:
      operationId: query_ListOrganizations
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListOrganizations
      x-fern-request-name: ListOrganizationsRequest
      summary: Get list of organizations for a parent
      description: Retrieves a list of an organization's suborganizations and their full details such as orgId, users, and settings. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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)
            - `startDate` (gt, ge, lt, le, eq, ne)
            - `dbaname`  (ct, nct)
            - `legalname`  (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)
            - `orgParentname`  (ct, nct)
            - `boardingId` (eq, ne)
            - `entryName`  (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
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrganizationsResponse'
              example:
                Records:
                  - services:
                      - {}
                    contacts:
                      - {}
                    createdAt: '2022-07-01T15:00:01Z'
                    hasBilling: true
                    hasResidual: true
                    idOrg: 123
                    isRoot: false
                    orgAddress: 123 Walnut Street
                    orgCity: Johnson City
                    orgCountry: US
                    orgEntryName: pilgrim-planner
                    orgId: I-123
                    orgName: Pilgrim Planner
                    orgParentId: 236
                    orgParentName: PropertyManager Pro
                    orgState: TN
                    orgTimezone: -5
                    orgType: 0
                    orgWebsite: www.pilgrimageplanner.com
                    orgZip: orgZip
                    recipientEmailNotification: true
                    replyToEmail: example@email.com
                    resumable: false
                    users:
                      - createdAt: '2022-07-01T15:00:01Z'
                        UsrMFAMode: 0
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 77.22
                  totalNetAmount: 77.22
                  totalPages: 2
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/payouts/{entry}:
    get:
      operationId: query_ListPayout
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListPayout
      x-fern-request-name: ListPayoutRequest
      summary: Get list of money out transactions for paypoint
      description: Retrieves a list of money out transactions (payouts) for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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:

              - `status` (in, nin, eq, ne)
              - `transactionDate` (gt, ge, lt, le, eq, ne)
              - `billNumber` (ct, nct)
              - `vendorNumber` (ct, nct, eq, ne)
              - `vendorName` (ct, nct, eq, ne)
              - `paymentMethod` (ct, nct, eq, ne, in, nin)
              - `paymentId` (ct, nct, eq, ne)
              - `parentOrgId` (ne, eq, nin, in)
              - `batchNumber` (ct, nct, eq, ne)
              - `totalAmount` (gt, ge, lt, le, eq, ne)
              - `paypointLegal` (ne, eq, ct, nct)
              - `paypointDba` (ne, eq, ct, nct)
              - `accountId` (ne, eq, ct, nct)
              - `orgName` (ne, eq, ct, nct)
              - `externalPaypointID` (ct, nct, eq, ne)
              - `paypointId` (eq, ne)
              - `vendorId` (eq, ne)
              - `vendorEIN` (ct, nct, eq, ne)
              - `vendorPhone` (ct, nct, eq, ne)
              - `vendorEmail` (ct, nct, eq, ne)
              - `vendorAddress` (ct, nct, eq, ne)
              - `vendorCity` (ct, nct, eq, ne)
              - `vendorState` (ct, nct, eq, ne)
              - `vendorCountry` (ct, nct, eq, ne)
              - `vendorZip` (ct, nct, eq, ne)
              - `vendorMCC` (ct, nct, eq, ne)
              - `vendorLocationCode` (ct, nct, eq, ne)
              - `vendorCustomField1` (ct, nct, eq, ne)
              - `vendorCustomField2` (ct, nct, eq, ne)
              - `comments` (ct, nct)
              - `payaccountCurrency` (ne, eq, in, nin)
              - `remitAddress` (ct, nct)
              - `source` (ct, nct, eq, ne)
              - `updatedOn` (gt, ge, lt, le, eq, ne)
              - `feeAmount` (gt, ge, lt, le, eq, ne)
              - `lotNumber` (ct, nct)
              - `customerVendorAccount` (ct, nct, eq, ne)
              - `batchId` (eq, ne)
              - `AchTraceNumber` (eq, ne)
              - `payoutProgram`(eq, ne) the options are `managed` or `odp`. For example, `payoutProgram(eq)=managed` returns all records with a `payoutProgram` equal to `managed`.

              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 separated by \"|\"
              - nin => not inside array separated by \"|\"

              List of parameters accepted:

              - limitRecord : max number of records for query (default=\"20\", \"0\" or negative value for all)
              - fromRecord : initial record in query
              - sortBy : indicate field name and direction to sort the results

              Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00

              Example: `sortBy=desc(netamount)` returns all records sorted by `netAmount` descending
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryPayoutTransaction'
              example:
                Records:
                  - BatchNumber: BT-2024321
                    Bills:
                      - {}
                    CardToken: CardToken
                    CheckNumber: '12345'
                    Comments: Deposit for materials
                    CreatedAt: '2022-07-01T15:00:01Z'
                    EntryName: d193cf9a46
                    Events:
                      - {}
                    externalPaypointID: Paypoint-100
                    FeeAmount: 10.25
                    Gateway: TSYS
                    IdOut: 236
                    LastUpdated: '2022-07-01T15:00:01Z'
                    NetAmount: 3762.87
                    ParentOrgName: PropertyManager Pro
                    PaymentData:
                      paymentDetails:
                        totalAmount: 100
                    PaymentId: '12345678910'
                    PaymentMethod: ach
                    PaymentStatus: Processed
                    PaypointDbaname: Sunshine Gutters
                    PaypointLegalname: Sunshine Services, LLC
                    Source: api
                    Status: 1
                    TotalAmount: 110.25
                    Vendor:
                      additionalData:
                        key1:
                          key: value
                        key2:
                          key: value
                        key3:
                          key: value
                      CreatedDate: '2022-07-01T15:00:01Z'
                Summary:
                  totalPages: 391
                  totalRecords: 7803
                  totalAmount: 21435.95
                  totalNetAmount: 21435.95
                  totalPaid: 1
                  totalPaidAmount: 4
                  totalCanceled: 1743
                  totalCanceledAmount: 4515
                  totalCaptured: 138
                  totalCapturedAmount: 542
                  totalAuthorized: 4139
                  totalAuthorizedAmount: 11712.35
                  totalProcessing: 1780
                  totalProcessingAmount: 4660.6
                  totalOpen: 2
                  totalOpenAmount: 2
                  totalOnHold: 0
                  totalOnHoldAmount: 0
                  pageSize: 20
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/payouts/org/{orgId}:
    get:
      operationId: query_ListPayoutOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListPayoutOrg
      x-fern-request-name: ListPayoutOrgRequest
      summary: Get list of money out transactions for organization
      description: Retrieves a list of money out transactions (payouts) for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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:

              - `status` (in, nin, eq, ne)
              - `transactionDate` (gt, ge, lt, le, eq, ne)
              - `billNumber` (ct, nct)
              - `vendorNumber` (ct, nct, eq, ne)
              - `vendorName` (ct, nct, eq, ne)
              - `parentOrgId` (ne, eq, nin, in)
              - `paymentMethod` (ct, nct, eq, ne, in, nin)
              - `paymentId` (ct, nct, eq, ne)
              - `batchNumber` (ct, nct, eq, ne)
              - `totalAmount` (gt, ge, lt, le, eq, ne)
              - `paypointLegal` (ne, eq, ct, nct)
              - `paypointDba` (ne, eq, ct, nct)
              - `accountId` (ne, eq, ct, nct)
              - `orgName` (ne, eq, ct, nct)
              - `externalPaypointID` (ct, nct, eq, ne)
              - `paypointId` (eq, ne)
              - `vendorId` (eq, ne)
              - `vendorEIN` (ct, nct, eq, ne)
              - `vendorPhone` (ct, nct, eq, ne)
              - `vendorEmail` (ct, nct, eq, ne)
              - `vendorAddress` (ct, nct, eq, ne)
              - `vendorCity` (ct, nct, eq, ne)
              - `vendorState` (ct, nct, eq, ne)
              - `vendorCountry` (ct, nct, eq, ne)
              - `vendorZip` (ct, nct, eq, ne)
              - `vendorMCC` (ct, nct, eq, ne)
              - `vendorLocationCode` (ct, nct, eq, ne)
              - `vendorCustomField1` (ct, nct, eq, ne)
              - `vendorCustomField2` (ct, nct, eq, ne)
              - `comments` (ct, nct)
              - `payaccountCurrency` (ne, eq, in, nin)
              - `remitAddress` (ct, nct)
              - `source` (ct, nct, eq, ne)
              - `updatedOn` (gt, ge, lt, le, eq, ne)
              - `feeAmount` (gt, ge, lt, le, eq, ne)
              - `lotNumber` (ct, nct)
              - `customerVendorAccount` (ct, nct, eq, ne)
              - `batchId` (eq, ne)
              - `AchTraceNumber` (eq, ne)
              - `payoutProgram`(eq, ne) the options are `managed` or `odp`. For example, `payoutProgram(eq)=managed` returns all records with a `payoutProgram` equal to `managed`.

              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 separated by \"|\"
              - nin => not inside array separated by \"|\"

              List of parameters accepted:

              - limitRecord : max number of records for query (default=\"20\", \"0\" or negative value for all)
              - fromRecord : initial record in query
              - sortBy : indicate field name and direction to sort the results

              Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00

              Example: `sortBy=desc(netamount)` returns all records sorted by `netAmount` descending
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryPayoutTransaction'
              example:
                Records:
                  - BatchNumber: BT-2024321
                    Bills:
                      - {}
                    CardToken: CardToken
                    CheckNumber: '12345'
                    Comments: Deposit for materials
                    CreatedAt: '2022-07-01T15:00:01Z'
                    EntryName: d193cf9a46
                    Events:
                      - {}
                    externalPaypointID: Paypoint-100
                    FeeAmount: 10.25
                    Gateway: TSYS
                    IdOut: 236
                    LastUpdated: '2022-07-01T15:00:01Z'
                    NetAmount: 3762.87
                    ParentOrgName: PropertyManager Pro
                    PaymentData:
                      paymentDetails:
                        totalAmount: 100
                    PaymentId: '12345678910'
                    PaymentMethod: ach
                    PaymentStatus: Processed
                    PaypointDbaname: Sunshine Gutters
                    PaypointLegalname: Sunshine Services, LLC
                    Source: api
                    Status: 1
                    TotalAmount: 110.25
                    Vendor:
                      additionalData:
                        key1:
                          key: value
                        key2:
                          key: value
                        key3:
                          key: value
                      CreatedDate: '2022-07-01T15:00:01Z'
                Summary:
                  totalPages: 391
                  totalRecords: 7803
                  totalAmount: 21435.95
                  totalNetAmount: 21435.95
                  totalPaid: 1
                  totalPaidAmount: 4
                  totalCanceled: 1743
                  totalCanceledAmount: 4515
                  totalCaptured: 138
                  totalCapturedAmount: 542
                  totalAuthorized: 4139
                  totalAuthorizedAmount: 11712.35
                  totalProcessing: 1780
                  totalProcessingAmount: 4660.6
                  totalOpen: 2
                  totalOpenAmount: 2
                  totalOnHold: 0
                  totalOnHoldAmount: 0
                  pageSize: 20
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/paypoints/{orgId}:
    get:
      operationId: query_ListPaypoints
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListPaypoints
      x-fern-request-name: ListPaypointsRequest
      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.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryEntrypointResponse'
              example:
                Records:
                  - AverageMonthlyVolume: 1000
                    AverageTicketAmount: 1000
                    BAddress1: 123 Walnut Street
                    BAddress2: Suite 103
                    BankData:
                      - bankAccountFunction: 0
                        bankAccountHolderName: Gruzya Adventure Outfitters LLC
                        nickname: Business Checking 1234
                    BCity: New Vegas
                    BCountry: US
                    BFax: '5551234567'
                    BinPerson: 60
                    BinPhone: 20
                    BinWeb: 20
                    BoardingId: 340
                    BPhone: '5551234567'
                    BStartdate: 01/01/1990
                    BState: FL
                    BSummary: Brick and mortar store that sells office supplies
                    BTimeZone: -5
                    BZip: '33000'
                    ContactData:
                      - {}
                    CreatedAt: '2022-07-01T15:00:01Z'
                    DbaName: Sunshine Gutters
                    DocumentsRef: DocumentsRef
                    Ein: '123456789'
                    EntryPoints:
                      - {}
                    externalPaypointID: Paypoint-100
                    ExternalProcessorInformation: '[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]'
                    HighTicketAmount: 1000
                    IdPaypoint: 1000000
                    LastModified: '2022-07-01T15:00:01Z'
                    LegalName: Sunshine Services, LLC
                    License: 2222222FFG
                    LicenseState: CA
                    MAddress1: 123 Walnut Street
                    MAddress2: STE 900
                    Mccid: Mccid
                    MCity: Johnson City
                    MCountry: US
                    MState: TN
                    MZip: '37615'
                    OrgId: 123
                    OrgParentName: PropertyManager Pro
                    OwnerData:
                      - {}
                    OwnType: Limited Liability Company
                    PaypointStatus: 1
                    SalesCode: SalesCode
                    Taxfillname: Sunshine LLC
                    TemplateId: 22
                    WebsiteAddress: www.example.com
                    Whencharged: When Service Provided
                    Whendelivered: 0-7 Days
                    Whenprovided: 30 Days or Less
                    Whenrefund: Exchange Only
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 77.22
                  totalNetAmount: 77.22
                  totalPages: 2
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/settlements/{entry}:
    get:
      operationId: query_ListSettlements
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListSettlements
      x-fern-request-name: ListSettlementsRequest
      summary: Get list of settled transactions for a paypoint
      description: Retrieve a list of settled transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.

            **List of field names accepted:**

            - `settlementDate` (gt, ge, lt, le, eq, ne)
            - `depositDate` (gt, ge, lt, le, eq, ne)
            - `transId`  (ne, eq, ct, nct)
            - `gatewayTransId`  (ne, eq, ct, nct)
            - `method`   (in, nin, eq, ne)
            - `settledAmount`  (gt, ge, lt, le, eq, ne)
            - `operation`    (in, nin, eq, ne)
            - `source`   (in, nin, eq, ne)
            - `batchNumber`  (ct, nct, eq, ne)
            - `payaccountLastfour`   (nct, ct)
            - `payaccountType`   (ne, eq, in, nin)
            - `customerFirstname`   (ct, nct, eq, ne)
            - `customerLastname`    (ct, nct, eq, ne)
            - `customerName`   (ct, nct)
            - `customerId`  (eq, ne)
            - `customerNumber`  (ct, nct, eq, ne)
            - `customerCompanyname`    (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity`    (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity`    (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId`  (eq) *mandatory when entry=org*
            - `isHold` (eq, ne)
            - `paypointId`  (ne, eq)
            - `paypointLegal`  (ne, eq, ct, nct)
            - `paypointDba`  (ne, eq, ct, nct)
            - `orgName`  (ne, eq, ct, nct)
            - `batchId` (ct, nct, eq, neq)
            - `additional-xxx`  (ne, eq, ct, nct) where xxx is the additional field name

            **List of comparison accepted:**
            - `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 separated by "|"
            - `nin` => not inside array separated by "|"

            **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: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00.
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseSettlements'
              example:
                Records:
                  - BatchAmount: 32
                    BatchNumber: batch-100-20-2024
                    Category: auth
                    CreatedAt: '2024-11-19T15:58:01Z'
                    Customer:
                      AdditionalData: null
                      BillingAddress1: 100 Golden Ridge Drive
                      BillingAddress2: STE 100
                      BillingCity: Mendota
                      BillingCountry: US
                      BillingEmail: lydia@example.com
                      BillingPhone: '+12345678'
                      BillingState: VA
                      BillingZip: '20147'
                      customerId: 2707
                      CustomerNumber: '901102'
                      customerStatus: 1
                      FirstName: Lydia
                      LastName: Marshall
                    ExpectedDepositDate: '2024-11-22T00:00:00Z'
                    GatewayTransId: TRN_XXXXX
                    Id: 25048
                    isHold: 0
                    MaskedAccount: 1XXXXXX5678
                    Method: ach
                    NetAmount: 2
                    Operation: Sale
                    OrderId: ''
                    ParentOrgName: Pilgrim Planner
                    PaymentData:
                      AccountType: Checking
                      HolderName: Lydia Marshall
                      MaskedAccount: 1XXXXXX5678
                      paymentDetails:
                        categories:
                          - amount: 1000
                            label: Deposit
                        currency: USD
                        serviceFee: 0
                        splitFunding:
                          - {}
                        totalAmount: 2
                    PaymentTransId: 245-9e4072eef77e45979ea0e49f680000X
                    PaymentTransStatus: 1
                    PaypointDbaname: Gruzya Adventure Outfitters, LLC
                    PaypointEntryname: 7f1a3816XX
                    PaypointLegalname: Gruzya Adventure Outfitters, LLC
                    ResponseData:
                      authcode: ' '
                      avsresponse: ' '
                      avsresponse_text: ''
                      cvvresponse: ' '
                      cvvresponse_text: ' '
                      emv_auth_response_data: ' '
                      orderid: null
                      response: Success
                      response_code: '100'
                      response_code_text: Transaction was approved.
                      responsetext: CAPTURED
                      resultCode: A0000
                      resultCodeText: Approved
                      transactionid: TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0
                    ScheduleReference: 0
                    SettledAmount: 0.5
                    SettlementDate: '2024-11-20T00:00:00Z'
                    Source: api
                    Status: 1
                    TransactionEvents:
                      - EventTime: '2024-11-19T15:57:40Z'
                        TransEvent: Created
                      - EventData:
                          account_id: TRA_XXXXX
                          account_name: '123456'
                          action:
                            app_id: XXXXX
                            app_name: PayAbli
                            id: ACT_XXXXX
                            result_code: SUCCESS
                            time_created: '2024-11-19T20:58:01.583Z'
                            type: AUTHORIZE
                          amount: '200'
                          batch_id: ''
                          capture_mode: AUTO
                          channel: CNP
                          country: US
                          currency: USD
                          fees:
                            amount: '0'
                            rate: '0.00'
                            total_amount: '0'
                          id: TRN_XXXXX
                          merchant_amount: '200'
                          merchant_id: MER_XXXXX
                          merchant_name: Henriette97
                          order:
                            reference: ''
                          payment_method:
                            bank_transfer:
                              account_type: CHECKING
                              bank:
                                name: ''
                              masked_account_number_last4: XXXX5678
                            entry_mode: ECOM
                            message: Success
                            narrative: Lydia Marshall
                            result: '00'
                          reference: 245-XXXXX
                          status: CAPTURED
                          time_created: '2024-11-19T20:58:01.583Z'
                          type: SALE
                        EventTime: '2024-11-19T20:58:01Z'
                        TransEvent: Approved
                      - EventTime: '2024-11-20T03:05:10Z'
                        TransEvent: ClosedBatch
                    TransactionTime: '2024-11-19T15:58:01Z'
                    TransMethod: ach
                    Type: credit
                Summary:
                  heldAmount: 3.7
                  pageSize: 0
                  refunds: -3521.85
                  serviceFees: 852.48
                  totalAmount: 61645.74
                  totalNetAmount: 61645.74
                  totalPages: 21872
                  totalRecords: 21872
                  transferAmount: 0
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/settlements/org/{orgId}:
    get:
      operationId: query_ListSettlementsOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListSettlementsOrg
      x-fern-request-name: ListSettlementsOrgRequest
      summary: Get list of settled transactions for an org
      description: Retrieve a list of settled transactions for an organization. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.

            **List of field names accepted:**

            - `settlementDate` (gt, ge, lt, le, eq, ne)
            - `depositDate` (gt, ge, lt, le, eq, ne)
            - `transId`  (ne, eq, ct, nct)
            - `gatewayTransId`  (ne, eq, ct, nct)
            - `method`   (in, nin, eq, ne)
            - `settledAmount`  (gt, ge, lt, le, eq, ne)
            - `operation`    (in, nin, eq, ne)
            - `source`   (in, nin, eq, ne)
            - `batchNumber`  (ct, nct, eq, ne)
            - `payaccountLastfour`   (nct, ct)
            - `payaccountType`   (ne, eq, in, nin)
            - `customerFirstname`   (ct, nct, eq, ne)
            - `customerLastname`    (ct, nct, eq, ne)
            - `customerName`   (ct, nct)
            - `customerId`  (eq, ne)
            - `customerNumber`  (ct, nct, eq, ne)
            - `customerCompanyname`    (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity`    (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity`    (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId`  (eq) *mandatory when entry=org*
            - `isHold` (eq, ne)
            - `paypointId`  (ne, eq)
            - `paypointLegal`  (ne, eq, ct, nct)
            - `paypointDba`  (ne, eq, ct, nct)
            - `orgName`  (ne, eq, ct, nct)
            - `batchId` (ct, nct, eq, neq)
            - `additional-xxx`  (ne, eq, ct, nct) where xxx is the additional field name

            **List of comparison accepted:**
            - `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 separated by "|"
            - `nin` => not inside array separated by "|"

            **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: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00.
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseSettlements'
              example:
                Records:
                  - BatchAmount: 32
                    BatchNumber: batch-100-20-2024
                    Category: auth
                    CreatedAt: '2024-11-19T15:58:01Z'
                    Customer:
                      AdditionalData: null
                      BillingAddress1: 100 Golden Ridge Drive
                      BillingAddress2: STE 100
                      BillingCity: Mendota
                      BillingCountry: US
                      BillingEmail: lydia@example.com
                      BillingPhone: '+12345678'
                      BillingState: VA
                      BillingZip: '20147'
                      customerId: 2707
                      CustomerNumber: '901102'
                      customerStatus: 1
                      FirstName: Lydia
                      LastName: Marshall
                    ExpectedDepositDate: '2024-11-22T00:00:00Z'
                    GatewayTransId: TRN_XXXXX
                    Id: 25048
                    isHold: 0
                    MaskedAccount: 1XXXXXX5678
                    Method: ach
                    NetAmount: 2
                    Operation: Sale
                    OrderId: ''
                    ParentOrgName: Pilgrim Planner
                    PaymentData:
                      AccountType: Checking
                      HolderName: Lydia Marshall
                      MaskedAccount: 1XXXXXX5678
                      paymentDetails:
                        categories:
                          - amount: 1000
                            label: Deposit
                        currency: USD
                        serviceFee: 0
                        splitFunding:
                          - {}
                        totalAmount: 2
                    PaymentTransId: 245-9e4072eef77e45979ea0e49f680000X
                    PaymentTransStatus: 1
                    PaypointDbaname: Gruzya Adventure Outfitters, LLC
                    PaypointEntryname: 7f1a3816XX
                    PaypointLegalname: Gruzya Adventure Outfitters, LLC
                    ResponseData:
                      authcode: ' '
                      avsresponse: ' '
                      avsresponse_text: ''
                      cvvresponse: ' '
                      cvvresponse_text: ' '
                      emv_auth_response_data: ' '
                      orderid: null
                      response: Success
                      response_code: '100'
                      response_code_text: Transaction was approved.
                      responsetext: CAPTURED
                      resultCode: A0000
                      resultCodeText: Approved
                      transactionid: TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0
                    ScheduleReference: 0
                    SettledAmount: 0.5
                    SettlementDate: '2024-11-20T00:00:00Z'
                    Source: api
                    Status: 1
                    TransactionEvents:
                      - EventTime: '2024-11-19T15:57:40Z'
                        TransEvent: Created
                      - EventData:
                          account_id: TRA_XXXXX
                          account_name: '123456'
                          action:
                            app_id: XXXXX
                            app_name: PayAbli
                            id: ACT_XXXXX
                            result_code: SUCCESS
                            time_created: '2024-11-19T20:58:01.583Z'
                            type: AUTHORIZE
                          amount: '200'
                          batch_id: ''
                          capture_mode: AUTO
                          channel: CNP
                          country: US
                          currency: USD
                          fees:
                            amount: '0'
                            rate: '0.00'
                            total_amount: '0'
                          id: TRN_XXXXX
                          merchant_amount: '200'
                          merchant_id: MER_XXXXX
                          merchant_name: Henriette97
                          order:
                            reference: ''
                          payment_method:
                            bank_transfer:
                              account_type: CHECKING
                              bank:
                                name: ''
                              masked_account_number_last4: XXXX5678
                            entry_mode: ECOM
                            message: Success
                            narrative: Lydia Marshall
                            result: '00'
                          reference: 245-XXXXX
                          status: CAPTURED
                          time_created: '2024-11-19T20:58:01.583Z'
                          type: SALE
                        EventTime: '2024-11-19T20:58:01Z'
                        TransEvent: Approved
                      - EventTime: '2024-11-20T03:05:10Z'
                        TransEvent: ClosedBatch
                    TransactionTime: '2024-11-19T15:58:01Z'
                    TransMethod: ach
                    Type: credit
                Summary:
                  heldAmount: 3.7
                  pageSize: 0
                  refunds: -3521.85
                  serviceFees: 852.48
                  totalAmount: 61645.74
                  totalNetAmount: 61645.74
                  totalPages: 21872
                  totalRecords: 21872
                  transferAmount: 0
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/subscriptions/{entry}:
    get:
      operationId: query_ListSubscriptions
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListSubscriptions
      x-fern-request-name: ListSubscriptionsRequest
      summary: Get list of subscriptions for a paypoint
      description: Returns a list of subscriptions for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.

            **List of field names accepted:**

            - `startDate` (gt, ge, lt, le, eq, ne)
            - `endDate` (gt, ge, lt, le, eq, ne)
            - `nextDate` (gt, ge, lt, le, eq, ne)
            - `frequency` (in, nin, ne, eq)
            - `method` (in, nin, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `netAmount` (gt, ge, lt, le, eq, ne)
            - `feeAmount` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `untilcancelled` (eq, ne)
            - `subscriptionType` (eq, ne, in, nin). Filters by subscription type. Accepts `Regular` or `BalanceDriven`. Case-insensitive. Example: `subscriptionType(in)=Regular|BalanceDriven`.
            - `payaccountLastfour` (nct, ct)
            - `payaccountType` (ne, eq, in, nin)
            - `payaccountCurrency` (ne, eq, in, nin)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId` (eq)
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `externalPaypointId` (ct, nct, ne, eq)
            - `subId` (eq, ne)
            - `idPmethod` (eq, ne, ct, nct, in, nin). Filters by the subscription's linked stored method identifier (the value returned in `StoredMethod.IdPmethod`). Case-insensitive. Subscriptions without a linked stored method are excluded from matches. Example: `idPmethod(eq,6edcbb56-9c0e-4003-b3d1-99abf149ba0e)`.
            - `orderDescription` (ct, nct)
            - `cycles` (eq, ne, gt, ge, lt, le)
            - `leftcycles` (eq, ne, gt, ge, lt, le)
            - `createdAt` (eq, ne, gt, ge, lt, le)
            - `updatedOn` (eq, ne, gt, ge, lt, le)
            - `invoiceNumber` (ct, nct)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            **List of comparison operators accepted:**
            - `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
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuerySubscriptionResponse'
              example:
                Records:
                  - CreatedAt: '2023-12-14T08:51:10Z'
                    Customer:
                      AdditionalData: null
                      BillingAddress1: 68 Golden Drive
                      BillingAddress2: ''
                      BillingCity: Johnson City
                      BillingCountry: US
                      BillingEmail: company@payabli.com
                      BillingPhone: ''
                      BillingState: TN
                      BillingZip: '37612'
                      CompanyName: Sunshine LLC
                      customerId: 1323
                      CustomerNumber: '1234'
                      customerStatus: 1
                      FirstName: Lisandra
                      Identifiers:
                        - \"firstname\"
                        - \"lastname\"
                        - \"email\"
                      LastName: Smitch
                      ShippingAddress1: 68 Golden Drive
                      ShippingCity: Johnson City
                      ShippingCountry: US
                      ShippingState: TN
                      ShippingZip: '37612'
                    EndDate: '2026-03-20T00:00:00Z'
                    EntrypageId: 0
                    ExternalPaypointID: f743aed24a-10
                    FeeAmount: 0
                    Frequency: monthly
                    IdSub: 580
                    invoiceData:
                      AdditionalData: null
                      frequency: onetime
                      invoiceAmount: 100
                      invoiceNumber: QA-1702561870
                      invoiceStatus: 1
                      invoiceType: 1
                      items:
                        - itemCost: 10
                          itemDescription: service
                          itemMode: 1
                          itemProductName: Mat replacement
                          itemQty: 5
                          itemTotalAmount: 50
                        - itemCost: 5
                          itemDescription: service
                          itemMode: 1
                          itemProductName: Mat clean
                          itemQty: 10
                          itemTotalAmount: 50
                    LastRun: '2024-01-02T14:32:11Z'
                    LastUpdated: '2023-12-14T08:51:10Z'
                    LeftCycles: 20
                    Method: card
                    NetAmount: 10
                    NextDate: '2024-07-20T00:00:00Z'
                    ParentOrgName: FitnessManager
                    PaymentData:
                      AccountExp: 924
                      AccountType: unknown
                      AccountZip: '37612'
                      binData:
                        binMatchedLength: '6'
                        binCardBrand: Visa
                        binCardType: Credit
                        binCardCategory: PLATINUM
                        binCardIssuer: Bank of Example
                        binCardIssuerCountry: United States
                        binCardIssuerCountryCodeA2: US
                        binCardIssuerCountryNumber: '840'
                        binCardIsRegulated: 'false'
                        binCardUseCategory: Consumer
                        binCardIssuerCountryCodeA3: USA
                      HolderName: Lisandra Smitch
                      Initiator: payor
                      MaskedAccount: 2222 4XXXXXX0010
                      paymentDetails:
                        currency: USD
                        serviceFee: 0
                        totalAmount: 100
                      Sequence: subsequent
                      StoredMethodUsageType: subscription
                    PaypointDbaname: Athlete Factory LLC
                    PaypointEntryname: 473ac58b0
                    PaypointId: 10
                    PaypointLegalname: Athlete Factory LLC
                    PlanId: 1
                    StartDate: '2024-07-20T00:00:00Z'
                    StoredMethod:
                      IdPmethod: 6edcbb56-9c0e-4003-b3d1-99abf149ba0e
                      Method: card
                      Descriptor: Visa for subscriptions
                      MaskedAccount: 4XXXXXXX0010
                      ExpDate: 924
                      HolderName: Lisandra Smitch
                      AchSecCode: null
                      AchHolderType: null
                      IsValidatedACH: false
                      BIN: ''
                      binData:
                        binMatchedLength: '6'
                        binCardBrand: Visa
                        binCardType: Credit
                        binCardCategory: PLATINUM
                        binCardIssuer: Bank of Example
                        binCardIssuerCountry: United States
                        binCardIssuerCountryCodeA2: US
                        binCardIssuerCountryNumber: '840'
                        binCardIsRegulated: 'false'
                        binCardUseCategory: Consumer
                        binCardIssuerCountryCodeA3: USA
                      ABA: ''
                      PostalCode: '37612'
                      MethodType: Single Merchant
                      LastUpdated: '2023-12-14T08:51:10Z'
                      CardUpdatedOn: null
                    SubEvents:
                      - description: created
                        eventTime: '2023-12-14T13:51:10Z'
                        refData: 00-3470dfe2658b492811630255602f3fb5-d06fe0f72110000-00
                      - description: updated
                        eventTime: '2023-12-15T10:30:00Z'
                        refData: 01-1234abcde6789fghij4567klmnopqr89-abcdefghi12345678-01
                        source: web app
                    SubStatus: 1
                    SubscriptionType: Regular
                    TotalAmount: 100
                    TotalCycles: 20
                    UntilCancelled: false
                Summary:
                  pageIdentifier: XXXXXXXXXXXXXXXXXXX
                  pageSize: 20
                  totalAmount: 150.22
                  totalNetAmount: 150.22
                  totalPages: 1
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/subscriptions/org/{orgId}:
    get:
      operationId: query_ListSubscriptionsOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListSubscriptionsOrg
      x-fern-request-name: ListSubscriptionsOrgRequest
      summary: Get list of subscriptions for an org
      description: Returns a list of subscriptions for a single org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.

            **List of field names accepted:**

            - `startDate` (gt, ge, lt, le, eq, ne)
            - `endDate` (gt, ge, lt, le, eq, ne)
            - `nextDate` (gt, ge, lt, le, eq, ne)
            - `frequency` (in, nin, ne, eq)
            - `method` (in, nin, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `netAmount` (gt, ge, lt, le, eq, ne)
            - `feeAmount` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `untilcancelled` (eq, ne)
            - `subscriptionType` (eq, ne, in, nin). Filters by subscription type. Accepts `Regular` or `BalanceDriven`. Case-insensitive. Example: `subscriptionType(in)=Regular|BalanceDriven`.
            - `payaccountLastfour` (nct, ct)
            - `payaccountType` (ne, eq, in, nin)
            - `payaccountCurrency` (ne, eq, in, nin)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId` (eq)
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `externalPaypointId` (ct, nct, ne, eq)
            - `subId` (eq, ne)
            - `idPmethod` (eq, ne, ct, nct, in, nin). Filters by the subscription's linked stored method identifier (the value returned in `StoredMethod.IdPmethod`). Case-insensitive. Subscriptions without a linked stored method are excluded from matches. Example: `idPmethod(eq,6edcbb56-9c0e-4003-b3d1-99abf149ba0e)`.
            - `orderDescription` (ct, nct)
            - `cycles` (eq, ne, gt, ge, lt, le)
            - `leftcycles` (eq, ne, gt, ge, lt, le)
            - `createdAt` (eq, ne, gt, ge, lt, le)
            - `updatedOn` (eq, ne, gt, ge, lt, le)
            - `invoiceNumber` (ct, nct)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            **List of comparison operators accepted:**
            - `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
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuerySubscriptionResponse'
              example:
                Records:
                  - CreatedAt: '2023-12-14T08:51:10Z'
                    Customer:
                      AdditionalData: null
                      BillingAddress1: 68 Golden Drive
                      BillingAddress2: ''
                      BillingCity: Johnson City
                      BillingCountry: US
                      BillingEmail: company@payabli.com
                      BillingPhone: ''
                      BillingState: TN
                      BillingZip: '37612'
                      CompanyName: Sunshine LLC
                      customerId: 1323
                      CustomerNumber: '1234'
                      customerStatus: 1
                      FirstName: Lisandra
                      Identifiers:
                        - \"firstname\"
                        - \"lastname\"
                        - \"email\"
                      LastName: Smitch
                      ShippingAddress1: 68 Golden Drive
                      ShippingCity: Johnson City
                      ShippingCountry: US
                      ShippingState: TN
                      ShippingZip: '37612'
                    EndDate: '2026-03-20T00:00:00Z'
                    EntrypageId: 0
                    ExternalPaypointID: f743aed24a-10
                    FeeAmount: 0
                    Frequency: monthly
                    IdSub: 580
                    invoiceData:
                      AdditionalData: null
                      frequency: onetime
                      invoiceAmount: 100
                      invoiceNumber: QA-1702561870
                      invoiceStatus: 1
                      invoiceType: 1
                      items:
                        - itemCost: 10
                          itemDescription: service
                          itemMode: 1
                          itemProductName: Mat replacement
                          itemQty: 5
                          itemTotalAmount: 50
                        - itemCost: 5
                          itemDescription: service
                          itemMode: 1
                          itemProductName: Mat clean
                          itemQty: 10
                          itemTotalAmount: 50
                    LastRun: '2024-01-02T14:32:11Z'
                    LastUpdated: '2023-12-14T08:51:10Z'
                    LeftCycles: 20
                    Method: card
                    NetAmount: 10
                    NextDate: '2024-07-20T00:00:00Z'
                    ParentOrgName: FitnessManager
                    PaymentData:
                      AccountExp: 924
                      AccountType: unknow
                      AccountZip: '37612'
                      binData:
                        binMatchedLength: '6'
                        binCardBrand: Visa
                        binCardType: Credit
                        binCardCategory: PLATINUM
                        binCardIssuer: Bank of Example
                        binCardIssuerCountry: United States
                        binCardIssuerCountryCodeA2: US
                        binCardIssuerCountryNumber: '840'
                        binCardIsRegulated: 'false'
                        binCardUseCategory: Consumer
                        binCardIssuerCountryCodeA3: USA
                      HolderName: Lisandra Smitch
                      Initiator: payor
                      MaskedAccount: 2222 4XXXXXX0010
                      paymentDetails:
                        currency: USD
                        serviceFee: 0
                        totalAmount: 100
                      Sequence: subsequent
                      StoredMethodUsageType: subscription
                    PaypointDbaname: Athlete Factory LLC
                    PaypointEntryname: 473ac58b0
                    PaypointId: 10
                    PaypointLegalname: Athlete Factory LLC
                    PlanId: 1
                    StartDate: '2024-07-20T00:00:00Z'
                    StoredMethod:
                      IdPmethod: 6edcbb56-9c0e-4003-b3d1-99abf149ba0e
                      Method: card
                      Descriptor: Visa for subscriptions
                      MaskedAccount: 4XXXXXXX0010
                      ExpDate: 924
                      HolderName: Lisandra Smitch
                      AchSecCode: null
                      AchHolderType: null
                      IsValidatedACH: false
                      BIN: ''
                      binData:
                        binMatchedLength: '6'
                        binCardBrand: Visa
                        binCardType: Credit
                        binCardCategory: PLATINUM
                        binCardIssuer: Bank of Example
                        binCardIssuerCountry: United States
                        binCardIssuerCountryCodeA2: US
                        binCardIssuerCountryNumber: '840'
                        binCardIsRegulated: 'false'
                        binCardUseCategory: Consumer
                        binCardIssuerCountryCodeA3: USA
                      ABA: ''
                      PostalCode: '37612'
                      MethodType: Single Merchant
                      LastUpdated: '2023-12-14T08:51:10Z'
                      CardUpdatedOn: null
                    SubEvents:
                      - description: created
                        eventTime: '2023-12-14T13:51:10Z'
                        refData: 00-3470dfe2658b492811630255602f3fb5-d06fe0f72110000-00
                      - description: updated
                        eventTime: '2023-12-15T10:30:00Z'
                        refData: 01-1234abcde6789fghij4567klmnopqr89-abcdefghi12345678-01
                        source: web app
                    SubStatus: 1
                    SubscriptionType: Regular
                    TotalAmount: 100
                    TotalCycles: 20
                    UntilCancelled: false
                Summary:
                  pageIdentifier: XXXXXXXXXXXXXXXXXXX
                  pageSize: 20
                  totalAmount: 150.22
                  totalNetAmount: 150.22
                  totalPages: 1
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/payoutsubscriptions/{entry}:
    get:
      operationId: query_ListPayoutSubscriptions
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListPayoutSubscriptions
      x-fern-request-name: ListPayoutSubscriptionsRequest
      summary: Get list of payout subscriptions for a paypoint
      description: Returns a list of payout subscriptions for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 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
          example: 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/payoutsubscriptions/entry123?parameters=totalAmount(gt)=1000&limitRecord=20

              should become:

              --url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/entry123?totalAmount(gt)=1000&limitRecord=20
            </Info>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
            **List of field names accepted:**

            - `startDate` (gt, ge, lt, le, eq, ne)
            - `endDate` (gt, ge, lt, le, eq, ne)
            - `nextDate` (gt, ge, lt, le, eq, ne)
            - `frequency` (in, nin, ne, eq)
            - `method` (in, nin, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `netAmount` (gt, ge, lt, le, eq, ne)
            - `feeAmount` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `untilcancelled` (eq, ne)
            - `payaccountLastfour` (ct, nct)
            - `payaccountType` (ne, eq, in, nin)
            - `payaccountCurrency` (ne, eq, in, nin)
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct, nin, in)
            - `parentOrgId` (ne, eq, nin, in)
            - `subscriptionId` (eq, ne)
            - `orderDescription` (ct, nct)
            - `cycles` (eq, ne, gt, ge, lt, le)
            - `leftcycles` (eq, ne, gt, ge, lt, le)
            - `createdAt` (eq, ne, gt, ge, lt, le)
            - `updatedOn` (eq, ne, gt, ge, lt, le)
            - `vendorNumber` (ne, eq, ct, nct)
            - `name` (ne, eq, ct, nct)
            - `phone` (ne, eq, ct, nct)
            - `email` (ne, eq, ct, nct)
            - `address` (ne, eq, ct, nct)
            - `remitAddress` (ct, nct)
            - `city` (ne, eq, ct, nct)
            - `state` (ne, eq, ct, nct)
            - `country` (ne, eq, ct, nct)
            - `zip` (ne, eq, ct, nct)

            **List of comparison operators accepted:**
            - `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
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryPayoutSubscriptionResponse'
              example:
                Summary:
                  totalRecords: 1
                  totalAmount: 500
                  totalNetAmount: 500
                  totalPages: 1
                  pageSize: 20
                  pageIdentifier: XXXXXXXXXXXXXXXXXXX
                Records:
                  - IdOutSubscription: 42
                    Status: 1
                    Events:
                      - description: TransferCreated
                        eventTime: '2025-09-01T06:00:00Z'
                        extraData: null
                        refData: refData
                        source: api
                    Vendor:
                      VendorNumber: '1234'
                      Name1: Herman's Coatings
                      Name2: Herman's Coating Supply Company, LLC
                      EIN: '123456789'
                      Phone: '2125551234'
                      Email: example@email.com
                      RemitEmail: null
                      Address1: 123 Ocean Drive
                      Address2: Suite 400
                      City: Bristol
                      State: GA
                      Zip: '31113'
                      Country: US
                      Mcc: '7777'
                      LocationCode: LOC123
                      Contacts:
                        ContactEmail: eric@martinezcoatings.com
                        ContactName: Eric Martinez
                        ContactPhone: '5555555555'
                        ContactTitle: Owner
                      BillingData:
                        id: 123456
                        accountId: bank-account-001
                        nickname: Main Checking Account
                        bankName: Example Bank
                        routingAccount: '123456789'
                        accountNumber: '9876543210'
                        typeAccount: Checking
                        bankAccountHolderName: John Doe
                        bankAccountHolderType: Business
                        bankAccountFunction: 2
                        verified: true
                        status: 1
                        services: []
                        default: true
                      PaymentMethod: null
                      VendorStatus: 1
                      VendorId: 1
                      EnrollmentStatus: null
                      Summary:
                        ActiveBills: 2
                        PendingBills: 4
                        InTransitBills: 3
                        PaidBills: 18
                        OverdueBills: 1
                        ApprovedBills: 5
                        DisapprovedBills: 1
                        TotalBills: 34
                        ActiveBillsAmount: 1250.75
                        PendingBillsAmount: 2890.5
                        InTransitBillsAmount: 1675.25
                        PaidBillsAmount: 15420.8
                        OverdueBillsAmount: 425
                        ApprovedBillsAmount: 3240.9
                        DisapprovedBillsAmount: 180
                        TotalBillsAmount: 25083.2
                      PaypointLegalname: Sunshine Services, LLC
                      PaypointDbaname: Sunshine Gutters
                      PaypointEntryname: d193cf9a46
                      ParentOrgName: PropertyManager Pro
                      ParentOrgId: 1000
                      CreatedDate: '2022-07-01T15:00:01Z'
                      LastUpdated: '2022-07-01T15:00:01Z'
                      remitAddress1: 123 Walnut Street
                      remitAddress2: Suite 900
                      remitCity: Miami
                      remitState: FL
                      remitZip: '31113'
                      remitCountry: US
                      payeeName1: payeeName1
                      payeeName2: payeeName2
                      customField1: ''
                      customField2: ''
                      customerVendorAccount: 123-456
                      InternalReferenceId: 1000000
                      PaymentPortalUrl: https://greenfield-landscaping.com/pay
                      CardAccepted: 'yes'
                      AchAccepted: unable to determine
                      EnrichmentStatus: fully_enriched
                      EnrichedBy: web_search
                      EnrichedAt: '2026-03-05T14:22:10Z'
                      EnrichmentId: enrich-3890-a1b2c3d4
                      additionalData: null
                      externalPaypointID: Paypoint-100
                      StoredMethods: []
                    BillData:
                      - billId: 3001
                        invoiceNumber: INV-5001
                        netAmount: '500'
                        invoiceDate: '2025-08-01'
                        dueDate: '2025-08-15'
                    ExternalPaypointID: d193cf9a46-10
                    Method: ach
                    PaypointId: 255
                    TotalAmount: 500
                    NetAmount: 500
                    FeeAmount: 0
                    PaymentData:
                      AccountType: checking
                      HolderName: Herman Coatings
                      Initiator: merchant
                      MaskedAccount: XXXXXX5666
                      paymentDetails:
                        currency: USD
                        serviceFee: 0
                        totalAmount: 500
                      Sequence: subsequent
                      StoredMethodUsageType: recurring
                    StartDate: '2025-09-01T00:00:00Z'
                    EndDate: '2026-09-01T00:00:00Z'
                    NextDate: '2025-10-01T00:00:00Z'
                    Frequency: monthly
                    TotalCycles: 12
                    LeftCycles: 11
                    LastRun: '2025-09-01T06:00:00Z'
                    EntrypageId: 0
                    UntilCancelled: false
                    LastUpdated: '2025-08-01T12:00:00Z'
                    CreatedAt: '2025-08-01T12:00:00Z'
                    PaypointLegalname: Sunshine Services, LLC
                    PaypointDbaname: Sunshine Gutters
                    PaypointEntryname: d193cf9a46
                    ParentOrgName: PropertyManager Pro
                    ParentOrgId: 236
                    Source: api
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/payoutsubscriptions/org/{orgId}:
    get:
      operationId: query_ListPayoutSubscriptionsOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListPayoutSubscriptionsOrg
      x-fern-request-name: ListPayoutSubscriptionsOrgRequest
      summary: Get list of payout subscriptions for an org
      description: Returns a list of payout subscriptions for a single org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 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
          example: 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/payoutsubscriptions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20

              should become:

              --url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/org/236?totalAmount(gt)=1000&limitRecord=20
            </Info>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
            **List of field names accepted:**

            - `startDate` (gt, ge, lt, le, eq, ne)
            - `endDate` (gt, ge, lt, le, eq, ne)
            - `nextDate` (gt, ge, lt, le, eq, ne)
            - `frequency` (in, nin, ne, eq)
            - `method` (in, nin, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `netAmount` (gt, ge, lt, le, eq, ne)
            - `feeAmount` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `untilcancelled` (eq, ne)
            - `payaccountLastfour` (ct, nct)
            - `payaccountType` (ne, eq, in, nin)
            - `payaccountCurrency` (ne, eq, in, nin)
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct, nin, in)
            - `parentOrgId` (ne, eq, nin, in)
            - `subscriptionId` (eq, ne)
            - `orderDescription` (ct, nct)
            - `cycles` (eq, ne, gt, ge, lt, le)
            - `leftcycles` (eq, ne, gt, ge, lt, le)
            - `createdAt` (eq, ne, gt, ge, lt, le)
            - `updatedOn` (eq, ne, gt, ge, lt, le)
            - `vendorNumber` (ne, eq, ct, nct)
            - `name` (ne, eq, ct, nct)
            - `phone` (ne, eq, ct, nct)
            - `email` (ne, eq, ct, nct)
            - `address` (ne, eq, ct, nct)
            - `remitAddress` (ct, nct)
            - `city` (ne, eq, ct, nct)
            - `state` (ne, eq, ct, nct)
            - `country` (ne, eq, ct, nct)
            - `zip` (ne, eq, ct, nct)

            **List of comparison operators accepted:**
            - `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
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryPayoutSubscriptionResponse'
              example:
                Summary:
                  totalRecords: 1
                  totalAmount: 500
                  totalNetAmount: 500
                  totalPages: 1
                  pageSize: 20
                  pageIdentifier: XXXXXXXXXXXXXXXXXXX
                Records:
                  - IdOutSubscription: 42
                    Status: 1
                    Events:
                      - description: TransferCreated
                        eventTime: '2025-09-01T06:00:00Z'
                        extraData: null
                        refData: refData
                        source: api
                    Vendor:
                      VendorNumber: '1234'
                      Name1: Herman's Coatings
                      Name2: Herman's Coating Supply Company, LLC
                      EIN: '123456789'
                      Phone: '2125551234'
                      Email: example@email.com
                      RemitEmail: null
                      Address1: 123 Ocean Drive
                      Address2: Suite 400
                      City: Bristol
                      State: GA
                      Zip: '31113'
                      Country: US
                      Mcc: '7777'
                      LocationCode: LOC123
                      Contacts:
                        ContactEmail: eric@martinezcoatings.com
                        ContactName: Eric Martinez
                        ContactPhone: '5555555555'
                        ContactTitle: Owner
                      BillingData:
                        id: 123456
                        accountId: bank-account-001
                        nickname: Main Checking Account
                        bankName: Example Bank
                        routingAccount: '123456789'
                        accountNumber: '9876543210'
                        typeAccount: Checking
                        bankAccountHolderName: John Doe
                        bankAccountHolderType: Business
                        bankAccountFunction: 2
                        verified: true
                        status: 1
                        services: []
                        default: true
                      PaymentMethod: null
                      VendorStatus: 1
                      VendorId: 1
                      EnrollmentStatus: null
                      Summary:
                        ActiveBills: 2
                        PendingBills: 4
                        InTransitBills: 3
                        PaidBills: 18
                        OverdueBills: 1
                        ApprovedBills: 5
                        DisapprovedBills: 1
                        TotalBills: 34
                        ActiveBillsAmount: 1250.75
                        PendingBillsAmount: 2890.5
                        InTransitBillsAmount: 1675.25
                        PaidBillsAmount: 15420.8
                        OverdueBillsAmount: 425
                        ApprovedBillsAmount: 3240.9
                        DisapprovedBillsAmount: 180
                        TotalBillsAmount: 25083.2
                      PaypointLegalname: Sunshine Services, LLC
                      PaypointDbaname: Sunshine Gutters
                      PaypointEntryname: d193cf9a46
                      ParentOrgName: PropertyManager Pro
                      ParentOrgId: 1000
                      CreatedDate: '2022-07-01T15:00:01Z'
                      LastUpdated: '2022-07-01T15:00:01Z'
                      remitAddress1: 123 Walnut Street
                      remitAddress2: Suite 900
                      remitCity: Miami
                      remitState: FL
                      remitZip: '31113'
                      remitCountry: US
                      payeeName1: payeeName1
                      payeeName2: payeeName2
                      customField1: ''
                      customField2: ''
                      customerVendorAccount: 123-456
                      InternalReferenceId: 1000000
                      PaymentPortalUrl: https://greenfield-landscaping.com/pay
                      CardAccepted: 'yes'
                      AchAccepted: unable to determine
                      EnrichmentStatus: fully_enriched
                      EnrichedBy: web_search
                      EnrichedAt: '2026-03-05T14:22:10Z'
                      EnrichmentId: enrich-3890-a1b2c3d4
                      additionalData: null
                      externalPaypointID: Paypoint-100
                      StoredMethods: []
                    BillData:
                      - billId: 3001
                        invoiceNumber: INV-5001
                        netAmount: '500'
                        invoiceDate: '2025-08-01'
                        dueDate: '2025-08-15'
                    ExternalPaypointID: d193cf9a46-10
                    Method: ach
                    PaypointId: 255
                    TotalAmount: 500
                    NetAmount: 500
                    FeeAmount: 0
                    PaymentData:
                      AccountType: checking
                      HolderName: Herman Coatings
                      Initiator: merchant
                      MaskedAccount: XXXXXX5666
                      paymentDetails:
                        currency: USD
                        serviceFee: 0
                        totalAmount: 500
                      Sequence: subsequent
                      StoredMethodUsageType: recurring
                    StartDate: '2025-09-01T00:00:00Z'
                    EndDate: '2026-09-01T00:00:00Z'
                    NextDate: '2025-10-01T00:00:00Z'
                    Frequency: monthly
                    TotalCycles: 12
                    LeftCycles: 11
                    LastRun: '2025-09-01T06:00:00Z'
                    EntrypageId: 0
                    UntilCancelled: false
                    LastUpdated: '2025-08-01T12:00:00Z'
                    CreatedAt: '2025-08-01T12:00:00Z'
                    PaypointLegalname: Sunshine Services, LLC
                    PaypointDbaname: Sunshine Gutters
                    PaypointEntryname: d193cf9a46
                    ParentOrgName: PropertyManager Pro
                    ParentOrgId: 236
                    Source: api
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/transactions/{entry}:
    get:
      operationId: query_ListTransactions
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListTransactions
      x-fern-request-name: ListTransactionsRequest
      summary: Get list of transactions for a paypoint
      description: |
        Retrieve a list of transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.

        By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this period, include `transactionDate` filters.

        These request parameters filter for transactions between April 1, 2024 and April 9, 2024.

        ```bash
        curl -X GET https://api-sandbox.payabli.com/api/Query/transactions/8cfec329267?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59 \
          -H 'requestToken: <API TOKEN>'
        ```
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          examples:
            Example:
              value: 8cfec329267
            Card reject query:
              value: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          examples:
            Example:
              value: 251
        - 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
          examples:
            Example:
              value: 0
            Card reject query:
              value: 1
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.

            **List of field names accepted:**

            - `transactionDate` (gt, ge, lt, le, eq, ne)
            - `transId` (ne, eq, ct, nct, in, nin)
            - `gatewayTransId` (ne, eq, ct, nct)
            - `orderId` (ne, eq)
            - `scheduleId` (ne, eq)
            - `returnId` (ne, eq)
            - `refundId` (ne, eq)
            - `rejectId` (ne, eq)
            - `idTrans` (ne, eq)
            - `orgId` (ne, eq)
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `externalPaypointId` (ct, nct, eq, ne)
            - `method` (in, nin, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `netAmount` (gt, ge, lt, le, eq, ne)
            - `feeAmount` (gt, ge, lt, le, eq, ne)
            - `operation` (in, nin, eq, ne)
            - `source` (in, nin, eq, ne, ct, nct)
            - `status` (in, nin, eq, ne)
            - `settlementStatus` (in, nin, eq, ne)
            - `batchNumber` (nct, ct)
            - `invoiceNumber` (ct, nct)
            - `ipAddress` (eq, ne)
            - `authCode` (ct, nct)
            - `orderDescription` (ct, nct)
            - `payaccountLastfour` (nct, ct)
            - `payaccountType` (ne, eq, in, nin)
            - `payaccountCurrency` (ne, eq, in, nin)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `deviceId` (ct, nct, in, nin, eq, ne)
            - `AchSecCode` ( ct, nct, in, nin, eq, ne)
            - `AchHolderType` (ct, nct, in, nin, eq, and ne)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name related to customer data
            - 'invoiceAdditional-xxx' (ne, eq, ct, nct) where xxx is the additional field name related to invoice data

            **List of comparison operators accepted:**
            - `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
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
          examples:
            Card reject query:
              value:
                operation(eq): Reject
        - 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
          examples:
            Example:
              value: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseTransactions'
              examples:
                Example:
                  value:
                    Records:
                      - BatchAmount: 30.22
                        BatchNumber: '1234567'
                        CfeeTransactions:
                          - cFeeTransid: string
                            feeAmount: 0
                            operation: string
                            refundId: 0
                            settlementStatus: 0
                            transactionTime: '2019-08-24T14:15:22Z'
                            transStatus: 0
                        ConnectorName: gp
                        Customer:
                          AdditionalData: null
                          BillingAddress1: 1111 street
                          BillingAddress2: string
                          BillingCity: myCity
                          BillingCountry: US
                          BillingEmail: customer@mail.com
                          BillingPhone: '1234567890'
                          BillingState: CA
                          BillingZip: '45567'
                          CompanyName: Sunshine LLC
                          customerId: 34
                          CustomerNumber: 3456-7645A
                          FirstName: John
                          LastName: Doe
                          ShippingAddress1: string
                          ShippingAddress2: string
                          ShippingCity: string
                          ShippingCountry: string
                          ShippingState: string
                          ShippingZip: string
                        DeviceId: 6c361c7d-674c-44cc-b790-382b75d1xxx
                        EntrypageId: 0
                        ExternalProcessorInformation: ' '
                        FeeAmount: 10.25
                        GatewayTransId: string
                        invoiceData:
                          attachments:
                            - fContent: TXkgdGVzdCBmaWxlHJ==...
                              filename: my-doc.pdf
                              ftype: pdf
                              furl: https://mysite.com/my-doc.pdf
                          company: string
                          discount: 0
                          dutyAmount: 0
                          firstName: string
                          freightAmount: 10
                          frequency: onetime
                          invoiceAmount: 105
                          invoiceDate: '2026-01-01'
                          invoiceDueDate: '2026-01-15'
                          invoiceEndDate: '2026-01-15'
                          invoiceNumber: INV-2345
                          invoiceStatus: 0
                          invoiceType: 0
                          items:
                            - itemCategories:
                                - string
                              itemCommodityCode: string
                              itemCost: 1
                              itemDescription: string
                              itemMode: 0
                              itemProductCode: string
                              itemProductName: product 01
                              itemQty: 1
                              itemTaxAmount: 0
                              itemTaxRate: 0
                              itemTotalAmount: 0
                              itemUnitOfMeasure: U
                          lastName: string
                          notes: string
                          paymentTerms: PIA
                          purchaseOrder: string
                          shippingAddress1: string
                          shippingAddress2: string
                          shippingCity: string
                          shippingCountry: string
                          shippingEmail: string
                          shippingFromZip: string
                          shippingPhone: string
                          shippingState: string
                          shippingZip: string
                          summaryCommodityCode: string
                          tax: 2.05
                          termsConditions: string
                        Method: card
                        NetAmount: 100
                        Operation: Sale
                        OrderId: '9876543'
                        OrgId: 2
                        ParentOrgName: Payabli
                        PaymentData:
                          AccountExp: '0426'
                          AccountType: visa
                          binData:
                            binMatchedLength: '6'
                            binCardBrand: VISA
                            binCardType: DEBIT
                            binCardCategory: CLASSIC
                            binCardIssuer: CONOTOXIA SP. Z O.O
                            binCardIssuerCountry: POLAND
                            binCardIssuerCountryCodeA2: PL
                            binCardIssuerCountryNumber: '616'
                            binCardIsRegulated: 'true'
                            binCardUseCategory: Consumer
                            binCardIssuerCountryCodeA3: POL
                          HolderName: Billy J Franks
                          Initiator: payor
                          MaskedAccount: 411111XXXXXX1111
                          paymentDetails:
                            totalAmount: 100
                          Sequence: first
                          StoredId: 675b43c1-9867-463c-8dc7-3d6ddb68554b-12812
                          StoredMethodUsageType: unscheduled
                        PaymentTransId: 2345667-ddd-fff
                        PayorId: 55
                        PaypointDbaname: Sunshine LLC
                        PaypointEntryname: 7acda8200
                        PaypointId: 2
                        PaypointLegalname: Sunshine LLC
                        PendingFeeAmount: 2
                        RefundId: 0
                        ResponseData:
                          authcode: '123456'
                          avsresponse: 'N'
                          avsresponse_text: No address or ZIP match only
                          cvvresponse: M
                          cvvresponse_text: CVV2/CVC2 match
                          emv_auth_response_data: null
                          orderid: 10-bfcd5a17861d4a8690ca53c00000X
                          response: Success
                          response_code: '100'
                          response_code_text: Transaction was approved.
                          responsetext: SUCCESS
                          resultCode: A0000
                          resultCodeText: Approved
                          transactionid: '8082800000'
                        ReturnedId: 0
                        ScheduleReference: 0
                        SettlementStatus: 0
                        Source: vterminal
                        splitFundingInstructions:
                          - {}
                        splitCount: 1
                        TotalAmount: 110.25
                        TransactionEvents:
                          - {}
                        TransactionTime: '2019-08-24T14:15:22Z'
                        TransStatus: 1
                    Summary:
                      pageIdentifier: XXXXXXXXXXXXXXXXXXX
                      pageSize: 20
                      totalAmount: 177.22
                      totalNetAmount: 177.22
                      totalPages: 1
                      totalRecords: 2
                Card reject query:
                  value:
                    Records:
                      - ParentOrgName: RealistRoofing
                        PaypointDbaname: Eagle-Pointe
                        PaypointLegalname: Eagle-Pointe
                        PaypointEntryname: entry399
                        PaymentTransId: 399-8e7e5fc7-f483-43cc-9e78-d8a36ac857bf
                        ConnectorName: GP
                        Method: card
                        PayorId: 155974
                        PaymentData:
                          MaskedAccount: 5XXXXXXXXXXX4415
                          AccountExp: 12/29
                          HolderName: RENEE DESCARTES
                          binData:
                            binMatchedLength: '9'
                            binCardBrand: MASTERCARD
                            binCardType: CREDIT
                            binCardCategory: MIXED PRODUCT
                            binCardIssuer: ALLIED IRISH BANKS, PLC
                            binCardIssuerCountry: IRELAND
                            binCardIsRegulated: 'False'
                            binCardUseCategory: PERSONAL
                          paymentDetails:
                            totalAmount: 6.79
                            serviceFee: 0
                            currency: USD
                        TransStatus: -4
                        PaypointId: 399
                        splitFundingInstructions:
                          - {}
                        splitCount: 1
                        TotalAmount: -6.79
                        NetAmount: -6.79
                        FeeAmount: 0
                        SettlementStatus: 0
                        Operation: Reject
                        Source: api
                        OrgId: 39
                        TransactionTime: '2026-03-02T18:56:23.109188'
                        Customer:
                          FirstName: Blaise
                          LastName: Pascal
                          CompanyName: Pensees LLC
                          BillingAddress1: 49912 Aufengrupt Pointe
                          BillingAddress2: apt 6
                          BillingCity: South Litzy
                          BillingState: FL
                          BillingZip: '33000'
                          BillingCountry: US
                          BillingPhone: '+18955791994'
                          BillingEmail: blaise.pascal@gmail.com
                          CustomerNumber: o99t
                          customerId: 155974
                          customerStatus: 1
                        TransactionEvents:
                          - TransEvent: Created
                            EventData: 'Card Reject - CTDR Id: 1379241'
                            EventTime: '2026-03-02T18:56:23.352035'
                    Summary:
                      totalRecords: 14
                      totalAmount: -79.48
                      totalNetAmount: -74.41
                      totalPages: 14
                      pageSize: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/transactions/org/{orgId}:
    get:
      operationId: query_ListTransactionsOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListTransactionsOrg
      x-fern-request-name: ListTransactionsOrgRequest
      summary: Get list of transactions for an organization
      description: |
        Retrieve a list of transactions for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.

        By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this period, include `transactionDate` filters.

        These request parameters filter for transactions between April 1, 2024 and April 9, 2024.

        ```bash
        curl -X GET "https://api-sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59" \
          -H 'requestToken: <API TOKEN>'
        ```
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          examples:
            Example:
              value: 123
            Card reject query:
              value: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          examples:
            Example:
              value: 251
        - 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
          examples:
            Example:
              value: 0
            Card reject query:
              value: 1
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.

            **List of field names accepted:**

            - `transactionDate` (gt, ge, lt, le, eq, ne)
            - `transId` (ne, eq, ct, nct, in, nin)
            - `gatewayTransId` (ne, eq, ct, nct)
            - `orderId` (ne, eq)
            - `scheduleId` (ne, eq)
            - `returnId` (ne, eq)
            - `refundId` (ne, eq)
            - `rejectId` (ne, eq)
            - `idTrans` (ne, eq)
            - `orgId` (ne, eq)
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `externalPaypointId` (ct, nct, eq, ne)
            - `method` (in, nin, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `netAmount` (gt, ge, lt, le, eq, ne)
            - `feeAmount` (gt, ge, lt, le, eq, ne)
            - `operation` (in, nin, eq, ne)
            - `source` (in, nin, eq, ne, ct, nct)
            - `status` (in, nin, eq, ne)
            - `settlementStatus` (in, nin, eq, ne)
            - `batchNumber` (nct, ct)
            - `invoiceNumber` (ct, nct)
            - `authCode` (ct, nct)
            - `orderDescription` (ct, nct)
            - `payaccountLastfour` (nct, ct)
            - `payaccountType` (ne, eq, in, nin)
            - `payaccountCurrency` (ne, eq, in, nin)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `deviceId` (ct, nct, in, nin, eq, ne)
            - `AchSecCode` ( ct, nct, in, nin, eq, ne)
            - `AchHolderType`` (ct, nct, in, nin, eq, and ne)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name related to customer data
            - 'invoiceAdditional-xxx' (ne, eq, ct, nct) where xxx is the additional field name related to invoice data

            **List of comparison operators accepted:**
            - `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
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
          examples:
            Card reject query:
              value:
                operation(eq): Reject
        - 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
          examples:
            Example:
              value: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseTransactions'
              examples:
                Example:
                  value:
                    Records:
                      - AchHolderType: personal
                        AchSecCode: AchSecCode
                        BatchAmount: 30.22
                        BatchNumber: batch_226_ach_12-30-2023
                        CfeeTransactions:
                          - transactionTime: '2024-01-15T09:30:00Z'
                        ConnectorName: gp
                        DeviceId: 6c361c7d-674c-44cc-b790-382b75d1xxx
                        EntrypageId: 0
                        ExternalProcessorInformation: '[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]'
                        FeeAmount: 1
                        GatewayTransId: TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0
                        Method: ach
                        NetAmount: 3762.87
                        Operation: Sale
                        OrderId: O-5140
                        OrgId: 123
                        ParentOrgName: PropertyManager Pro
                        PaymentData:
                          paymentDetails:
                            totalAmount: 100
                        PaymentTransId: 226-fe55ec0348e34702bd91b4be198ce7ec
                        PayorId: 1551
                        PaypointDbaname: Sunshine Gutters
                        PaypointEntryname: d193cf9a46
                        PaypointId: 226
                        PaypointLegalname: Sunshine Services, LLC
                        PendingFeeAmount: 2
                        RefundId: 0
                        ResponseData:
                          authcode: ' '
                          avsresponse: ' '
                          avsresponse_text: ''
                          cvvresponse: ' '
                          cvvresponse_text: ' '
                          emv_auth_response_data: ' '
                          orderid: null
                          response: Success
                          response_code: '100'
                          response_code_text: Transaction was approved.
                          responsetext: CAPTURED
                          resultCode: A0000
                          resultCodeText: Approved
                          transactionid: TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0
                        ReturnedId: 0
                        ScheduleReference: 0
                        SettlementStatus: 2
                        Source: api
                        splitFundingInstructions:
                          - {}
                        splitCount: 1
                        TotalAmount: 30.22
                        TransactionEvents:
                          - {}
                        TransactionTime: '2025-10-19T00:00:00Z'
                        TransAdditionalData:
                          key: value
                        TransStatus: 1
                    Summary:
                      pageIdentifier: 'null'
                      pageSize: 20
                      totalAmount: 77.22
                      totalNetAmount: 77.22
                      totalPages: 2
                      totalRecords: 2
                Card reject query:
                  value:
                    Records:
                      - ParentOrgName: RealistRoofing
                        PaypointDbaname: Eagle-Pointe
                        PaypointLegalname: Eagle-Pointe
                        PaypointEntryname: entry399
                        PaymentTransId: 399-8e7e5fc7-f483-43cc-9e78-d8a36ac857bf
                        ConnectorName: GP
                        Method: card
                        PayorId: 155974
                        PaymentData:
                          MaskedAccount: 5XXXXXXXXXXX4415
                          AccountExp: 12/29
                          HolderName: RENEE DESCARTES
                          binData:
                            binMatchedLength: '9'
                            binCardBrand: MASTERCARD
                            binCardType: CREDIT
                            binCardCategory: MIXED PRODUCT
                            binCardIssuer: ALLIED IRISH BANKS, PLC
                            binCardIssuerCountry: IRELAND
                            binCardIsRegulated: 'False'
                            binCardUseCategory: PERSONAL
                          paymentDetails:
                            totalAmount: 6.79
                            serviceFee: 0
                            currency: USD
                        TransStatus: -4
                        PaypointId: 399
                        splitFundingInstructions:
                          - {}
                        splitCount: 1
                        TotalAmount: -6.79
                        NetAmount: -6.79
                        FeeAmount: 0
                        SettlementStatus: 0
                        Operation: Reject
                        Source: api
                        OrgId: 39
                        TransactionTime: '2026-03-02T18:56:23.109188'
                        Customer:
                          FirstName: Blaise
                          LastName: Pascal
                          CompanyName: Pensees LLC
                          BillingAddress1: 49912 Aufengrupt Pointe
                          BillingAddress2: apt 6
                          BillingCity: South Litzy
                          BillingState: FL
                          BillingZip: '33000'
                          BillingCountry: US
                          BillingPhone: '+18955791994'
                          BillingEmail: blaise.pascal@gmail.com
                          CustomerNumber: o99t
                          customerId: 155974
                          customerStatus: 1
                        TransactionEvents:
                          - TransEvent: Created
                            EventData: 'Card Reject - CTDR Id: 1379241'
                            EventTime: '2026-03-02T18:56:23.352035'
                    Summary:
                      totalRecords: 14
                      totalAmount: -79.48
                      totalNetAmount: -74.41
                      totalPages: 14
                      pageSize: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/transferDetails/{entry}/{transferId}:
    get:
      operationId: query_ListTransferDetails
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListTransferDetails
      x-fern-request-name: ListTransfersPaypointRequest
      summary: Get transfer details for a paypoint
      description: Retrieve a list of transfer details records for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 47862acd
        - name: transferId
          in: path
          description: The numeric identifier for the transfer, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123456
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          required: false
          description: Max number of records to return for the query. Use `0` or negative value to return all records. Defaults to 20.
          schema:
            $ref: '#/components/schemas/limitRecord'
        - 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>

            See [Filters and Conditions
            Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
            for more information.


            **List of field names accepted:**

              - `grossAmount` (gt, ge, lt, le, eq, ne)
              - `chargeBackAmount` (gt, ge, lt, le, eq, ne)
              - `returnedAmount` (gt, ge, lt, le, eq, ne)
              - `billingFeeAmount` (gt, ge, lt, le, eq, ne)
              - `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)
              - `netFundedAmount` (gt, ge, lt, le, eq, ne)
              - `adjustmentAmount` (gt, ge, lt, le, eq, ne)
              - `splitFundingAmount` (gt, ge, lt, le, eq, ne)
              - `operation` (in, nin, eq, ne)
              - `transactionId` (eq, ne, in, nin)
              - `category` (eq, ne, ct, nct)
              - `type` (eq, ne, in, nin)
              - `method` (eq, ne, in, nin)
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryTransferDetailResponse'
              example:
                Summary:
                  achReturns: -50
                  adjustments: 10
                  billingFees: 25
                  chargebacks: 0
                  grossTransferAmount: 1000
                  releaseAmount: 0
                  thirdPartyPaid: 0
                  totalNetAmountTransfer: 935
                  serviceFees: 30
                  splitAmount: 650.22
                  transferAmount: 935
                  refunds: -20
                  heldAmount: 0
                  totalRecords: 1
                  totalAmount: 1000
                  totalNetAmount: 935
                  netBatchAmount: 935
                  totalPages: 1
                  pageSize: 20
                  pageidentifier: XYZ123ABC456
                Records:
                  - transferDetailId: 654321
                    transferId: 12345
                    transactionId: txn-4321hg6543fe
                    type: credit
                    category: sale
                    grossAmount: 1000
                    chargeBackAmount: 0
                    returnedAmount: 0
                    refundAmount: 20
                    holdAmount: 0
                    releasedAmount: 0
                    billingFeesAmount: 25
                    thirdPartyPaidAmount: 0
                    adjustmentsAmount: 10
                    netTransferAmount: 935
                    splitFundingAmount: 0
                    ParentOrgName: GadgetPro
                    PaypointDbaname: Global Gadgets
                    PaypointLegalname: Global Gadgets, LLC
                    PaypointEntryname: 48ae10920
                    PaymentTransId: txn-4321hg6543fe
                    ConnectorName: gp
                    GatewayTransId: TRN_K6Nz3JxrNKkaPTF4ExCqfO4UwMW4CM
                    OrderId: order789
                    Method: ach
                    BatchNumber: batch_226_ach_12-30-2023
                    BatchAmount: 30.22
                    PayorId: 1551
                    PaymentData:
                      MaskedAccount: 411812XXXXXX2357
                      AccountType: visa
                      AccountExp: 08/28
                      HolderName: Ara Karapetyan
                      orderDescription: Electronics Purchase
                      StoredId: null
                      Initiator: null
                      StoredMethodUsageType: null
                      Sequence: null
                      accountId: null
                      SignatureData: null
                      binData:
                        binMatchedLength: '6'
                        binCardBrand: Visa
                        binCardType: Credit
                        binCardCategory: PLATINUM
                        binCardIssuer: Bank of Example
                        binCardIssuerCountry: United States
                        binCardIssuerCountryCodeA2: US
                        binCardIssuerCountryNumber: '840'
                        binCardIsRegulated: 'false'
                        binCardUseCategory: Consumer
                        binCardIssuerCountryCodeA3: USA
                      paymentDetails: null
                    TransStatus: 1
                    TotalAmount: 1000
                    NetAmount: 935
                    FeeAmount: 1
                    SettlementStatus: 2
                    Operation: Sale
                    ResponseData:
                      authcode: '123456'
                      avsresponse: 'N'
                      avsresponse_text: No address or ZIP match only
                      cvvresponse: M
                      cvvresponse_text: CVV2/CVC2 match
                      emv_auth_response_data: null
                      orderid: 10-bfcd5a17861d4a8690ca53c00000X
                      response: Success
                      response_code: '100'
                      response_code_text: Transaction was approved.
                      responsetext: SUCCESS
                      resultCode: A0000
                      resultCodeText: Approved
                      transactionid: '8082800000'
                    Source: web
                    ScheduleReference: 0
                    OrgId: 9876
                    RefundId: 0
                    ReturnedId: 0
                    TransactionTime: '2024-01-05T12:15:30.11'
                    Customer:
                      Identifiers:
                        - customerId
                        - email
                      FirstName: Ara
                      LastName: Karapetyan
                      CompanyName: Ara's Electronics
                      BillingAddress1: 7890 Tech Park Drive
                      BillingCity: Baltimore
                      BillingState: MD
                      BillingZip: '21230'
                      BillingCountry: US
                      BillingEmail: ara.karapetyan@electronics.com
                      CustomerNumber: '0010'
                      customerId: 7890
                    transactionNumber: null
                    billingFeesDetails: []
                    ExternalProcessorInformation: null
                    PaypointId: 1357
                    ChargebackId: null
                    RetrievalId: null
                    TransAdditionalData: null
                    invoiceData: null
                    EntrypageId: null
                    externalPaypointID: null
                    IsValidatedACH: true
                    splitFundingInstructions: []
                    CfeeTransactions: []
                    TransactionEvents: []
                    PendingFeeAmount: 0
                    RiskFlagged: false
                    RiskFlaggedOn: null
                    RiskStatus: approved
                    RiskReason: null
                    RiskAction: null
                    RiskActionCode: null
                    DeviceId: null
                    AchSecCode: PPD
                    AchHolderType: personal
                    IpAddress: 192.100.1.100
                    IsSameDayACH: false
                    WalletType: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/transfers/{entry}:
    get:
      operationId: query_ListTransfers
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListTransfers
      x-fern-request-name: ListTransfersRequest
      summary: Get list of transfers for a paypoint
      description: Retrieve a list of transfers for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 47862acd
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 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
          example: 20
        - name: parameters
          in: query
          description: |-
            Collection of field names, conditions, and values used to filter the query. See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
            <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:

              - `transferDate` (gt, ge, lt, le, eq, ne)
              - `grossAmount` (gt, ge, lt, le, eq, ne)
              - `chargeBackAmount` (gt, ge, lt, le, eq, ne)
              - `returnedAmount` (gt, ge, lt, le, eq, ne)
              - `billingFeeAmount` (gt, ge, lt, le, eq, ne)
              - `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)
              - `netFundedAmount` (gt, ge, lt, le, eq, ne)
              - `adjustmentAmount` (gt, ge, lt, le, eq, ne)
              - `processor` (ne, eq, ct, nct)
              - `transferStatus` (ne, eq, in, nin)
              - `batchNumber` (ne, eq, ct, nct)
              - `batchId` (ne, eq, in, nin)
              - `transferId` (in, nin, eq, ne)
              - `bankAccountNumber` (ct, nct, ne, eq)
              - `bankRoutingNumber` (ct, nct, ne, eq)
              - `batchCurrency` (in, nin, ne, eq)
              - `parentOrgName` (ct, nct, ne, eq)
              - `parentOrgId` (ct, nct, ne, eq)
              - `externalPaypointID` (ct, nct)
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferQueryResponse'
              example:
                Records:
                  - transferId: 79851
                    paypointId: 705
                    batchNumber: split_705_gp_11-16-2024
                    batchCurrency: USD
                    batchRecords: 1
                    transferIdentifier: bbcbfed7-e535-45fe-8d62-000000
                    batchId: 111430
                    paypointEntryName: 47ae3de37
                    paypointLegalName: Gruzya Outdoor Outfitters LLC
                    paypointDbaName: Gruzya Outdoor Outfitters
                    paypointLogo: https://example.com/logo.png
                    parentOrgName: Pilgrim Planner
                    parentOrgId: 12345
                    parentOrgEntryName: 43aebc000
                    parentOrgLogo: https://example.com/parent-logo.png
                    externalPaypointID: ext-12345
                    bankAccount:
                      accountNumber: '****1234'
                      routingNumber: '123456789'
                      bankName: Riverdale Community Bank
                    transferDate: '2024-11-17T08:20:07.288+00:00'
                    processor: gp
                    transferStatus: 2
                    grossAmount: 1029
                    chargeBackAmount: 25
                    returnedAmount: 0
                    holdAmount: 0
                    releasedAmount: 0
                    billingFeesAmount: 0
                    thirdPartyPaidAmount: 0
                    adjustmentsAmount: 0
                    netTransferAmount: 1004
                    splitAmount: 650.22
                    eventsData:
                      - description: Transfer Created
                        eventTime: '2024-11-16T08:15:33.4364067Z'
                        refData: null
                        extraData: null
                        source: worker
                    messages: []
                Summary:
                  totalPages: 1
                  totalRecords: 2
                  pageSize: 20
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/transfers/org/{orgId}:
    get:
      operationId: query_ListTransfersOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListTransfersOrg
      x-fern-request-name: ListTransfersRequestOrg
      summary: Get list of transfers for an organization
      description: Retrieve a list of transfers for an org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      parameters:
        - name: orgId
          in: path
          required: true
          description: Organization ID. Unique identifier assigned to an org by Payabli.
          schema:
            $ref: '#/components/schemas/Orgid'
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 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
          example: 20
        - name: parameters
          in: query
          description: |-
            Collection of field names, conditions, and values used to filter the query. See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
            <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:

              - `transferDate` (gt, ge, lt, le, eq, ne)
              - `grossAmount` (gt, ge, lt, le, eq, ne)
              - `chargeBackAmount` (gt, ge, lt, le, eq, ne)
              - `returnedAmount` (gt, ge, lt, le, eq, ne)
              - `billingFeeAmount` (gt, ge, lt, le, eq, ne)
              - `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)
              - `netFundedAmount` (gt, ge, lt, le, eq, ne)
              - `adjustmentAmount` (gt, ge, lt, le, eq, ne)
              - `processor` (ne, eq, ct, nct)
              - `transferStatus` (ne, eq, in, nin)
              - `batchNumber` (ne, eq, ct, nct)
              - `batchId` (ne, eq, in, nin)
              - `transferId` (in, nin, eq, ne)
              - `bankAccountNumber` (ct, nct, ne, eq)
              - `bankRoutingNumber` (ct, nct, ne, eq)
              - `batchCurrency` (in, nin, ne, eq)
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferQueryResponse'
              example:
                Records:
                  - transferId: 79851
                    paypointId: 705
                    batchNumber: split_705_gp_11-16-2024
                    batchCurrency: USD
                    batchRecords: 1
                    transferIdentifier: bbcbfed7-e535-45fe-8d62-000000
                    batchId: 111430
                    paypointEntryName: 47ae3de37
                    paypointLegalName: Gruzya Outdoor Outfitters LLC
                    paypointDbaName: Gruzya Outdoor Outfitters
                    paypointLogo: https://example.com/logo.png
                    parentOrgName: Pilgrim Planner
                    parentOrgId: 12345
                    parentOrgEntryName: 43aebc000
                    parentOrgLogo: https://example.com/parent-logo.png
                    externalPaypointID: ext-12345
                    bankAccount:
                      accountNumber: '****1234'
                      routingNumber: '123456789'
                      bankName: Riverdale Community Bank
                    transferDate: '2024-11-17T08:20:07.288+00:00'
                    processor: gp
                    transferStatus: 2
                    grossAmount: 1029
                    chargeBackAmount: 25
                    returnedAmount: 0
                    holdAmount: 0
                    releasedAmount: 0
                    billingFeesAmount: 0
                    thirdPartyPaidAmount: 0
                    adjustmentsAmount: 0
                    netTransferAmount: 1004
                    splitAmount: 650.22
                    eventsData:
                      - description: Transfer Created
                        eventTime: '2024-11-16T08:15:33.4364067Z'
                        refData: null
                        extraData: null
                        source: worker
                    messages: []
                Summary:
                  totalPages: 1
                  totalRecords: 2
                  pageSize: 20
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/transfersOut/org/{orgId}:
    get:
      operationId: query_ListTransfersOutOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListTransfersOutOrg
      x-fern-request-name: ListTransfersOutOrgRequest
      summary: Get list of outbound transfers for an organization
      description: Retrieve a list of outbound transfers for an organization. Use filters to limit results.
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 77
        - 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
          example: 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
          example: 20
        - name: parameters
          in: query
          description: |-
            Collection of field names, conditions, and values used to filter the query. See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
            <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:

              - `transferDate` (gt, ge, lt, le, eq, ne)
              - `grossAmount` (gt, ge, lt, le, eq, ne)
              - `returnedAmount` (gt, ge, lt, le, eq, ne)
              - `billingFeeAmount` (gt, ge, lt, le, eq, ne)
              - `netFundedAmount` (gt, ge, lt, le, eq, ne)
              - `processor` (ne, eq, ct, nct)
              - `transferStatus` (ne, eq, in, nin)
              - `transferId` (ne, eq, in, nin)
              - `paypointLegalName` (ne, eq, ct, nct)
              - `paypointDbaName` (ne, eq, ct, nct)
              - `batchNumber` (ne, eq, ct, nct)
              - `batchId` (ne, eq, in, nin)
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferOutQueryResponse'
              example:
                Summary:
                  totalPages: 12
                  totalRecords: 234
                  pageSize: 20
                Records:
                  - transferId: 4521
                    paypointId: 892
                    batchNumber: null
                    batchCurrency: null
                    batchRecords: null
                    transferIdentifier: null
                    batchId: null
                    batchNetAmount: null
                    batchStatus: null
                    paypointEntryName: 47cade237
                    paypointLegalName: Solid Rock Concrete Coatings LLC
                    paypointDbaName: Solid Rock Coatings
                    paypointLogo: https://example.com/logos/solidrock.png
                    parentOrgName: Premier Property Services
                    parentOrgId: 77
                    parentOrgLogo: https://example.com/logos/premier.png
                    parentOrgEntryName: premierps
                    externalPaypointID: SR-892
                    bankAccount:
                      accountNumber: 4XXXXXX7231
                      routingNumber: '121000358'
                      bankName: Riverdale Community Bank
                    transferDate: '2025-01-15T14:30:00Z'
                    processor: BK
                    transferStatus: null
                    grossAmount: 2847.5
                    chargeBackAmount: null
                    returnedAmount: 0
                    holdAmount: 0
                    releasedAmount: 0
                    billingFeesAmount: 12.5
                    thirdPartyPaidAmount: null
                    adjustmentsAmount: null
                    netTransferAmount: 2835
                    splitAmount: null
                    eventsData:
                      - description: Payout funded
                        eventTime: '2025-01-15T14:28:45'
                        refData: ''
                        extraData: null
                        source: system
                    messages:
                      - Id: 8842
                        RoomId: 1205
                        UserId: 334
                        UserName: Maria Santos
                        Content: Transfer processed successfully
                        CreatedAt: '2025-01-15T14:30:00'
                        MessageType: 1
                        MessageProperties:
                          originalTransferStatus: pending
                          currentTransferStatus: completed
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/transfersOut/{entry}:
    get:
      operationId: query_ListTransfersOutPaypoint
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListTransfersOutPaypoint
      x-fern-request-name: ListTransfersOutPaypointRequest
      summary: Get list of outbound transfers for a paypoint
      description: Retrieve a list of outbound transfers for a paypoint. Use filters to limit results.
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 47cade237
        - 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
          example: 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
          example: 20
        - name: parameters
          in: query
          description: |-
            Collection of field names, conditions, and values used to filter the query. See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
            <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:

              - `transferDate` (gt, ge, lt, le, eq, ne)
              - `grossAmount` (gt, ge, lt, le, eq, ne)
              - `returnedAmount` (gt, ge, lt, le, eq, ne)
              - `billingFeeAmount` (gt, ge, lt, le, eq, ne)
              - `netFundedAmount` (gt, ge, lt, le, eq, ne)
              - `processor` (ne, eq, ct, nct)
              - `transferStatus` (ne, eq, in, nin)
              - `transferId` (ne, eq, in, nin)
              - `paypointLegalName` (ne, eq, ct, nct)
              - `paypointDbaName` (ne, eq, ct, nct)
              - `batchNumber` (ne, eq, ct, nct)
              - `batchId` (ne, eq, in, nin)
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferOutQueryResponse'
              example:
                Summary:
                  totalPages: 8
                  totalRecords: 156
                  pageSize: 20
                Records:
                  - transferId: 4521
                    paypointId: 892
                    batchNumber: null
                    batchCurrency: null
                    batchRecords: null
                    transferIdentifier: null
                    batchId: null
                    batchNetAmount: null
                    batchStatus: null
                    paypointEntryName: 47cade237
                    paypointLegalName: Solid Rock Concrete Coatings LLC
                    paypointDbaName: Solid Rock Coatings
                    paypointLogo: https://example.com/logos/solidrock.png
                    parentOrgName: Premier Property Services
                    parentOrgId: 77
                    parentOrgLogo: https://example.com/logos/premier.png
                    parentOrgEntryName: premierps
                    externalPaypointID: SR-892
                    bankAccount:
                      accountNumber: 4XXXXXX7231
                      routingNumber: '121000358'
                      bankName: Riverdale Community Bank
                    transferDate: '2025-01-15T14:30:00Z'
                    processor: BK
                    transferStatus: null
                    grossAmount: 2847.5
                    chargeBackAmount: null
                    returnedAmount: 0
                    holdAmount: 0
                    releasedAmount: 0
                    billingFeesAmount: 12.5
                    thirdPartyPaidAmount: null
                    adjustmentsAmount: null
                    netTransferAmount: 2835
                    splitAmount: null
                    eventsData:
                      - description: Payout funded
                        eventTime: '2025-01-15T14:28:45'
                        refData: ''
                        extraData: null
                        source: system
                    messages:
                      - Id: 8842
                        RoomId: 1205
                        UserId: 334
                        UserName: Maria Santos
                        Content: Transfer processed successfully
                        CreatedAt: '2025-01-15T14:30:00'
                        MessageType: 1
                        MessageProperties:
                          originalTransferStatus: pending
                          currentTransferStatus: completed
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/transferDetailsOut/{entry}/{transferId}:
    get:
      operationId: query_ListTransferDetailsOut
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListTransferDetailsOut
      x-fern-request-name: ListTransferDetailsOutRequest
      summary: Get outbound transfer details
      description: Retrieve details for a specific outbound transfer. Use filters to limit results.
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 47ace2b25
        - name: transferId
          in: path
          description: The numeric identifier for the transfer, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 4521
        - 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
          example: 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
          example: 20
        - name: parameters
          in: query
          description: |-
            Collection of field names, conditions, and values used to filter the query. See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
            <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:

              - `grossAmount` (gt, ge, lt, le, eq, ne)
              - `returnedAmount` (gt, ge, lt, le, eq, ne)
              - `billingFeeAmount` (gt, ge, lt, le, eq, ne)
              - `netFundedAmount` (gt, ge, lt, le, eq, ne)
              - `adjustmentAmount` (gt, ge, lt, le, eq, ne)
              - `transactionId` (eq, ne, in, nin)
              - `category` (eq, ne, ct, nct)
              - `type` (eq, ne, in, nin)
              - `method` (eq, ne, in, nin)
              - `walletType` (eq, ne, in, nin)
              - `splitFundingAmount` (gt, ge, lt, le, eq, ne)
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferOutDetailQueryResponse'
              example:
                Summary:
                  achReturns: 0
                  adjustments: 0
                  billingFees: 25
                  chargebacks: 0
                  grossTransferAmount: 4875
                  releaseAmount: 0
                  thirdPartyPaid: 0
                  totalNetAmountTransfer: 4850
                  netBatchAmount: 0
                  splitAmount: 0
                  serviceFees: 0
                  transferAmount: 0
                  refunds: 0
                  heldAmount: 0
                  totalRecords: 156
                  totalAmount: 0
                  totalNetAmount: 0
                  totalPages: 8
                  pageSize: 20
                  pageidentifier: null
                Records:
                  - transferDetailId: 9847
                    transferId: 4521
                    transactionId: 01KXYZ789ABC123DEF456GHI
                    IdOut: 88234
                    method: null
                    type: Debit
                    category: grouped
                    grossAmount: 1250
                    returnedAmount: 0
                    refundAmount: 0
                    holdAmount: 0
                    releasedAmount: 0
                    billingFeesAmount: 5
                    adjustmentsAmount: 0
                    netTransferAmount: 1245
                    billingFeesDetails: null
                    CreatedAt: '2025-01-15T10:22:18'
                    Comments: Epoxy floor coating materials
                    Vendor:
                      VendorNumber: V-CC-2847
                      Name1: Concrete Supply Distributors
                      Name2: null
                      EIN: XXXXX4567
                      Phone: (512) 555-0147
                      Email: accounts@concretesupply.example.com
                      RemitEmail: payments@concretesupply.example.com
                      Address1: 4200 Industrial Parkway
                      Address2: Unit B
                      City: Austin
                      State: TX
                      Zip: '78745'
                      Country: US
                      Mcc: '5039'
                      LocationCode: null
                      Contacts:
                        - ContactName: Robert Chen
                          ContactEmail: rchen@concretesupply.example.com
                          ContactTitle: Accounts Receivable
                          ContactPhone: (512) 555-0148
                      BillingData: null
                      PaymentMethod: ach
                      VendorStatus: 1
                      VendorId: 24891
                      EnrollmentStatus: null
                      Summary: null
                      PaypointLegalname: Solid Rock Concrete Coatings LLC
                      PaypointId: null
                      PaypointDbaname: Solid Rock Coatings
                      PaypointEntryname: 47cade237
                      ParentOrgName: Premier Property Services
                      ParentOrgId: 77
                      CreatedDate: '2024-08-12T09:15:00'
                      LastUpdated: '2025-01-10T14:30:22'
                      remitAddress1: 4200 Industrial Parkway
                      remitAddress2: Unit B
                      remitCity: Austin
                      remitState: TX
                      remitZip: '78745'
                      remitCountry: US
                      payeeName1: null
                      payeeName2: null
                      customField1: ''
                      customField2: ''
                      customerVendorAccount: SRCC-001847
                      InternalReferenceId: 3392
                      additionalData: null
                      externalPaypointID: SR-892
                      StoredMethods: null
                    PaypointDbaname: Solid Rock Coatings
                    PaypointLegalname: Solid Rock Concrete Coatings LLC
                    PaypointId: 892
                    Status: 2
                    PaymentId: 01KXYZ789ABC123DEF456GHI
                    TransId: null
                    TransStatus: null
                    TransStatusDetail: null
                    TransStatusName: null
                    TransStatusCategory: null
                    LastUpdated: '2025-01-15T10:23:05'
                    TotalAmount: 1250
                    NetAmount: 1245
                    FeeAmount: 5
                    Source: api
                    ParentOrgName: Premier Property Services
                    ParentOrgId: 77
                    BatchNumber: b7c3e891-4f2a-4d8e-9a1b-c5d6e7f8a9b0
                    PaymentStatus: Processing
                    PaymentMethod: ach
                    CardToken: null
                    CheckNumber: ''
                    CheckData: null
                    PaymentData:
                      MaskedAccount: 7XXXXXX4523
                      AccountType: checking
                      AccountExp: ''
                      AccountZip: ''
                      HolderName: null
                      StoredId: f8e7d6c5-b4a3-9281-7654-321098fedcba
                      Initiator: null
                      StoredMethodUsageType: null
                      Sequence: null
                      orderDescription: Epoxy floor coating materials
                      cloudSignatureData: null
                      cloudSignatureFormat: null
                      paymentDetails: null
                      payorData: null
                      accountId: bankOut1
                      bankAccount: null
                      gatewayConnector: null
                      binData: null
                    Bills:
                      - billId: 78234
                        LotNumber: LOT-2025-0115
                        AccountingField1: null
                        AccountingField2: null
                        Terms: null
                        AdditionalData: null
                        attachments: null
                        invoiceNumber: INV-2025-00892
                        netAmount: '1250.00'
                        invoiceDate: '2025-01-10T00:00:00'
                        dueDate: '2025-02-09'
                        comments: 50 gal epoxy primer, 25 gal topcoat - Project Riverside Plaza
                        identifier: null
                        discount: null
                        totalAmount: null
                    Events:
                      - TransEvent: 'Risk Validated: PASSED'
                        EventData: ''
                        EventTime: '2025-01-15T10:22:20'
                      - TransEvent: Captured
                        EventData: 0ABC123XYZ789:00000012
                        EventTime: '2025-01-15T10:22:25'
                    externalPaypointID: SR-892
                    EntryName: 47cade237
                    Gateway: bank
                    BatchId: 12847
                    HasVcardTransactions: null
                    IsSameDayACH: false
                    ScheduleId: 0
                    SettlementStatus: Pending
                    SettlementStatusName: ''
                    SettlementDate: null
                    RiskFlagged: false
                    RiskFlaggedOn: '2025-01-15T10:22:18'
                    RiskStatus: PASSED
                    RiskReason: ''
                    RiskAction: ''
                    RiskActionCode: 0
                    PayoutProgram: ODP
                    AchTraceNumber: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/users/org/{orgId}:
    get:
      operationId: query_ListUsersOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListUsersOrg
      x-fern-request-name: ListUsersOrgRequest
      summary: Get list of users for an org
      description: Get list of users for an org. Use filters to limit results.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - 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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            **List of field names accepted:**

            - `createdDate` (gt, ge, lt, le, eq, ne)
            - `name`  (ne, eq, ct, nct)
            - `email`  (ne, eq, ct, nct)
            - `status`   (in, nin, eq, ne)
            - `role.xxx`  (ne, eq, ct, nct) where xxx is the role field: `roleLabel` or `roleValue`

            **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 separated by "|"
            - `nin` => not inside array separated by "|"

            **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: `name(ct)=john`  return all records with name containing 'john'.
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryUserResponse'
              example:
                Records:
                  - Access:
                      - roleValue: true
                    AdditionalData: AdditionalData
                    createdAt: '2022-07-01T15:00:01Z'
                    Email: example@email.com
                    language: en
                    lastAccess: '2022-07-01T15:00:01Z'
                    Name: Sean Smith
                    Phone: '5555555555'
                    Scope:
                      - orgType: 0
                    snData: snData
                    snIdentifier: snIdentifier
                    snProvider: google
                    timeZone: -5
                    userId: 1000000
                    UsrMFA: false
                    UsrMFAMode: 0
                    UsrStatus: 1
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 77.22
                  totalNetAmount: 77.22
                  totalPages: 2
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/users/point/{entry}:
    get:
      operationId: query_ListUsersPaypoint
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListUsersPaypoint
      x-fern-request-name: ListUsersPaypointRequest
      summary: Get list of users for paypoint
      description: Get list of users for a paypoint. Use filters to limit results.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - 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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            **List of field names accepted:**

            - `createdDate` (gt, ge, lt, le, eq, ne)
            - `name`  (ne, eq, ct, nct)
            - `email`  (ne, eq, ct, nct)
            - `status`   (in, nin, eq, ne)
            - `role.xxx`  (ne, eq, ct, nct) where xxx is the role field: `roleLabel` or `roleValue`

            **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 separated by "|"
            - `nin` => not inside array separated by "|"

            **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: `name(ct)=john`  return all records with name containing 'john'
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryUserResponse'
              example:
                Records:
                  - Access:
                      - roleValue: true
                    AdditionalData: AdditionalData
                    createdAt: '2022-07-01T15:00:01Z'
                    Email: example@email.com
                    language: en
                    lastAccess: '2022-07-01T15:00:01Z'
                    Name: Sean Smith
                    Phone: '5555555555'
                    Scope:
                      - orgType: 0
                    snData: snData
                    snIdentifier: snIdentifier
                    snProvider: google
                    timeZone: -5
                    userId: 1000000
                    UsrMFA: false
                    UsrMFAMode: 0
                    UsrStatus: 1
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 77.22
                  totalNetAmount: 77.22
                  totalPages: 2
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/vendors/{entry}:
    get:
      operationId: query_ListVendors
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListVendors
      x-fern-request-name: ListVendorsRequest
      summary: Get list of vendors for entrypoint
      description: Retrieve a list of vendors for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `method` (in, nin, eq, ne)
            - `enrollmentStatus` (in,nin, eq, ne)
            - `status` (in, nin, eq, ne)
            - `vendorNumber` (ct, nct, eq, ne)
            - `name` (ct, nct, eq, ne)
            - `ein` (ct, nct, eq, ne)
            - `phone` (ct, nct, eq, ne)
            - `email` (ct, nct, eq, ne)
            - `remitEmail` (ct, nct, eq, ne)
            - `address` (ct, nct, eq, ne)
            - `city` (ct, nct, eq, ne)
            - `state` (ct, nct, eq, ne)
            - `country` (ct, nct, eq, ne)
            - `zip` (ct, nct, eq, ne)
            - `mcc` (ct, nct, eq, ne)
            - `locationCode` (ct, nct, eq, ne)
            - `paypointLegal` (ne, eq, ct, nct)
            - `parentOrgId` (ne, eq, nin, in)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, 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 separated by "|"
            - nin => not inside array separated by "|"

            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: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseVendors'
              example:
                Records:
                  - VendorNumber: '1234'
                    Name1: Herman's Coatings
                    Name2: Herman's Coating Supply Company, LLC
                    EIN: '123456789'
                    Phone: '2125551234'
                    Email: example@email.com
                    RemitEmail: null
                    Address1: 123 Ocean Drive
                    Address2: Suite 400
                    City: Bristol
                    State: GA
                    Zip: '31113'
                    Country: US
                    Mcc: '7777'
                    LocationCode: LOC123
                    Contacts:
                      ContactEmail: eric@martinezcoatings.com
                      ContactName: Eric Martinez
                      ContactPhone: '5555555555'
                      ContactTitle: Owner
                    BillingData:
                      id: 123456
                      accountId: bank-account-001
                      nickname: Main Checking Account
                      bankName: Example Bank
                      routingAccount: '123456789'
                      accountNumber: '9876543210'
                      typeAccount: Checking
                      bankAccountHolderName: John Doe
                      bankAccountHolderType: Business
                      bankAccountFunction: 2
                      verified: true
                      status: 1
                      services: []
                      default: true
                    PaymentMethod: null
                    VendorStatus: 1
                    VendorId: 1
                    EnrollmentStatus: null
                    Summary:
                      ActiveBills: 2
                      PendingBills: 4
                      InTransitBills: 3
                      PaidBills: 18
                      OverdueBills: 1
                      ApprovedBills: 5
                      DisapprovedBills: 1
                      TotalBills: 34
                      ActiveBillsAmount: 1250.75
                      PendingBillsAmount: 2890.5
                      InTransitBillsAmount: 1675.25
                      PaidBillsAmount: 15420.8
                      OverdueBillsAmount: 425
                      ApprovedBillsAmount: 3240.9
                      DisapprovedBillsAmount: 180
                      TotalBillsAmount: 25083.2
                    PaypointLegalname: Sunshine Services, LLC
                    PaypointDbaname: Sunshine Gutters
                    PaypointEntryname: d193cf9a46
                    ParentOrgName: PropertyManager Pro
                    ParentOrgId: 1000
                    CreatedDate: '2022-07-01T15:00:01Z'
                    LastUpdated: '2022-07-01T15:00:01Z'
                    remitAddress1: 123 Walnut Street
                    remitAddress2: Suite 900
                    remitCity: Miami
                    remitState: FL
                    remitZip: '31113'
                    remitCountry: US
                    payeeName1: payeeName1
                    payeeName2: payeeName2
                    customField1: ''
                    customField2: ''
                    customerVendorAccount: 123-456
                    InternalReferenceId: 1000000
                    PaymentPortalUrl: https://greenfield-landscaping.com/pay
                    CardAccepted: 'yes'
                    AchAccepted: unable to determine
                    EnrichmentStatus: fully_enriched
                    EnrichedBy: web_search
                    EnrichedAt: '2026-03-05T14:22:10Z'
                    EnrichmentId: enrich-3890-a1b2c3d4
                    additionalData: null
                    externalPaypointID: Paypoint-100
                    StoredMethods: []
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 200
                  totalNetAmount: 77.22
                  totalPages: 1
                  totalRecords: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/vendors/org/{orgId}:
    get:
      operationId: query_ListVendorsOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListVendorsOrg
      x-fern-request-name: ListVendorsOrgRequest
      summary: Get list of vendors for organization
      description: Retrieve a list of vendors for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `method` (in, nin, eq, ne)
            - `enrollmentStatus` (in,nin, eq, ne)
            - `status` (in, nin, eq, ne)
            - `vendorNumber` (ct, nct, eq, ne)
            - `name` (ct, nct, eq, ne)
            - `ein` (ct, nct, eq, ne)
            - `phone` (ct, nct, eq, ne)
            - `email` (ct, nct, eq, ne)
            - `remitEmail` (ct, nct, eq, ne)
            - `address` (ct, nct, eq, ne)
            - `city` (ct, nct, eq, ne)
            - `state` (ct, nct, eq, ne)
            - `country` (ct, nct, eq, ne)
            - `zip` (ct, nct, eq, ne)
            - `mcc` (ct, nct, eq, ne)
            - `locationCode` (ct, nct, eq, ne)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `parentOrgId` (ne, eq, nin, in)
            - `orgName` (ne, eq, 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 separated by "|"
            - nin => not inside array separated by "|"

            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: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseVendors'
              example:
                Records:
                  - VendorNumber: '1234'
                    Name1: Herman's Coatings
                    Name2: Herman's Coating Supply Company, LLC
                    EIN: '123456789'
                    Phone: '2125551234'
                    Email: example@email.com
                    RemitEmail: null
                    Address1: 123 Ocean Drive
                    Address2: Suite 400
                    City: Bristol
                    State: GA
                    Zip: '31113'
                    Country: US
                    Mcc: '7777'
                    LocationCode: LOC123
                    Contacts:
                      ContactEmail: eric@martinezcoatings.com
                      ContactName: Eric Martinez
                      ContactPhone: '5555555555'
                      ContactTitle: Owner
                    BillingData:
                      id: 123456
                      accountId: bank-account-001
                      nickname: Main Checking Account
                      bankName: Example Bank
                      routingAccount: '123456789'
                      accountNumber: '9876543210'
                      typeAccount: Checking
                      bankAccountHolderName: John Doe
                      bankAccountHolderType: Business
                      bankAccountFunction: 2
                      verified: true
                      status: 1
                      services: []
                      default: true
                    PaymentMethod: null
                    VendorStatus: 1
                    VendorId: 1
                    EnrollmentStatus: null
                    Summary:
                      ActiveBills: 2
                      PendingBills: 4
                      InTransitBills: 3
                      PaidBills: 18
                      OverdueBills: 1
                      ApprovedBills: 5
                      DisapprovedBills: 1
                      TotalBills: 34
                      ActiveBillsAmount: 1250.75
                      PendingBillsAmount: 2890.5
                      InTransitBillsAmount: 1675.25
                      PaidBillsAmount: 15420.8
                      OverdueBillsAmount: 425
                      ApprovedBillsAmount: 3240.9
                      DisapprovedBillsAmount: 180
                      TotalBillsAmount: 25083.2
                    PaypointLegalname: Sunshine Services, LLC
                    PaypointDbaname: Sunshine Gutters
                    PaypointEntryname: d193cf9a46
                    ParentOrgName: PropertyManager Pro
                    ParentOrgId: 1000
                    CreatedDate: '2022-07-01T15:00:01Z'
                    LastUpdated: '2022-07-01T15:00:01Z'
                    remitAddress1: 123 Walnut Street
                    remitAddress2: Suite 900
                    remitCity: Miami
                    remitState: FL
                    remitZip: '31113'
                    remitCountry: US
                    payeeName1: payeeName1
                    payeeName2: payeeName2
                    customField1: ''
                    customField2: ''
                    customerVendorAccount: 123-456
                    InternalReferenceId: 1000000
                    PaymentPortalUrl: https://greenfield-landscaping.com/pay
                    CardAccepted: 'yes'
                    AchAccepted: unable to determine
                    EnrichmentStatus: fully_enriched
                    EnrichedBy: web_search
                    EnrichedAt: '2026-03-05T14:22:10Z'
                    EnrichmentId: enrich-3890-a1b2c3d4
                    additionalData: null
                    externalPaypointID: Paypoint-100
                    StoredMethods: []
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 200
                  totalNetAmount: 77.22
                  totalPages: 1
                  totalRecords: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/vcards/{entry}:
    get:
      operationId: query_ListVcards
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListVcards
      x-fern-request-name: ListVcardsRequest
      summary: Get list of virtual cards for entrypoint
      description: Retrieve a list of vcards (virtual credit cards) issued for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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:

              - `status` (eq, ne, ct, nct, sw, ew)
              - `createdAt` (gt, ge, lt, le, eq, ne)
              - `cardToken` (ct, nct, eq, ne)
              - `lastFour` (ct, nct, eq, ne)
              - `expirationDate` (ct, nct, eq, ne)
              - `payoutId` (eq, ne, gt, ge, lt, le)
              - `vendorId` (eq, ne, gt, ge, lt, le)
              - `miscData1` (ct, nct, eq, ne)
              - `miscData2` (ct, nct, eq, ne)
              - `currentUses` (gt, ge, lt, le, eq, ne)
              - `amount` (gt, ge, lt, le, eq, ne)
              - `balance` (gt, ge, lt, le, eq, ne)
              - `paypointLegal` (ne, eq, ct, nct)
              - `paypointDba` (ne, eq, ct, nct)
              - `orgName` (eq, ne, ct, nct, sw, ew)
              - `externalPaypointId` (ct, nct, eq, ne)
              - `paypointId` (eq, ne, gt, ge, lt, le)
              - `cardType` (eq, ne, gt, ge, lt, le)

            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
              - sw => starts with
              - ew => ends with
              - in => inside array separated by "|"
              - nin => not inside array separated by "|"
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VCardQueryResponse'
              example:
                Records:
                  - vcardSent: true
                    cardType: 0
                    cardToken: vcrd_5Ty8NrBzXjKuqHm9DwElfP
                    cardNumber: 44XX XXXX XXXX 1234
                    cvc: XXX
                    expirationDate: 2025-12
                    status: Active
                    amount: 500
                    currentBalance: 375.25
                    expenseLimit: 100
                    expenseLimitPeriod: monthly
                    maxNumberOfUses: 10
                    currentNumberOfUses: 3
                    exactAmount: false
                    mcc: '5812'
                    tcc: T01
                    misc1: 'Invoice #12345'
                    misc2: 'Project: Office Supplies'
                    dateCreated: '2023-01-15T09:30:00Z'
                    dateModified: '2023-02-20T14:15:22Z'
                    associatedVendor:
                      VendorNumber: V-12345
                      Name1: Office Supply Co.
                      EIN: XXXXX6789
                      Email: billing@officesupply.example.com
                      VendorId: 1542
                    associatedCustomer:
                      firstname: Acme
                      lastname: Corporation
                    PaypointDbaname: Global Factory LLC
                    PaypointLegalname: Global Factory LLC
                    PaypointEntryname: 4872acb376a
                    externalPaypointID: pay-10
                    ParentOrgName: SupplyPro
                    paypointId: 236
                Summary:
                  pageidentifier: XXXXXXXXXXXXXX
                  pageSize: 20
                  totalAmount: 2500
                  totalNetAmount: 0
                  totalactive: 5
                  totalamountactive: 2500
                  totalbalanceactive: 1875.25
                  totalPages: 1
                  totalRecords: 5
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/vcardsTransactions/{entry}:
    get:
      operationId: query_ListVcardsTransactions
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListVcardsTransactions
      x-fern-request-name: ListVcardsTransactionsRequest
      summary: Get list of virtual card transactions for entrypoint
      description: Retrieve a list of virtual card transactions for an entrypoint. Use filters to limit results.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec329267
        - 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
          example: 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
          example: 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/vcardsTransactions/8cfec329267?parameters=transactionAmount(gt)=100&limitRecord=20

              should become:

              --url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/8cfec329267?transactionAmount(gt)=100&limitRecord=20
            </Info>

            List of field names accepted:

              - `identifier` (eq, ne, ct, nct)
              - `transactionType` (eq, ne, ct, nct)
              - `transactionStatus` (eq, ne, ct, nct, in, nin)
              - `transactionAmount` (eq, ne, gt, ge, lt, le, ct, nct)
              - `transactionCreatedOn` (eq, ne, gt, ge, lt, le)
              - `cardToken` (ct, nct, eq, ne)
              - `lastFour` (ct, nct, eq, ne)
              - `expirationDate` (ct, nct, eq, ne)
              - `mcc` (ct, nct, eq, ne)
              - `payoutId` (gt, lt, eq, ne)
              - `customerId` (gt, lt, eq, ne)
              - `vendorId` (gt, lt, eq, ne)
              - `miscData1` (ct, nct, eq, ne)
              - `miscData2` (ct, nct, eq, ne)
              - `currentUses` (gt, ge, lt, le, eq, ne)
              - `amount` (gt, ge, lt, le, eq, ne)
              - `balance` (gt, ge, lt, le, eq, ne)
              - `paypointLegal` (ne, eq, ct, nct)
              - `paypointDba` (ne, eq, ct, nct)
              - `orgName` (ne, eq, ct, nct, in, nin)
              - `externalPaypointID` (ct, nct, eq, ne)
              - `paypointId` (gt, lt, eq, ne)

            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 separated by "|"
              - nin => not inside array separated by "|"
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(CreatedOn)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VCardTransactionQueryResponse'
              example:
                Summary:
                  totalPages: 20
                  totalRecords: 393
                  totalAmount: 231.58
                  totalactive: 388
                  totalamountactive: 219.58
                  totalbalanceactive: -213.83
                Records:
                  - Identifier: 7HQ2P9B4XD
                    CardToken: 5RJ8MN2KC4
                    LastFour: '1234'
                    ExpirationDate: 06-30-2029
                    Mcc: '5943'
                    PayoutId: 84210
                    CustomerId: 1542
                    VendorId: 9821
                    MiscData1: 'Invoice #12345'
                    MiscData2: 'Project: Office Supplies'
                    CurrentUses: 1
                    Amount: 500
                    Balance: 425.5
                    PaypointId: 236
                    PaypointLegal: Global Factory LLC
                    PaypointDba: Global Factory
                    ExternalPaypointID: pay-10
                    OrgName: SupplyPro
                    Type: AUTHORIZATION
                    Status: AUTHORIZATION
                    CreatedOn: '2026-05-05 03:28:53.082830'
                    TransactionAmount: '74.500'
                    PostedAmount: '0.000'
                    PostedOn: null
                    MerchantName: Office Supply Co.
                    AuthorizationStatus: AUTHORIZATION
                    ReasonToDecline: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/vcardsTransactions/org/{orgId}:
    get:
      operationId: query_ListVcardsTransactionsOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListVcardsTransactionsOrg
      x-fern-request-name: ListVcardsTransactionsOrgRequest
      summary: Get list of virtual card transactions for an organization
      description: Retrieve a list of virtual card transactions for an organization. Use filters to limit results.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - 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
          example: 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
          example: 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/vcardsTransactions/org/236?parameters=transactionAmount(gt)=100&limitRecord=20

              should become:

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

            List of field names accepted:

              - `identifier` (eq, ne, ct, nct)
              - `transactionType` (eq, ne, ct, nct)
              - `transactionStatus` (eq, ne, ct, nct, in, nin)
              - `transactionAmount` (eq, ne, gt, ge, lt, le, ct, nct)
              - `transactionCreatedOn` (eq, ne, gt, ge, lt, le)
              - `cardToken` (ct, nct, eq, ne)
              - `lastFour` (ct, nct, eq, ne)
              - `expirationDate` (ct, nct, eq, ne)
              - `mcc` (ct, nct, eq, ne)
              - `payoutId` (gt, lt, eq, ne)
              - `customerId` (gt, lt, eq, ne)
              - `vendorId` (gt, lt, eq, ne)
              - `miscData1` (ct, nct, eq, ne)
              - `miscData2` (ct, nct, eq, ne)
              - `currentUses` (gt, ge, lt, le, eq, ne)
              - `amount` (gt, ge, lt, le, eq, ne)
              - `balance` (gt, ge, lt, le, eq, ne)
              - `paypointLegal` (ne, eq, ct, nct)
              - `paypointDba` (ne, eq, ct, nct)
              - `orgName` (ne, eq, ct, nct, in, nin)
              - `externalPaypointID` (ct, nct, eq, ne)
              - `paypointId` (gt, lt, eq, ne)

            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 separated by "|"
              - nin => not inside array separated by "|"
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(CreatedOn)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VCardTransactionQueryResponse'
              example:
                Summary:
                  totalPages: 20
                  totalRecords: 393
                  totalAmount: 231.58
                  totalactive: 388
                  totalamountactive: 219.58
                  totalbalanceactive: -213.83
                Records:
                  - Identifier: 7HQ2P9B4XD
                    CardToken: 5RJ8MN2KC4
                    LastFour: '1234'
                    ExpirationDate: 06-30-2029
                    Mcc: '5943'
                    PayoutId: 84210
                    CustomerId: 1542
                    VendorId: 9821
                    MiscData1: 'Invoice #12345'
                    MiscData2: 'Project: Office Supplies'
                    CurrentUses: 1
                    Amount: 500
                    Balance: 425.5
                    PaypointId: 236
                    PaypointLegal: Global Factory LLC
                    PaypointDba: Global Factory
                    ExternalPaypointID: pay-10
                    OrgName: SupplyPro
                    Type: AUTHORIZATION
                    Status: AUTHORIZATION
                    CreatedOn: '2026-05-05 03:28:53.082830'
                    TransactionAmount: '74.500'
                    PostedAmount: '0.000'
                    PostedOn: null
                    MerchantName: Office Supply Co.
                    AuthorizationStatus: AUTHORIZATION
                    ReasonToDecline: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/vcards/org/{orgId}:
    get:
      operationId: query_ListVcardsOrg
      tags:
        - Query
      x-fern-sdk-group-name: query
      x-fern-sdk-method-name: ListVcardsOrg
      x-fern-request-name: ListVcardsOrgRequest
      summary: Get list of virtual cards for an organization
      description: Retrieve a list of vcards (virtual credit cards) issued for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - 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:

              - `status` (eq, ne, ct, nct, sw, ew)
              - `createdAt` (gt, ge, lt, le, eq, ne)
              - `cardToken` (ct, nct, eq, ne)
              - `lastFour` (ct, nct, eq, ne)
              - `expirationDate` (ct, nct, eq, ne)
              - `payoutId` (eq, ne, gt, ge, lt, le)
              - `vendorId` (eq, ne, gt, ge, lt, le)
              - `miscData1` (ct, nct, eq, ne)
              - `miscData2` (ct, nct, eq, ne)
              - `currentUses` (gt, ge, lt, le, eq, ne)
              - `amount` (gt, ge, lt, le, eq, ne)
              - `balance` (gt, ge, lt, le, eq, ne)
              - `paypointLegal` (ne, eq, ct, nct)
              - `paypointDba` (ne, eq, ct, nct)
              - `orgName` (eq, ne, ct, nct, sw, ew)
              - `externalPaypointId` (ct, nct, eq, ne)
              - `paypointId` (eq, ne, gt, ge, lt, le)
              - `cardType` (eq, ne, gt, ge, lt, le)

            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
              - sw => starts with
              - ew => ends with
              - in => inside array separated by "|"
              - nin => not inside array separated by "|"
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VCardQueryResponse'
              example:
                Records:
                  - vcardSent: true
                    cardType: 0
                    cardToken: vcrd_5Ty8NrBzXjKuqHm9DwElfP
                    cardNumber: 44XX XXXX XXXX 1234
                    cvc: XXX
                    expirationDate: 2025-12
                    status: Active
                    amount: 500
                    currentBalance: 375.25
                    expenseLimit: 100
                    expenseLimitPeriod: monthly
                    maxNumberOfUses: 10
                    currentNumberOfUses: 3
                    exactAmount: false
                    mcc: '5812'
                    tcc: T01
                    misc1: 'Invoice #12345'
                    misc2: 'Project: Office Supplies'
                    dateCreated: '2023-01-15T09:30:00Z'
                    dateModified: '2023-02-20T14:15:22Z'
                    associatedVendor:
                      VendorNumber: V-12345
                      Name1: Office Supply Co.
                      EIN: XXXXX6789
                      Email: billing@officesupply.example.com
                      VendorId: 1542
                    associatedCustomer:
                      firstname: Acme
                      lastname: Corporation
                    PaypointDbaname: Global Factory LLC
                    PaypointLegalname: Global Factory LLC
                    PaypointEntryname: 4872acb376a
                    externalPaypointID: pay-10
                    ParentOrgName: SupplyPro
                    paypointId: 236
                Summary:
                  pageidentifier: XXXXXXXXXXXXXX
                  pageSize: 20
                  totalAmount: 2500
                  totalNetAmount: 0
                  totalactive: 5
                  totalamountactive: 2500
                  totalbalanceactive: 1875.25
                  totalPages: 1
                  totalRecords: 5
  /Import/ocrDocumentForm/{typeResult}:
    post:
      operationId: ocr_OcrDocumentForm
      tags:
        - Ocr
      x-fern-sdk-group-name: ocr
      x-fern-sdk-method-name: OcrDocumentForm
      x-fern-request-name: OcrDocumentFormRequest
      description: Use this endpoint to upload an image file for OCR processing. The accepted file formats include PDF, JPG, JPEG, PNG, and GIF. Specify the desired type of result (either 'bill' or 'invoice') in the path parameter `typeResult`. The response will contain the OCR processing results, including extracted data such as bill number, vendor information, bill items, and more.
      security:
        - APIKeyAuth: []
      parameters:
        - name: typeResult
          in: path
          required: true
          description: The type of object to create in Payabli. Accepted values are `bill` and `invoice`.
          schema:
            $ref: '#/components/schemas/typeResult'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileContentImageOnly'
      responses:
        '200':
          description: OCR document processing result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseOCR'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Import/ocrDocumentJson/{typeResult}:
    post:
      operationId: ocr_OcrDocumentJson
      tags:
        - Ocr
      x-fern-sdk-group-name: ocr
      x-fern-sdk-method-name: OcrDocumentJson
      x-fern-request-name: OcrDocumentJsonRequest
      description: Use this endpoint to submit a Base64-encoded image file for OCR processing. The accepted file formats include PDF, JPG, JPEG, PNG, and GIF. Specify the desired type of result (either 'bill' or 'invoice') in the path parameter `typeResult`. The response will contain the OCR processing results, including extracted data such as bill number, vendor information, bill items, and more.
      security:
        - APIKeyAuth: []
      parameters:
        - name: typeResult
          in: path
          required: true
          description: The type of object to create in Payabli. Accepted values are `bill` and `invoice`.
          schema:
            $ref: '#/components/schemas/typeResult'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileContentImageOnly'
      responses:
        '200':
          description: OCR document processing result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseOCR'
  /v2/notificationlogs:
    post:
      operationId: notificationlogs_searchNotificationLogs
      tags:
        - Notificationlogs
      x-fern-sdk-group-name: notificationlogs
      x-fern-sdk-method-name: searchNotificationLogs
      x-fern-request-name: SearchNotificationLogsRequest
      description: |-
        Search notification logs with filtering and pagination.
          - Start date and end date cannot be more than 30 days apart
          - Either `orgId` or `paypointId` must be provided

        This endpoint requires the `notifications_create` OR `notifications_read` permission.
      security:
        - APIKeyAuth: []
      parameters:
        - name: PageSize
          in: query
          required: false
          description: Number of records on each response page.
          schema:
            $ref: '#/components/schemas/Pagesize'
          example: 20
        - name: Page
          in: query
          description: The page number to retrieve. Defaults to 1 if not provided.
          required: false
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationLogSearchRequest'
            example:
              startDate: '2024-01-01T00:00:00Z'
              endDate: '2024-01-31T23:59:59Z'
              orgId: 12345
              notificationEvent: ActivatedMerchant
              succeeded: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NotificationLog'
              example:
                - id: 550e8400-e29b-41d4-a716-446655440000
                  orgId: 12345
                  paypointId: 67890
                  notificationEvent: ActivatedMerchant
                  target: https://webhook.example.com/payments
                  responseStatus: '200'
                  success: true
                  jobData: '{"transactionId":"txn_123"}'
                  createdDate: '2024-01-15T10:30:00Z'
                  successDate: '2024-01-15T10:30:05Z'
                  lastFailedDate: null
                  isInProgress: false
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /v2/notificationlogs/{uuid}:
    get:
      operationId: notificationlogs_getNotificationLog
      tags:
        - Notificationlogs
      x-fern-sdk-group-name: notificationlogs
      x-fern-sdk-method-name: getNotificationLog
      x-fern-request-name: getNotificationLogRequest
      description: |-
        Get detailed information for a specific notification log entry.
        This endpoint requires the `notifications_create` OR `notifications_read` permission.
      security:
        - APIKeyAuth: []
      parameters:
        - name: uuid
          in: path
          description: The notification log entry.
          required: true
          schema:
            type: string
            format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLogDetail'
              example:
                id: 550e8400-e29b-41d4-a716-446655440000
                orgId: 12345
                paypointId: 67890
                notificationEvent: ActivatedMerchant
                target: https://webhook.example.com/payments
                responseStatus: '200'
                success: true
                jobData: '{"transactionId":"txn_123"}'
                createdDate: '2024-01-15T10:30:00Z'
                successDate: '2024-01-15T10:30:05Z'
                lastFailedDate: null
                isInProgress: false
                webHeaders:
                  - key: Content-Type
                    value: application/json
                  - key: User-Agent
                    value: PaymentSystem/1.0
                responseHeaders:
                  - key: Content-Type
                    value:
                      - application/json
                  - key: X-Request-ID
                    value:
                      - req_abc123
                responseContent: '{"status":"received","id":"wh_123"}'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /v2/notificationlogs/{uuid}/retry:
    get:
      operationId: notificationlogs_retryNotificationLog
      tags:
        - Notificationlogs
      x-fern-sdk-group-name: notificationlogs
      x-fern-sdk-method-name: retryNotificationLog
      x-fern-request-name: retryNotificationLogRequest
      description: |-
        Retry sending a specific notification.

        **Permissions:** notifications_create
      security:
        - APIKeyAuth: []
      parameters:
        - name: uuid
          in: path
          description: Unique id
          required: true
          schema:
            type: string
            format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationLogDetail'
              example:
                id: 550e8400-e29b-41d4-a716-446655440000
                orgId: 12345
                paypointId: 67890
                notificationEvent: ActivatedMerchant
                target: https://webhook.example.com/payments
                responseStatus: '200'
                success: true
                jobData: '{"transactionId":"txn_123"}'
                createdDate: '2024-01-15T10:30:00Z'
                successDate: '2024-01-15T10:30:05Z'
                lastFailedDate: null
                isInProgress: false
                webHeaders:
                  - key: Content-Type
                    value: application/json
                responseHeaders:
                  - key: Content-Type
                    value:
                      - application/json
                responseContent: '{"status":"received","id":"wh_123"}'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /v2/notificationlogs/retry:
    post:
      operationId: notificationlogs_bulkRetryNotificationLogs
      tags:
        - Notificationlogs
      x-fern-sdk-group-name: notificationlogs
      x-fern-sdk-method-name: bulkRetryNotificationLogs
      x-fern-request-name: bulkRetryNotificationLogsRequest
      description: |-
        Retry sending multiple notifications (maximum 50 IDs).
        This is an async process, so use the search endpoint again to check the notification status.

        This endpoint requires the `notifications_create` permission.
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRetryRequest'
      responses:
        '201':
          description: A success response indicating the notifications are being retried. This is an async process, so refresh the search to see updated status.
  /Cloud/register/{entry}:
    post:
      operationId: cloud_addDevice
      tags:
        - Cloud
      x-fern-sdk-group-name: cloud
      x-fern-sdk-method-name: addDevice
      x-fern-request-name: DeviceEntry
      summary: Register cloud device
      description: Register a cloud device to an entrypoint. See [Devices Quickstart](/developers/developer-guides/devices-quickstart#devices-quickstart) for a complete guide.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceEntry'
            example:
              registrationCode: YS7DS5
              description: Front Desk POS
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddDeviceResponse'
              example:
                isSuccess: true
                responseData: 6c361c7d-674c-44cc-b790-382b75d1xxx
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Cloud/register/{entry}/{deviceId}:
    delete:
      operationId: cloud_RemoveDevice
      tags:
        - Cloud
      x-fern-sdk-group-name: cloud
      x-fern-sdk-method-name: RemoveDevice
      x-fern-request-name: RemoveDeviceRequest
      summary: Unregister cloud device
      description: Remove a cloud device from an entrypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: deviceId
          in: path
          description: ID of the cloud device.
          required: true
          schema:
            type: string
          example: 6c361c7d-674c-44cc-b790-382b75d1xxx
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveDeviceResponse'
              example:
                isSuccess: true
                responseData: 6c361c7d-674c-44cc-b790-382b75d1xxx
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Cloud/history/{entry}/{deviceId}:
    get:
      operationId: cloud_HistoryDevice
      tags:
        - Cloud
      x-fern-sdk-group-name: cloud
      x-fern-sdk-method-name: HistoryDevice
      x-fern-request-name: HistoryDeviceRequest
      summary: Get registration history for device
      description: Retrieve the registration history for a device.
      security:
        - APIKeyAuth: []
      parameters:
        - name: deviceId
          in: path
          description: ID of the cloud device.
          required: true
          schema:
            type: string
          example: WXGDWB
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudQueryApiResponse'
              example:
                isSuccess: true
                responseList:
                  - connected: true
                    dateRegistered: '2024-03-05T15:56:04Z'
                    deviceId: 36103e24-41d8-47c9-b5f7-119f0000000
                    deviceNickName: Front Desk POS
                    make: ingenico
                    model: LK2500
                    registered: true
                    serialNumber: '312345692080000000'
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Cloud/list/{entry}:
    get:
      operationId: cloud_ListDevice
      tags:
        - Cloud
      x-fern-sdk-group-name: cloud
      x-fern-sdk-method-name: ListDevice
      x-fern-request-name: ListDeviceRequest
      summary: List registered devices in cloud
      description: |-
        Use [List devices by paypoint](/developers/api-reference/cloud/get-list-of-devices-for-a-paypoint) instead, which supports filters, sorting, and pagination.

        Get a list of cloud devices registered to an entrypoint.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: forceRefresh
          in: query
          description: When `true`, the request retrieves an updated list of devices from the processor instead of returning a cached list of devices.
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudQueryApiResponse'
              example:
                isSuccess: true
                responseList:
                  - connected: true
                    dateRegistered: '2024-03-05T15:56:04Z'
                    deviceId: 36103e24-41d8-47c9-b5f7-119f0000000
                    deviceNickName: Front Desk POS
                    make: ingenico
                    model: LK2500
                    registered: true
                    serialNumber: '312345692080000000'
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /LineItem/{entry}:
    post:
      operationId: lineItem_AddItem
      tags:
        - LineItem
      x-fern-sdk-group-name: lineItem
      x-fern-sdk-method-name: AddItem
      x-fern-request-name: AddItemRequest
      summary: Add item to entrypoint catalog
      description: Adds products and services to an entrypoint's catalog. These are used as line items for invoicing and transactions. In the response, "responseData" displays the item's code.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 47cae3d74
        - name: idempotencyKey
          in: header
          description: A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself.
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LineItem'
            example:
              itemProductCode: M-DEPOSIT
              itemProductName: Materials deposit
              itemDescription: Deposit for materials
              itemCommodityCode: '010'
              itemUnitOfMeasure: SqFt
              itemCost: 12.45
              itemQty: 1
              itemMode: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse6'
              example:
                isSuccess: true
                responseData: 700
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /LineItem/{lineItemId}:
    delete:
      operationId: lineItem_DeleteItem
      tags:
        - LineItem
      x-fern-sdk-group-name: lineItem
      x-fern-sdk-method-name: DeleteItem
      x-fern-request-name: DeleteItemRequest
      summary: Delete item in entrypoint
      description: Deletes an item.
      security:
        - APIKeyAuth: []
      parameters:
        - name: lineItemId
          in: path
          description: ID for the line item (also known as a product, service, or item).
          required: true
          schema:
            type: integer
          example: 700
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteItemResponse'
              example:
                isSuccess: true
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    get:
      operationId: lineItem_GetItem
      tags:
        - LineItem
      x-fern-sdk-group-name: lineItem
      x-fern-sdk-method-name: GetItem
      x-fern-request-name: GetItemRequest
      summary: Get item in entrypoint
      description: Gets an item by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: lineItemId
          in: path
          description: ID for the line item (also known as a product, service, or item).
          required: true
          schema:
            type: integer
          example: 700
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LineItemQueryRecord'
              example:
                createdAt: '2022-07-01T15:00:01Z'
                id: 700
                itemCategories:
                  - itemCategories
                itemCommodityCode: '010'
                itemCost: 5
                itemDescription: Deposit for materials.
                itemMode: 0
                itemProductCode: M-DEPOSIT
                itemProductName: Materials deposit
                itemQty: 1
                itemUnitOfMeasure: SqFt
                lastUpdated: '2022-07-01T15:00:01Z'
                pageidentifier: 'null'
                ParentOrgName: PropertyManager Pro
                PaypointDbaname: Sunshine Gutters
                PaypointEntryname: d193cf9a46
                PaypointLegalname: Sunshine Services, LLC
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: lineItem_UpdateItem
      tags:
        - LineItem
      x-fern-sdk-group-name: lineItem
      x-fern-sdk-method-name: UpdateItem
      x-fern-request-name: UpdateItemRequest
      summary: Update item in entrypoint
      description: Updates an item.
      security:
        - APIKeyAuth: []
      parameters:
        - name: lineItemId
          in: path
          description: ID for the line item (also known as a product, service, or item).
          required: true
          schema:
            type: integer
          example: 700
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LineItem'
            example:
              itemCost: 12.45
              itemQty: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse6'
              example:
                isSuccess: true
                responseData: 700
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/lineitems/{entry}:
    get:
      operationId: lineItem_ListLineItems
      tags:
        - LineItem
      x-fern-sdk-group-name: lineItem
      x-fern-sdk-method-name: ListLineItems
      x-fern-request-name: ListLineItemsRequest
      summary: Get list of items for entrypoint
      description: Retrieves a list of line items and their details from an entrypoint. Line items are also known as items, products, and services. Use filters to limit results.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - 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
          example: 251
        - 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
          example: 0
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:

              - `categories` (ct, nct)
              - `code` (ne, eq, ct, nct)
              - `commodityCode` (ne, eq, ct, nct)
              - `createdDate` (gt, ge, lt, le, eq, ne)
              - `description` (ne, eq, ct, nct)
              - `externalPaypointID` (ct, nct, ne, eq)
              - `mode` (eq, ne)
              - `name` (ne, eq, ct, nct)
              - `orgName` (ne, eq, ct, nct)
              - `paypointDba` (ne, eq, ct, nct)
              - `paypointId` (ne, eq)
              - `paypointLegal` (ne, eq, ct, nct)
              - `quantity` (gt, ge, lt, le, eq, ne)
              - `uom` (ne, eq, ct, nct)
              - `updatedDate` (gt, ge, lt, le, eq, ne)
              - `value` (gt, ge, lt, le, eq, ne)

            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 separated by "|"
            - nin => not inside array separated by "|"

            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: name(ct)=john return all records with name containing john
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponseItems'
              example:
                Records:
                  - LineItem:
                      itemCost: 12.45
                      itemProductName: Materials deposit
                      itemQty: 1
                    ParentOrgName: PropertyManager Pro
                    PaypointDbaname: Sunshine Gutters
                    PaypointEntryname: d193cf9a46
                    PaypointLegalname: Sunshine Services, LLC
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 77.22
                  totalNetAmount: 77.22
                  totalPages: 2
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Boarding/app:
    post:
      operationId: boarding_AddApplication
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: AddApplication
      x-fern-request-name: AddApplicationRequest
      summary: Create boarding application
      description: Creates a boarding application in an organization. This endpoint requires an application API token.
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddApplicationRequest'
            examples:
              PayIn:
                value:
                  services:
                    ach: {}
                    card:
                      acceptAmex: true
                      acceptDiscover: true
                      acceptMastercard: true
                      acceptVisa: true
                  annualRevenue: 1000
                  averageBillSize: '500'
                  averageMonthlyBill: '5650'
                  avgmonthly: 1000
                  baddress: 123 Walnut Street
                  baddress1: Suite 103
                  bankData:
                    - accountNumber: '123123123'
                      bankAccountFunction: 1
                      bankAccountHolderName: Gruzya Adventure Outfitters LLC
                      bankAccountHolderType: Business
                      bankName: Test Bank
                      nickname: Withdrawal Account
                      routingAccount: '123123123'
                      typeAccount: Checking
                      accountId: 123-456
                    - accountNumber: '123123123'
                      bankAccountFunction: 0
                      bankAccountHolderName: Gruzya Adventure Outfitters LLC
                      bankAccountHolderType: Business
                      bankName: Test Bank
                      nickname: Deposit Account
                      routingAccount: '123123123'
                      typeAccount: Checking
                      accountId: 123-456
                  bcity: New Vegas
                  bcountry: US
                  binperson: 60
                  binphone: 20
                  binweb: 20
                  bstate: FL
                  bsummary: Brick and mortar store that sells office supplies
                  btype: Limited Liability Company
                  bzip: '33000'
                  contacts:
                    - contactEmail: herman@hermanscoatings.com
                      contactName: Herman Martinez
                      contactPhone: '3055550000'
                      contactTitle: Owner
                  creditLimit: creditLimit
                  dbaName: Sunshine Gutters
                  ein: '123456789'
                  faxnumber: '1234567890'
                  highticketamt: 1000
                  legalName: Sunshine Services, LLC
                  license: 2222222FFG
                  licstate: CA
                  maddress: 123 Walnut Street
                  maddress1: STE 900
                  mcc: '7777'
                  mcity: Johnson City
                  mcountry: US
                  mstate: TN
                  mzip: '37615'
                  orgId: 123
                  ownership:
                    - oaddress: 33 North St
                      ocity: Any City
                      ocountry: US
                      odriverstate: CA
                      ostate: CA
                      ownerdob: 01/01/1990
                      ownerdriver: CA6677778
                      owneremail: test@email.com
                      ownername: John Smith
                      ownerpercent: 100
                      ownerphone1: '555888111'
                      ownerphone2: '555888111'
                      ownerssn: '123456789'
                      ownertitle: CEO
                      ozip: '55555'
                  phonenumber: '1234567890'
                  processingRegion: US
                  recipientEmail: josephray@example.com
                  recipientEmailNotification: true
                  resumable: true
                  signer:
                    address: 33 North St
                    address1: STE 900
                    city: Bristol
                    country: US
                    dob: 01/01/1976
                    email: test@email.com
                    name: John Smith
                    phone: '555888111'
                    ssn: '123456789'
                    state: TN
                    zip: '55555'
                    pciAttestation: true
                    signedDocumentReference: https://example.com/signed-document.pdf
                    attestationDate: 04/20/2025
                    signDate: 04/20/2025
                    additionalData:
                      deviceId: 499585-389fj484-3jcj8hj3
                      session: fifji4-fiu443-fn4843
                      timeWithCompany: 6 Years
                  startdate: 01/01/1990
                  taxFillName: Sunshine LLC
                  templateId: 22
                  ticketamt: 1000
                  website: www.example.com
                  whenCharged: When Service Provided
                  whenDelivered: Over 30 Days
                  whenProvided: 30 Days or Less
                  whenRefunded: 30 Days or Less
              ManagedPayout:
                value:
                  annualRevenue: 750000
                  baddress: 789 Industrial Parkway
                  baddress1: Unit 12
                  bankData:
                    - accountNumber: 1XXXXXX3100
                      bankAccountFunction: 1
                      bankAccountHolderName: Herman's Coatings LLC
                      bankAccountHolderType: Business
                      bankName: First Miami Bank
                      nickname: Withdrawal Account
                      routingAccount: '123123123'
                      typeAccount: Checking
                      accountId: 123-456
                    - accountNumber: 1XXXXXX3200
                      bankAccountFunction: 0
                      bankAccountHolderName: Herman's Coatings LLC
                      bankAccountHolderType: Business
                      bankName: First Miami Bank
                      nickname: Deposit Account
                      routingAccount: '123123123'
                      typeAccount: Checking
                      accountId: 123-789
                    - accountNumber: 1XXXXXX3123
                      bankAccountFunction: 3
                      bankAccountHolderName: Herman's Coatings LLC
                      bankAccountHolderType: Business
                      bankName: First Miami Bank
                      nickname: Remittance Account
                      routingAccount: '123123123'
                      typeAccount: Checking
                      accountId: 123-100
                  bcity: Miami
                  bcountry: US
                  bstate: FL
                  bsummary: Commercial and industrial coating services, including protective and decorative coatings
                  btype: Limited Liability Company
                  bzip: '33101'
                  contacts:
                    - contactEmail: herman@hermanscoatings.com
                      contactName: Herman Martinez
                      contactPhone: '3055550000'
                      contactTitle: Owner
                  dbaname: Herman's Coatings
                  ein: '123456789'
                  faxnumber: '3055550001'
                  legalname: Herman's Coatings LLC
                  license: FL123456
                  licstate: FL
                  maddress: 789 Industrial Parkway
                  maddress1: Unit 12
                  mcc: '1799'
                  mcity: Miami
                  mcountry: US
                  mstate: FL
                  mzip: '33101'
                  orgId: 123
                  ownership:
                    - oaddress: 123 Palm Avenue
                      ocity: Miami
                      ocountry: US
                      odriverstate: FL
                      ostate: FL
                      ownerdob: 05/15/1980
                      ownerdriver: FL789456
                      owneremail: herman@hermanscoatings.com
                      ownername: Herman Martinez
                      ownerpercent: 100
                      ownerphone1: '3055550000'
                      ownerphone2: '3055550002'
                      ownerssn: '123456789'
                      ownertitle: Owner
                      ozip: '33102'
                  phonenumber: '3055550000'
                  recipientEmail: herman@hermanscoatings.com
                  recipientEmailNotification: true
                  resumable: true
                  signer:
                    address: 33 North St
                    address1: STE 900
                    city: Bristol
                    country: US
                    dob: 01/01/1976
                    email: test@email.com
                    name: John Smith
                    phone: '555888111'
                    ssn: '123456789'
                    state: TN
                    zip: '55555'
                    pciAttestation: true
                    signedDocumentReference: https://example.com/signed-document.pdf
                    attestationDate: 04/20/2025
                    signDate: 04/20/2025
                    additionalData:
                      deviceId: 499585-389fj484-3jcj8hj3
                      session: fifji4-fiu443-fn4843
                      timeWithCompany: 6 Years
                  startdate: 01/01/2015
                  taxfillname: Herman's Coatings LLC
                  templateId: 22
                  website: www.hermanscoatings.com
              OnDemandPayout:
                value:
                  services:
                    ach:
                      acceptCCD: true
                      acceptPPD: true
                      acceptWeb: true
                    card:
                      acceptAmex: true
                      acceptDiscover: true
                      acceptMastercard: true
                      acceptVisa: true
                    odp:
                      allowAch: true
                      allowChecks: true
                      allowVCard: true
                      processing_region: US
                      processor: tsys
                      issuerNetworkSettingsId: '12345678901234'
                  annualRevenue: 750000
                  baddress: 789 Industrial Parkway
                  baddress1: Unit 12
                  bankData:
                    - accountNumber: 1XXXXXX3100
                      bankAccountFunction: 1
                      bankAccountHolderName: Herman's Coatings LLC
                      bankAccountHolderType: Business
                      bankName: First Miami Bank
                      nickname: Withdrawal Account
                      routingAccount: '123123123'
                      typeAccount: Checking
                      accountId: 333-789
                    - accountNumber: 1XXXXXX3200
                      bankAccountFunction: 0
                      bankAccountHolderName: Herman's Coatings LLC
                      bankAccountHolderType: Business
                      bankName: First Miami Bank
                      nickname: Deposit Account
                      routingAccount: '123123123'
                      typeAccount: Checking
                      accountId: 333-234
                    - accountNumber: 1XXXXXX3123
                      bankAccountFunction: 3
                      bankAccountHolderName: Herman's Coatings LLC
                      bankAccountHolderType: Business
                      bankName: First Miami Bank
                      nickname: Remittance Account
                      routingAccount: '123123123'
                      typeAccount: Checking
                      accountId: 333-567
                  bcity: Miami
                  bcountry: US
                  bstate: FL
                  bsummary: Commercial and industrial coating services, including protective and decorative coatings
                  btype: Limited Liability Company
                  bzip: '33101'
                  contacts:
                    - contactEmail: herman@hermanscoatings.com
                      contactName: Herman Martinez
                      contactPhone: '3055550000'
                      contactTitle: Owner
                  dbaname: Herman's Coatings
                  ein: '123456789'
                  faxnumber: '3055550001'
                  highticketamt: 15000
                  legalname: Herman's Coatings LLC
                  license: FL123456
                  licstate: FL
                  maddress: 789 Industrial Parkway
                  maddress1: Unit 12
                  mcc: '1799'
                  mcity: Miami
                  mcountry: US
                  mstate: FL
                  mzip: '33101'
                  orgId: 123
                  ownership:
                    - oaddress: 123 Palm Avenue
                      ocity: Miami
                      ocountry: US
                      odriverstate: FL
                      ostate: FL
                      ownerdob: 05/15/1980
                      ownerdriver: FL789456
                      owneremail: herman@hermanscoatings.com
                      ownername: Herman Martinez
                      ownerpercent: 100
                      ownerphone1: '3055550000'
                      ownerphone2: '3055550002'
                      ownerssn: '123456789'
                      ownertitle: Owner
                      ozip: '33102'
                  payoutAverageMonthlyVolume: 50000
                  payoutAverageTicketAmount: 3500
                  payoutCreditLimit: 25000
                  payoutHighTicketAmount: 15000
                  phonenumber: '3055550000'
                  recipientEmail: herman@hermanscoatings.com
                  recipientEmailNotification: true
                  resumable: true
                  signer:
                    address: 33 North St
                    address1: STE 900
                    city: Bristol
                    country: US
                    dob: 01/01/1976
                    email: test@email.com
                    name: John Smith
                    phone: '555888111'
                    ssn: '123456789'
                    state: TN
                    zip: '55555'
                    pciAttestation: true
                    signedDocumentReference: https://example.com/signed-document.pdf
                    attestationDate: 04/20/2025
                    signDate: 04/20/2025
                    additionalData:
                      deviceId: 499585-389fj484-3jcj8hj3
                      session: fifji4-fiu443-fn4843
                      timeWithCompany: 6 Years
                  startdate: 01/01/2015
                  taxfillname: Herman's Coatings LLC
                  templateId: 22
                  website: www.hermanscoatings.com
              AllFields:
                value:
                  services:
                    ach:
                      acceptCCD: true
                      acceptPPD: true
                      acceptWeb: true
                    card:
                      acceptAmex: true
                      acceptDiscover: true
                      acceptMastercard: true
                      acceptVisa: true
                    odp:
                      allowAch: false
                      allowChecks: false
                      allowVCard: false
                  annualRevenue: 750000
                  attachments:
                    - {}
                    - {}
                  baddress: 789 Industrial Parkway
                  baddress1: Unit 12
                  bankData:
                    - accountNumber: 1XXXXXX3100
                      bankAccountFunction: 1
                      bankAccountHolderName: Herman's Coatings LLC
                      bankAccountHolderType: Business
                      bankName: First Miami Bank
                      id: 123
                      nickname: Withdrawal Account
                      routingAccount: '123123123'
                      typeAccount: Checking
                      accountId: 123-789
                    - accountNumber: 1XXXXXX3200
                      bankAccountFunction: 0
                      bankAccountHolderName: Herman's Coatings LLC
                      bankAccountHolderType: Business
                      bankName: First Miami Bank
                      id: 456
                      nickname: Deposit Account
                      routingAccount: '123123123'
                      typeAccount: Checking
                      accountId: 123-456
                    - accountNumber: 1XXXXXX3123
                      bankAccountFunction: 3
                      bankAccountHolderName: Herman's Coatings LLC
                      bankAccountHolderType: Business
                      bankName: First Miami Bank
                      id: 987
                      nickname: Remittance Account
                      routingAccount: '123123123'
                      typeAccount: Checking
                      accountId: 123-100
                  bcity: Miami
                  bcountry: US
                  boardingLinkId: bl_123456
                  bstate: FL
                  bsummary: Commercial and industrial coating services, including protective and decorative coatings
                  btype: Limited Liability Company
                  bzip: '33101'
                  contacts:
                    - contactEmail: herman@hermanscoatings.com
                      contactName: Herman Martinez
                      contactPhone: '3055550000'
                      contactTitle: Owner
                  dbaname: Herman's Coatings
                  ein: '123456789'
                  faxnumber: '3055550001'
                  highticketamt: 15000
                  legalname: Herman's Coatings LLC
                  license: FL123456
                  licstate: FL
                  maddress: 789 Industrial Parkway
                  maddress1: Unit 12
                  mcc: '1799'
                  mcity: Miami
                  mcountry: US
                  mstate: FL
                  mzip: '33101'
                  orgId: 123
                  ownership:
                    - oaddress: 123 Palm Avenue
                      ocity: Miami
                      ocountry: US
                      odriverstate: FL
                      ostate: FL
                      ownerdob: 05/15/1980
                      ownerdriver: FL789456
                      owneremail: herman@hermanscoatings.com
                      ownername: Herman Martinez
                      ownerpercent: 100
                      ownerphone1: '3055550000'
                      ownerphone2: '3055550002'
                      ownerssn: '123456789'
                      ownertitle: Owner
                      ozip: '33102'
                  payoutAverageMonthlyVolume: 50000
                  payoutAverageTicketAmount: 500
                  payoutCreditLimit: 25000
                  payoutHighTicketAmount: 15000
                  phonenumber: '3055550000'
                  recipientEmail: herman@hermanscoatings.com
                  recipientEmailNotification: true
                  resumable: true
                  signer:
                    address: 33 North St
                    address1: STE 900
                    city: Bristol
                    country: US
                    dob: 01/01/1976
                    email: test@email.com
                    name: John Smith
                    phone: '555888111'
                    ssn: '123456789'
                    state: TN
                    zip: '55555'
                    pciAttestation: true
                    signedDocumentReference: https://example.com/signed-document.pdf
                    attestationDate: 04/20/2025
                    signDate: 04/20/2025
                    additionalData:
                      deviceId: 499585-389fj484-3jcj8hj3
                      session: fifji4-fiu443-fn4843
                      timeWithCompany: 6 Years
                  startdate: 01/01/2015
                  taxfillname: Herman's Coatings LLC
                  templateId: 22
                  website: www.hermanscoatings.com
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
              examples:
                PayIn:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseData: 3625
                    responseText: Success
                ManagedPayout:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseData: 3625
                    responseText: Success
                OnDemandPayout:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseData: 3625
                    responseText: Success
                AllFields:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseData: 3625
                    responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Boarding/app/{appId}:
    delete:
      operationId: boarding_DeleteApplication
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: DeleteApplication
      x-fern-request-name: DeleteApplicationRequest
      summary: Delete boarding application
      description: Deletes a boarding application by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: appId
          in: path
          description: Boarding application ID.
          required: true
          schema:
            type: integer
          example: 352
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 3625
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: boarding_UpdateApplication
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: UpdateApplication
      x-fern-request-name: UpdateApplicationRequest
      summary: Update boarding application
      description: Updates a boarding application by ID. This endpoint requires an application API token.
      security:
        - APIKeyAuth: []
      parameters:
        - name: appId
          in: path
          description: Boarding application ID.
          required: true
          schema:
            type: integer
          example: 352
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationData'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 3625
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Boarding/read/{appId}:
    get:
      operationId: boarding_GetApplication
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: GetApplication
      x-fern-request-name: GetApplicationRequest
      summary: Get boarding application by ID
      description: Retrieves the details for a boarding application by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: appId
          in: path
          description: Boarding application ID.
          required: true
          schema:
            type: integer
          example: 352
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationDetailsRecord'
              example:
                annualRevenue: 1000
                averageMonthlyVolume: 1000
                averageTicketAmount: 1000
                bAddress1: 123 Walnut Street
                bAddress2: Suite 103
                bankData:
                  - accountNumber: '123123123'
                    bankAccountFunction: 1
                    bankAccountHolderName: Gruzya Adventure Outfitters LLC
                    bankAccountHolderType: Business
                    bankName: Test Bank
                    nickname: Withdrawal Account
                    routingAccount: '123123123'
                    typeAccount: Checking
                    accountId: 123-456
                  - accountNumber: '123123123'
                    bankAccountFunction: 0
                    bankAccountHolderName: Gruzya Adventure Outfitters LLC
                    bankAccountHolderType: Business
                    bankName: Test Bank
                    nickname: Deposit Account
                    routingAccount: '123123123'
                    typeAccount: Checking
                    accountId: 123-456
                bCity: New Vegas
                bCountry: US
                bFax: '5551234567'
                binPerson: 60
                binPhone: 20
                binWeb: 20
                boardingLinkId: 91
                boardingStatus: 123
                boardingSubStatus: 123
                bPhone: '5551234567'
                bStartdate: 01/01/1990
                bState: FL
                bSummary: Brick and mortar store that sells office supplies
                builderData:
                  services:
                    ach:
                      acceptance:
                        ccd:
                          ro: false
                          value: <string>
                        ppd:
                          ro: false
                          value: <string>
                        web:
                          ro: false
                          value: <string>
                      fees:
                        body:
                          - columns:
                              - value: <string>
                        header:
                          columns:
                            - value: <string>
                      price:
                        body:
                          - columns:
                              - value: <string>
                        header:
                          columns:
                            - value: <string>
                    card:
                      acceptance:
                        amex:
                          ro: false
                          value: <string>
                        discover:
                          ro: false
                          value: <string>
                        mastercard:
                          ro: false
                          value: <string>
                        visa:
                          ro: false
                          value: <string>
                      fees:
                        body:
                          - columns:
                              - value: <string>
                        header:
                          columns:
                            - value: <string>
                      price:
                        body:
                          - columns:
                              - value: <string>
                        header:
                          columns:
                            - value: <string>
                  attributes:
                    minimumDocuments: 1
                    multipleContacts: true
                    multipleOwners: true
                  banking:
                    depositAccount:
                      accountNumber:
                        ro: false
                        value: <string>
                      bankName:
                        ro: false
                        value: <string>
                      routingAccount:
                        ro: false
                        value: <string>
                      typeAccount:
                        ro: false
                        value: <string>
                    withdrawalAccount:
                      accountNumber:
                        ro: false
                        value: <string>
                      bankName:
                        ro: false
                        value: <string>
                      routingAccount:
                        ro: false
                        value: <string>
                      typeAccount:
                        ro: false
                        value: <string>
                  business:
                    address:
                      baddress:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      baddress1:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      bcity:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      bcountry:
                        ro: false
                        value: <string>
                      bstate:
                        ro: false
                        value: <string>
                      bzip:
                        ro: false
                        validator: zipcode
                        value: <string>
                      maddress:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      maddress1:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      mcity:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      mcountry:
                        ro: false
                        value: <string>
                      mstate:
                        ro: false
                        value: <string>
                      mzip:
                        ro: false
                        validator: zipcode
                        value: <string>
                    details:
                      btype:
                        ro: false
                        value: <string>
                      dbaname:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      ein:
                        ro: false
                        validator: routing
                        value: <string>
                      faxnumber:
                        ro: false
                        validator: phone
                        value: <string>
                      legalname:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      license:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      licstate:
                        ro: false
                        value: <string>
                      phonenumber:
                        ro: false
                        validator: phone
                        value: <string>
                      startdate:
                        ro: false
                        value: '2021-12-13T05:00:00.000Z'
                      taxfillname:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      website:
                        ro: false
                        validator: url
                        value: <string>
                  owners:
                    contact_list:
                      contactEmail:
                        ro: false
                        validator: email
                        value: <string>
                      contactName:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      contactPhone:
                        ro: false
                        validator: phone
                        value: <string>
                      contactTitle:
                        ro: false
                        validator: alpha
                        value: <string>
                    own_list:
                      oaddress:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      ocity:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      ocountry:
                        ro: false
                        value: <string>
                      odriverstate:
                        ro: false
                        value: <string>
                      ostate:
                        ro: false
                        value: <string>
                      ownerdob:
                        ro: false
                        value: '2003-06-05T04:00:00.000Z'
                      ownerdriver:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      owneremail:
                        ro: false
                        validator: email
                        value: <string>
                      ownername:
                        ro: false
                        validator: alphanumeric
                        value: <string>
                      ownerpercent:
                        ro: false
                        validator: number
                        value: <string>
                      ownerphone1:
                        ro: false
                        validator: phone
                        value: <string>
                      ownerphone2:
                        ro: false
                        validator: phone
                        value: <string>
                      ownerssn:
                        ro: false
                        validator: routing
                        value: <string>
                      ownertitle:
                        ro: false
                        validator: alpha
                        value: <string>
                      ozip:
                        ro: false
                        validator: zipcode
                        value: <string>
                  processing:
                    avgmonthly:
                      ro: false
                      validator: numbers
                      value: <string>
                    binperson:
                      ro: false
                      value: <string>
                    binphone:
                      ro: false
                      value: <string>
                    binweb:
                      ro: false
                      value: <string>
                    bsummary:
                      ro: false
                      validator: text
                      value: <string>
                    highticketamt:
                      ro: false
                      validator: numbers
                      value: <string>
                    mcc:
                      ro: false
                      value: <string>
                    ticketamt:
                      ro: false
                      validator: numbers
                      value: <string>
                    whenCharged:
                      ro: false
                      value: <string>
                    whenDelivered:
                      ro: false
                      value: <string>
                    whenProvided:
                      ro: false
                      value: <string>
                    whenRefunded:
                      ro: false
                      value: <string>
                bZip: '33000'
                contactData:
                  - contactEmail: herman@hermanscoatings.com
                    contactName: Herman Martinez
                    contactPhone: '3055550000'
                    contactTitle: Owner
                    additionalData: null
                createdAt: '2022-07-01T15:00:01Z'
                dbaName: Sunshine Gutters
                documentsRef:
                  filelist:
                    - originalName: <string>
                      zipName: <string>
                  zipfile: zx45.zip
                ein: XXXX6789
                externalPaypointId: Paypoint-100
                generalEvents:
                  - description: Created
                    eventTime: '2022-06-17T16:35:21Z'
                  - description: Updated Status
                    eventTime: '2022-06-17T16:35:22Z'
                    refData: '1'
                highTicketAmount: 1000
                idApplication: 325
                lastModified: '2022-07-01T15:00:01Z'
                legalName: Sunshine Services, LLC
                license: 2222222FFG
                licenseState: CA
                logo: https://mysite.com/my-logo.png
                mAddress1: 123 Walnut Street
                mAddress2: STE 900
                mccid: <string>
                mCity: TN
                mCountry: US
                messages:
                  - content: Requested business license and bank statements.
                    createdAt: '2023-10-30T19:37:20Z'
                    currentApplicationStatus: 3
                    currentApplicationSubStatus: 2
                    id: 261
                    messageType: 1
                    originalApplicationStatus: -99
                    originalApplicationSubStatus: 0
                    roomId: 6
                    userId: 104
                    userName: admin
                  - content: TIN Failed, Need to reach out to merchant
                    createdAt: '2023-10-25T18:41:55Z'
                    currentApplicationStatus: 3
                    currentApplicationSubStatus: 3
                    id: 231
                    messageType: 1
                    originalApplicationStatus: -99
                    originalApplicationSubStatus: 0
                    roomId: 6
                    userId: 104
                    userName: admin
                  - content: Application approved, finalizing agreement.
                    createdAt: '2023-09-09T00:00:00Z'
                    currentApplicationStatus: 7
                    currentApplicationSubStatus: 5
                    id: 3
                    messageType: 1
                    originalApplicationStatus: -99
                    originalApplicationSubStatus: 0
                    roomId: 6
                    userId: 5
                    userName: admin
                mState: TN
                mZip: '37615'
                orgId: 123
                orgParentName: PropertyManager Pro
                ownerData:
                  - oaddress: 33 North St
                    ocity: Any City
                    ocountry: US
                    odriverstate: CA
                    ostate: CA
                    ownerdob: 01/01/1990
                    ownerdriver: CA6677778
                    owneremail: test@email.com
                    ownername: John Smith
                    ownerpercent: 25
                    ownerphone1: '555888111'
                    ownerphone2: '555888111'
                    ownerssn: '123456789'
                    ownertitle: CEO
                    ozip: '55555'
                    additionalData: null
                ownType: Limited Liability Company
                pageidentifier: <string>
                recipientEmailNotification: true
                resumable: true
                salesCode: <string>
                serviceData:
                  ach:
                    acceptCCD: true
                    acceptPPD: true
                    acceptWeb: true
                  card:
                    acceptAmex: true
                    acceptDiscover: true
                    acceptMastercard: true
                    acceptVisa: true
                  odp:
                    allowAch: true
                    allowChecks: true
                    allowVCard: true
                    processing_region: US
                    processor: tysys
                    issuerNetworkSettingsId: '12345678901234'
                signer:
                  address: 33 North St
                  address1: STE 900
                  city: Bristol
                  country: US
                  dob: 01/01/1976
                  email: test@email.com
                  name: John Smith
                  phone: '555888111'
                  ssn: '123456789'
                  state: TN
                  zip: '55555'
                  pciAttestation: true
                  signedDocumentReference: https://example.com/signed-document.pdf
                  attestationDate: 04/20/2025
                  signDate: 04/20/2025
                  additionalData:
                    deviceId: 499585-389fj484-3jcj8hj3
                    session: fifji4-fiu443-fn4843
                    timeWithCompany: 6 Years
                taxfillname: Sunshine LLC
                templateId: 22
                websiteAddress: www.example.com
                whencharged: When Service Provided
                whendelivered: Over 30 Days
                whenProvided: 30 Days or Less
                whenrefund: Exchange Only
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Boarding/read/{xId}:
    post:
      operationId: boarding_GetApplicationByAuth
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: GetApplicationByAuth
      x-fern-request-name: RequestAppByAuth
      summary: Get boarding application by auth
      description: Gets a boarding application by authentication information. This endpoint requires an `application` API token.
      security:
        - APIKeyAuth: []
      parameters:
        - name: xId
          in: path
          description: 'The application ID in Hex format. Find this at the end of the boarding link URL returned in a call to api/Boarding/applink/{appId}/{mail2}. For example in:  `https://boarding-sandbox.payabli.com/boarding/externalapp/load/17E`, the xId is `17E`.'
          required: true
          schema:
            type: string
          example: 17E
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestAppByAuth'
            example:
              email: admin@email.com
              referenceId: n6UCd1f1ygG7
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationQueryRecord'
              example:
                annualRevenue: 1000
                averageMonthlyVolume: 1000
                averageTicketAmount: 1000
                bAddress1: 123 Walnut Street
                bAddress2: Suite 103
                bankData:
                  - accountNumber: 1XXXXXX3123
                    bankAccountFunction: 1
                    bankAccountHolderName: Gruzya Adventure Outfitters LLC
                    bankAccountHolderType: Personal
                    bankName: Country Bank
                    id: 1
                    nickname: Business Checking 1234
                    routingAccount: '123123123'
                    typeAccount: Checking
                    accountId: 123-456
                  - accountNumber: 1XXXXXX3123
                    bankAccountFunction: 0
                    bankAccountHolderName: Gruzya Adventure Outfitters LLC
                    bankAccountHolderType: Personal
                    bankName: Country Bank
                    id: 1
                    nickname: Business Checking 1234
                    routingAccount: '123123123'
                    typeAccount: Checking
                    accountId: 123-456
                bCity: New Vegas
                bCountry: US
                bFax: '5551234567'
                binPerson: 60
                binPhone: 20
                binWeb: 20
                boardingLinkId: 91
                boardingStatus: 1
                boardingSubStatus: 1
                bPhone: '5551234567'
                bStartdate: 01/01/1990
                bState: FL
                bSummary: Brick and mortar store that sells office supplies
                builderData:
                  attributes:
                    minimumDocuments: 1
                    multipleContacts: true
                    multipleOwners: true
                bZip: '33000'
                contactData:
                  - contactEmail: example@email.com
                    contactName: Herman Martinez
                    contactPhone: '3055550000'
                    contactTitle: Owner
                createdAt: '2022-07-01T15:00:01Z'
                dbaName: Sunshine Gutters
                documentsRef:
                  filelist:
                    - {}
                  zipfile: zx45.zip
                ein: '123456789'
                externalPaypointId: Paypoint-100
                generalEvents:
                  - description: TransferCreated
                    eventTime: '2023-07-05T22:31:06Z'
                    extraData: null
                    refData: refData
                    source: api
                highTicketAmount: 1000
                idApplication: 352
                lastModified: '2022-07-01T15:00:01Z'
                legalName: Sunshine Services, LLC
                license: 2222222FFG
                licenseState: CA
                logo:
                  fContent: TXkgdGVzdCBmaWxlHJ==...
                  filename: my-doc.pdf
                  ftype: pdf
                  furl: https://mysite.com/my-doc.pdf
                mAddress1: 123 Walnut Street
                mAddress2: STE 900
                mccid: mccid
                mCity: TN
                mCountry: US
                mState: TN
                mZip: '37615'
                orgId: 123
                orgParentName: PropertyManager Pro
                ownerData:
                  - oaddress: 33 North St
                    ocity: Any City
                    ocountry: US
                    odriverstate: CA
                    ostate: CA
                    ownerdob: 01/01/1990
                    ownerdriver: CA6677778
                    owneremail: example@email.com
                    ownername: John Smith
                    ownerpercent: 25
                    ownerphone1: '555888111'
                    ownerphone2: '555888111'
                    ownerssn: '123456789'
                    ownertitle: CEO
                    ozip: '55555'
                ownType: Limited Liability Company
                pageidentifier: 'null'
                recipientEmailNotification: true
                resumable: false
                salesCode: salesCode
                serviceData:
                  ach:
                    acceptCCD: false
                    acceptPPD: false
                    acceptWeb: true
                  card:
                    acceptAmex: true
                    acceptDiscover: false
                    acceptMastercard: true
                    acceptVisa: true
                  odp:
                    allowAch: true
                    allowChecks: true
                    allowVCard: true
                    processing_region: US
                    processor: tysys
                    issuerNetworkSettingsId: '12345678901234'
                signer:
                  acceptance: false
                  address: 33 North St
                  address1: STE 900
                  city: Bristol
                  country: US
                  dob: 01/01/1990
                  email: example@email.com
                  name: John Smith
                  phone: '555888111'
                  signedDocumentReference: signedDocumentReference
                  signerUuid: 54455d5d-34ff-416c-91e0-5bc87199999
                  ssn: '123456789'
                  state: TN
                  zip: '55555'
                taxfillname: Sunshine LLC
                templateId: 22
                websiteAddress: www.example.com
                whencharged: When Service Provided
                whendelivered: 0-7 Days
                whenProvided: 30 Days or Less
                whenrefund: Exchange Only
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Boarding/linkbyId/{boardingLinkId}:
    get:
      operationId: boarding_GetByIdLinkApplication
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: GetByIdLinkApplication
      x-fern-request-name: GetByIdLinkApplicationRequest
      summary: Get boarding link by ID
      description: Retrieves details for a boarding link, by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: boardingLinkId
          in: path
          description: The boarding link ID. You can find this at the end of the boarding link reference name. For example `https://boarding.payabli.com/boarding/app/myorgaccountname-00091`. The ID is `91`.
          required: true
          schema:
            type: integer
          example: 91
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoardingLinkQueryRecord'
              example:
                acceptOauth: false
                acceptRegister: false
                builderData:
                  attributes:
                    minimumDocuments: 1
                    multipleContacts: true
                    multipleOwners: true
                entryAttributes: entryAttributes
                id: 1000000
                logo:
                  fContent: TXkgdGVzdCBmaWxlHJ==...
                  filename: my-doc.pdf
                  ftype: pdf
                  furl: https://mysite.com/my-doc.pdf
                orgId: 123
                'pageIdentifier:': 'null'
                recipientEmailNotification: true
                referenceName: payabli-00710
                referenceTemplateId: 1830
                resumable: false
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Boarding/linkbyTemplate/{templateId}:
    get:
      operationId: boarding_GetByTemplateIdLinkApplication
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: GetByTemplateIdLinkApplication
      x-fern-request-name: GetByTemplateIdLinkApplicationRequest
      summary: Get boarding link by template ID
      description: Get details for a boarding link using the boarding template ID. This endpoint requires an application API token.
      security:
        - APIKeyAuth: []
      parameters:
        - name: templateId
          in: path
          description: 'The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.'
          required: true
          schema:
            type: number
            format: double
          example: 80
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoardingLinkQueryRecord'
              example:
                acceptOauth: false
                acceptRegister: false
                builderData:
                  attributes:
                    minimumDocuments: 1
                    multipleContacts: true
                    multipleOwners: true
                entryAttributes: entryAttributes
                id: 1000000
                logo:
                  fContent: TXkgdGVzdCBmaWxlHJ==...
                  filename: my-doc.pdf
                  ftype: pdf
                  furl: https://mysite.com/my-doc.pdf
                orgId: 123
                'pageIdentifier:': 'null'
                recipientEmailNotification: true
                referenceName: payabli-00710
                referenceTemplateId: 1830
                resumable: false
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Boarding/applink/{appId}/{mail2}:
    put:
      operationId: boarding_getExternalApplication
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: getExternalApplication
      x-fern-request-name: getExternalApplicationRequest
      summary: Get link or email a link for a boarding application
      description: Retrieves a link and the verification code used to log into an existing boarding application. You can also use this endpoint to send a link and referenceId for an existing boarding application to an email address. The recipient can use the referenceId and email address to access and edit the application.
      security:
        - APIKeyAuth: []
      parameters:
        - name: appId
          in: path
          description: Boarding application ID.
          required: true
          schema:
            type: integer
          example: 352
        - name: mail2
          in: path
          description: Email address used to access the application. If `sendEmail` parameter is true, a link to the application is sent to this email address.
          required: true
          schema:
            type: string
          example: mail2
        - name: sendEmail
          in: query
          description: If `true`, sends an email that includes the link to the application to the `mail2` address. Defaults to `false`.
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse00'
              example:
                isSuccess: true
                responseCode: 1
                responseData:
                  appLink: https://boarding-sandbox.payabli.com/boarding/externalapp/load/17E
                  referenceId: n6UCd1f1ygG7
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Boarding/link/{boardingLinkReference}:
    get:
      operationId: boarding_GetLinkApplication
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: GetLinkApplication
      x-fern-request-name: GetLinkApplicationRequest
      summary: Get boarding Link by reference
      description: Retrieves the details for a boarding link, by reference name. This endpoint requires an application API token.
      security:
        - APIKeyAuth: []
      parameters:
        - name: boardingLinkReference
          in: path
          description: The boarding link reference name. You can find this at the end of the boarding link URL. For example `https://boarding.payabli.com/boarding/app/myorgaccountname-00091`
          required: true
          schema:
            type: string
          example: myorgaccountname-00091
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoardingLinkQueryRecord'
              example:
                acceptOauth: false
                acceptRegister: false
                builderData:
                  attributes:
                    minimumDocuments: 1
                    multipleContacts: true
                    multipleOwners: true
                entryAttributes: entryAttributes
                id: 1000000
                logo:
                  fContent: TXkgdGVzdCBmaWxlHJ==...
                  filename: my-doc.pdf
                  ftype: pdf
                  furl: https://mysite.com/my-doc.pdf
                orgId: 123
                'pageIdentifier:': 'null'
                recipientEmailNotification: true
                referenceName: payabli-00710
                referenceTemplateId: 1830
                resumable: false
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/boarding/{orgId}:
    get:
      operationId: boarding_ListApplications
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: ListApplications
      x-fern-request-name: ListApplicationsRequest
      summary: Get list of applications for an organization
      description: Returns a list of boarding applications for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: exportFormat
          in: query
          required: false
          description: Export format for file downloads. When specified, returns data as a file instead of JSON.
          schema:
            $ref: '#/components/schemas/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
          example: 251
        - 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
          example: 0
        - name: parameters
          in: query
          description: |-
            Collection of field names, conditions, and values used to filter the query

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `createdAt` (gt, ge, lt, le, eq, ne)
            - `startDate` (gt, ge, lt, le, eq, ne)
            - `dbaname` (ct, nct)
            - `legalname` (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)
            - `status` (in, nin, eq,ne)
            - `orgParentname` (ct, nct)
            - `externalpaypointID` (ct, nct, eq, ne)
            - `repCode` (ct, nct, eq, ne)
            - `repName` (ct, nct, eq, ne)
            - `repOffice` (ct, nct, eq, ne)
            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
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryBoardingAppsListResponse'
              example:
                Records:
                  - annualRevenue: 1000
                    averageMonthlyVolume: 1000
                    averageTicketAmount: 1000
                    bAddress1: 123 Walnut Street
                    bAddress2: Suite 103
                    bankData:
                      - accountNumber: 1XXXXXX3123
                        bankAccountFunction: 1
                        bankAccountHolderName: Gruzya Adventure Outfitters LLC
                        bankAccountHolderType: Personal
                        bankName: Country Bank
                        id: 1
                        nickname: Business Checking 1234
                        routingAccount: '123123123'
                        typeAccount: Checking
                        accountId: 123-456
                      - accountNumber: 1XXXXXX3123
                        bankAccountFunction: 0
                        bankAccountHolderName: Gruzya Adventure Outfitters LLC
                        bankAccountHolderType: Personal
                        bankName: Country Bank
                        id: 1
                        nickname: Business Checking 1234
                        routingAccount: '123123123'
                        typeAccount: Checking
                        accountId: 123-456
                    bCity: New Vegas
                    bCountry: US
                    bFax: '5551234567'
                    binPerson: 60
                    binPhone: 20
                    binWeb: 20
                    boardingLinkId: 91
                    boardingStatus: 1
                    boardingSubStatus: 1
                    bPhone: '5551234567'
                    bStartdate: 01/01/1990
                    bState: FL
                    bSummary: Brick and mortar store that sells office supplies
                    bZip: '33000'
                    contactData:
                      - {}
                    createdAt: '2022-07-01T15:00:01Z'
                    dbaName: Sunshine Gutters
                    ein: '123456789'
                    externalPaypointId: Paypoint-100
                    generalEvents:
                      - description: TransferCreated
                        eventTime: '2023-07-05T22:31:06Z'
                    highTicketAmount: 1000
                    idApplication: 352
                    lastModified: '2022-07-01T15:00:01Z'
                    legalName: Sunshine Services, LLC
                    license: 2222222FFG
                    licenseState: CA
                    mAddress1: 123 Walnut Street
                    mAddress2: STE 900
                    mccid: mccid
                    mCity: TN
                    mCountry: US
                    mState: TN
                    mZip: '37615'
                    orgId: 123
                    orgParentName: PropertyManager Pro
                    ownerData:
                      - {}
                    ownType: Limited Liability Company
                    pageidentifier: 'null'
                    recipientEmailNotification: true
                    resumable: false
                    salesCode: salesCode
                    taxfillname: Sunshine LLC
                    templateId: 22
                    websiteAddress: www.example.com
                    whencharged: When Service Provided
                    whendelivered: 0-7 Days
                    whenProvided: 30 Days or Less
                    whenrefund: Exchange Only
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 77.22
                  totalNetAmount: 77.22
                  totalPages: 2
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/boardinglinks/{orgId}:
    get:
      operationId: boarding_ListBoardingLinks
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: ListBoardingLinks
      x-fern-request-name: ListBoardingLinksRequest
      summary: Get list of boarding links for organization
      description: Return a list of boarding links for an organization. Use filters to limit results.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - 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
          example: 251
        - 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
          example: 0
        - name: parameters
          in: query
          description: |-
            Collection of field names, conditions, and values used to filter the query

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `lastUpdated` (gt, ge, lt, le, eq, ne)
            - `templateName` (ct, nct)
            - `referenceName` (ct, nct)
            - `acceptRegister` (eq, ne)
            - `acceptAuth` (eq, ne)
            - `templateCode` (ct, nct)
            - `templateId` (eq, ne)
            - `orgParentname` (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: templateName(ct)=hoa return all records with template title containing "hoa"
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryBoardingLinksResponse'
              example:
                Records:
                  - AcceptOauth: false
                    AcceptRegister: false
                    EntryAttributes: EntryAttributes
                    Id: 1
                    LastUpdated: '2022-07-01T15:00:01Z'
                    OrgParentName: PropertyManager Pro
                    ReferenceName: payabli-00710
                    ReferenceTemplateId: 1830
                    TemplateCode: TemplateCode
                    TemplateName: SMB
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 77.22
                  totalNetAmount: 77.22
                  totalPages: 2
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Boarding/applications:
    post:
      operationId: boarding_AddServiceToPaypointFromApp
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: AddServiceToPaypointFromApp
      x-fern-request-name: CreateApplicationFromPaypointRequest
      summary: Create multi-product boarding application
      description: Creates a new boarding application linked to an existing paypoint as part of the multi-product boarding flow. Use this endpoint to add new services to a paypoint without creating a duplicate record. The system copies eligible business, contact, banking, and address data from the paypoint to the new application based on 1:1 field matching. The merchant only needs to provide fields that are specific to the new service. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApplicationFromPaypointRequest'
            example:
              paypointId: 123
              templateId: 456
              recipientEmail: merchant@example.com
              returnBoardingAccessInfoInLine: true
              onCreate:
                - submitApplication
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApplicationFromPaypointResponse'
              example:
                responseCode: 1
                pageIdentifier: null
                roomId: 66594
                isSuccess: true
                responseText: Success
                responseData:
                  appId: 66594
                  boardingLink: https://boarding-sandbox.payabli.com/boarding/externalapp/load/10422?mode=25&email=merchant@example.com&referenceId=YpYNRPDOcGsm
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Boarding/applications/{paypointId}:
    get:
      operationId: boarding_GetApplicationsByPaypointId
      tags:
        - Boarding
      x-fern-sdk-group-name: boarding
      x-fern-sdk-method-name: GetApplicationsByPaypointId
      x-fern-request-name: GetApplicationsByPaypointIdRequest
      summary: Get multi-product boarding applications for a paypoint
      description: Returns all boarding applications associated with a specific paypoint, including those created through the multi-product boarding flow. Use this endpoint to track underwriting progress across multiple service additions or to build reporting views. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
      security:
        - APIKeyAuth: []
      parameters:
        - name: paypointId
          in: path
          description: ID of the paypoint to retrieve applications for.
          required: true
          schema:
            type: integer
            format: int64
          example: 12345
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryBoardingAppsListResponse'
              example:
                Records:
                  - idApplication: 68388
                    orgId: 3125
                    dbaName: Meadowbrook Phase II HOA A
                    legalName: Meadowbrook Phase II HOA B
                    ein: '601907058'
                    boardingStatus: 7
                    boardingSubStatus: 0
                    templateId: 8233
                    boardingLinkId: 6344
                    contactData:
                      - contactName: Gary Heaney
                        contactEmail: hello@meadowbrookphaseii.com
                        contactTitle: Human Group Designer
                        contactPhone: '7863078875'
                    generalEvents:
                      - description: Created
                        eventTime: '2026-03-17T18:56:39.8854072Z'
                      - description: Linked to paypoint 6257
                        eventTime: '2026-03-17T18:56:39.885413Z'
                      - description: 'Updated Status: 7, 0'
                        eventTime: '2026-03-18T19:32:39.4012114Z'
                Summary:
                  pageIdentifier: 'null'
                  pageSize: 0
                  totalAmount: 0
                  totalNetAmount: 0
                  totalPages: 0
                  totalRecords: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Templates/{templateId}:
    delete:
      operationId: templates_DeleteTemplate
      tags:
        - Templates
      x-fern-sdk-group-name: templates
      x-fern-sdk-method-name: DeleteTemplate
      x-fern-request-name: DeleteTemplateRequest
      summary: Delete boarding template
      description: Deletes a template by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: templateId
          in: path
          description: 'The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.'
          required: true
          schema:
            type: number
            format: double
          example: 80
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseTemplateId'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 3625
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Templates/getlink/{templateId}/{ignoreEmpty}:
    get:
      operationId: templates_getlinkTemplate
      tags:
        - Templates
      x-fern-sdk-group-name: templates
      x-fern-sdk-method-name: getlinkTemplate
      x-fern-request-name: getlinkTemplateRequest
      summary: Generate boarding link from template
      description: Generates a boarding link from a boarding template.
      security:
        - APIKeyAuth: []
      parameters:
        - name: ignoreEmpty
          in: path
          description: Ignore read-only and empty fields. Default is `false`. If `ignoreEmpty` = `false` and any field is empty, then the request returns a failure response. If `ignoreEmpty` = `true`, the request returns the boarding link name regardless of whether fields are empty.
          required: true
          schema:
            type: boolean
          example: true
        - name: templateId
          in: path
          description: 'The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.'
          required: true
          schema:
            type: number
            format: double
          example: 80
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoardingLinkApiResponse'
              example:
                responseData: '34'
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Templates/get/{templateId}:
    get:
      operationId: templates_getTemplate
      tags:
        - Templates
      x-fern-sdk-group-name: templates
      x-fern-sdk-method-name: getTemplate
      x-fern-request-name: getTemplateRequest
      summary: Get boarding template by ID
      description: Retrieves a boarding template's details by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: templateId
          in: path
          description: 'The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.'
          required: true
          schema:
            type: number
            format: double
          example: 80
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateQueryRecord'
              example:
                addPrice: true
                boardingLinks:
                  - acceptOauth: false
                    acceptRegister: false
                    entryAttributes: entryAttributes
                    id: 91
                    lastUpdated: '2022-07-01T15:00:01Z'
                    orgParentName: PropertyManager Pro
                    referenceName: payabli-00710
                    referenceTemplateId: 1830
                    templateCode: templateCode
                    templateName: SMB
                createdAt: '2022-07-01T15:00:01Z'
                idTemplate: 1000000
                isRoot: false
                orgParentName: PropertyManager Pro
                recipientEmailNotification: true
                resumable: false
                templateCode: templateCode
                templateContent:
                  businessData:
                    visible: true
                  documentsData:
                    minimumDocuments: 1
                    subFooter: subFooter
                    subHeader: subHeader
                    uploadDocuments: true
                    visible: true
                  ownershipData:
                    multipleContacts: true
                    multipleOwners: true
                    subFooter: subFooter
                    subHeader: subHeader
                    visible: true
                  processingData:
                    subFooter: subFooter
                    subHeader: subHeader
                    visible: true
                  salesData:
                    salesCode: salesCode
                    salesCRM: salesCRM
                  servicesData:
                    subFooter: subFooter
                    subHeader: subHeader
                    visible: true
                  underwritingData:
                    method: automatic
                    policyId: J-itEyD6A7y5S5yYFjxOrb
                templateDescription: templateDescription
                templateTitle: templateTitle
                usedBy: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Query/templates/{orgId}:
    get:
      operationId: templates_ListTemplates
      tags:
        - Templates
      x-fern-sdk-group-name: templates
      x-fern-sdk-method-name: ListTemplates
      x-fern-request-name: ListTemplatesRequest
      summary: Get list of boarding templates for organization
      description: Retrieves a list of boarding templates for an organization. Use filters to limit results. You can't make a request that includes filters from the API console in the documentation. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - 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
          example: 251
        - 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
          example: 0
        - 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>


            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `createdAt` (gt, ge, lt, le, eq, ne)
            - `title` (ct, nct)
            - `description` (ct, nct)
            - `code` (ct, nct)
            - `orgParentname` (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: title(ct)=hoa return all records with title containing "hoa"
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateQueryResponse'
              example:
                records:
                  - addPrice: true
                    boardingLinks:
                      - id: 91
                    createdAt: '2022-07-01T15:00:01Z'
                    idTemplate: 1000000
                    isRoot: false
                    orgParentName: PropertyManager Pro
                    recipientEmailNotification: true
                    resumable: false
                    templateCode: templateCode
                    templateDescription: templateDescription
                    templateTitle: templateTitle
                    usedBy: 1
                summary:
                  pageIdentifier: 'null'
                  pageSize: 20
                  totalAmount: 77.22
                  totalNetAmount: 77.22
                  totalPages: 2
                  totalRecords: 2
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/boarding/{format}/{orgId}:
    get:
      operationId: export_ExportApplications
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportApplications
      x-fern-request-name: ExportApplicationsRequest
      summary: Export list of boarding applications for organization
      description: Export a list of boarding applications for an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `createdAt` (gt, ge, lt, le, eq, ne)
            - `startDate` (gt, ge, lt, le, eq, ne)
            - `dbaname`  (ct, nct)
            - `legalname`  (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)
            - `status`  (eq, ne)
            - `orgParentname`  (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
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/batchDetails/{format}/{entry}:
    get:
      operationId: export_ExportBatchDetails
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportBatchDetails
      x-fern-request-name: ExportBatchDetailsRequest
      summary: Export batch details for a paypoint
      description: This endpoint is deprecated. Export batch details for a paypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            **List of field names accepted:**

              - `settlementDate` (gt, ge, lt, le, eq, ne)
              - `depositDate` (gt, ge, lt, le, eq, ne)
              - `transId`  (ne, eq, ct, nct)
              - `gatewayTransId`  (ne, eq, ct, nct)
              - `method`   (in, nin, eq, ne)
              - `settledAmount`  (gt, ge, lt, le, eq, ne)
              - `operation`    (in, nin, eq, ne)
              - `source`   (in, nin, eq, ne)
              - `batchNumber`  (ct, nct, eq, ne)
              - `payaccountLastfour`   (nct, ct)
              - `payaccountType`   (ne, eq, in, nin)
              - `customerFirstname`   (ct, nct, eq, ne)
              - `customerLastname`    (ct, nct, eq, ne)
              - `customerName`   (ct, nct)
              - `customerId`  (eq, ne)
              - `customerNumber`  (ct, nct, eq, ne)
              - `customerCompanyname`    (ct, nct, eq, ne)
              - `customerAddress` (ct, nct, eq, ne)
              - `customerCity`    (ct, nct, eq, ne)
              - `customerZip` (ct, nct, eq, ne)
              - `customerState` (ct, nct, eq, ne)
              - `customerCountry` (ct, nct, eq, ne)
              - `customerPhone` (ct, nct, eq, ne)
              - `customerEmail` (ct, nct, eq, ne)
              - `customerShippingAddress` (ct, nct, eq, ne)
              - `customerShippingCity`    (ct, nct, eq, ne)
              - `customerShippingZip` (ct, nct, eq, ne)
              - `customerShippingState` (ct, nct, eq, ne)
              - `customerShippingCountry` (ct, nct, eq, ne)
              - `orgId`  (eq) *mandatory when entry=org*
              - `isHold` (eq, ne)
              - `paypointId`  (ne, eq)
              - `paypointLegal`  (ne, eq, ct, nct)
              - `paypointDba`  (ne, eq, ct, nct)
              - `orgName`  (ne, eq, ct, nct)
              - `batchId` (ct, nct, eq, neq)
              - `additional-xxx`  (ne, eq, ct, nct) where xxx is the additional field name

            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: `amount(gt)=20` return all records with amount greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/batchDetails/{format}/org/{orgId}:
    get:
      operationId: export_ExportBatchDetailsOrg
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportBatchDetailsOrg
      x-fern-request-name: ExportBatchDetailsOrgRequest
      summary: Export batch details for an org
      description: This endpoint is deprecated. Export batch details for an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            **List of field names accepted:**

              - `settlementDate` (gt, ge, lt, le, eq, ne)
              - `depositDate` (gt, ge, lt, le, eq, ne)
              - `transId`  (ne, eq, ct, nct)
              - `gatewayTransId`  (ne, eq, ct, nct)
              - `method`   (in, nin, eq, ne)
              - `settledAmount`  (gt, ge, lt, le, eq, ne)
              - `operation`    (in, nin, eq, ne)
              - `source`   (in, nin, eq, ne)
              - `batchNumber`  (ct, nct, eq, ne)
              - `payaccountLastfour`   (nct, ct)
              - `payaccountType`   (ne, eq, in, nin)
              - `customerFirstname`   (ct, nct, eq, ne)
              - `customerLastname`    (ct, nct, eq, ne)
              - `customerName`   (ct, nct)
              - `customerId`  (eq, ne)
              - `customerNumber`  (ct, nct, eq, ne)
              - `customerCompanyname`    (ct, nct, eq, ne)
              - `customerAddress` (ct, nct, eq, ne)
              - `customerCity`    (ct, nct, eq, ne)
              - `customerZip` (ct, nct, eq, ne)
              - `customerState` (ct, nct, eq, ne)
              - `customerCountry` (ct, nct, eq, ne)
              - `customerPhone` (ct, nct, eq, ne)
              - `customerEmail` (ct, nct, eq, ne)
              - `customerShippingAddress` (ct, nct, eq, ne)
              - `customerShippingCity`    (ct, nct, eq, ne)
              - `customerShippingZip` (ct, nct, eq, ne)
              - `customerShippingState` (ct, nct, eq, ne)
              - `customerShippingCountry` (ct, nct, eq, ne)
              - `orgId`  (eq) *mandatory when entry=org*
              - `isHold` (eq, ne)
              - `paypointId`  (ne, eq)
              - `paypointLegal`  (ne, eq, ct, nct)
              - `paypointDba`  (ne, eq, ct, nct)
              - `orgName`  (ne, eq, ct, nct)
              - `batchId` (ct, nct, eq, neq)
              - `additional-xxx`  (ne, eq, ct, nct) where xxx is the additional field name

            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: `amount(gt)=20` return all records with amount greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/batches/{format}/{entry}:
    get:
      operationId: export_ExportBatches
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportBatches
      x-fern-request-name: ExportBatchesRequest
      summary: Export list of batches for entrypoint
      description: Export a list of batches for an entrypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `batchDate` (gt, ge, lt, le, eq, ne)
            - `batchNumber` (ne, eq)
            - `connectorName` (ne, eq, ct, nct)
            - `method` (in, nin, eq, ne)
            - `batchAmount` (gt, ge, lt, le, eq, ne)
            - `feeBatchAmount` (gt, ge, lt, le, eq, ne)
            - `netBatchAmount` (gt, ge, lt, le, eq, ne)
            - `releaseAmount` (gt, ge, lt, le, eq, ne)
            - `heldAmount` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `paypointId` (ne, eq)
            - `externalPaypointID` (ct, nct, eq, ne)
            - `expectedDepositDate` (gt, ge, lt, le, eq, ne)
            - `batchRecords` (gt, ge, lt, le, eq, ne)
            - `transferId` (ne, eq)
            - `transferDate` (gt, ge, lt, le, eq, ne)
            - `grossAmount` (gt, ge, lt, le, eq, ne)
            - `chargeBackAmount` (gt, ge, lt, le, eq, ne)
            - `returnedAmount` (gt, ge, lt, le, eq, ne)
            - `billingFeeAmount` (gt, ge, lt, le, eq, ne)
            - `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)
            - `netFundedAmount` (gt, ge, lt, le, eq, ne)
            - `adjustmentAmount` (gt, ge, lt, le, eq, ne)
            - `processor` (ne, eq, ct, nct)
            - `transferStatus` (ne, eq, in, nin)

            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: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/batches/{format}/org/{orgId}:
    get:
      operationId: export_ExportBatchesOrg
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportBatchesOrg
      x-fern-request-name: ExportBatchesOrgRequest
      summary: Export list of batches for organization
      description: Export a list of batches for an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>
            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `batchDate` (gt, ge, lt, le, eq, ne)
            - `batchNumber` (ne, eq)
            - `connectorName` (ne, eq, ct, nct)
            - `method` (in, nin, eq, ne)
            - `batchAmount` (gt, ge, lt, le, eq, ne)
            - `feeBatchAmount` (gt, ge, lt, le, eq, ne)
            - `netBatchAmount` (gt, ge, lt, le, eq, ne)
            - `releaseAmount` (gt, ge, lt, le, eq, ne)
            - `heldAmount` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `paypointId` (ne, eq)
            - `externalPaypointID` (ct, nct, eq, ne)
            - `expectedDepositDate` (gt, ge, lt, le, eq, ne)
            - `batchRecords` (gt, ge, lt, le, eq, ne)
            - `transferId` (ne, eq)
            - `transferDate` (gt, ge, lt, le, eq, ne)
            - `grossAmount` (gt, ge, lt, le, eq, ne)
            - `chargeBackAmount` (gt, ge, lt, le, eq, ne)
            - `returnedAmount` (gt, ge, lt, le, eq, ne)
            - `billingFeeAmount` (gt, ge, lt, le, eq, ne)
            - `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)
            - `netFundedAmount` (gt, ge, lt, le, eq, ne)
            - `adjustmentAmount` (gt, ge, lt, le, eq, ne)
            - `processor` (ne, eq, ct, nct)
            - `transferStatus` (ne, eq, in, nin)

            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: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/batchesOut/{format}/{entry}:
    get:
      operationId: export_ExportBatchesOut
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportBatchesOut
      x-fern-request-name: ExportBatchesOutRequest
      summary: Export list of pay out batches for entrypoint
      description: Export a list of money out batches for a paypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
              - `batchDate` (gt, ge, lt, le, eq, ne)
              - `batchNumber` (ne, eq)
              - `batchAmount` (gt, ge, lt, le, eq, ne)
              - `status` (in, nin, eq, ne)
              - `paypointLegal` (ne, eq, ct, nct)
              - `paypointDba` (ne, eq, ct, nct)
              - `orgName` (ne, eq, ct, nct, nin, in)
              - `paypointId` (ne, eq)
              - `externalPaypointID` (ct, nct, eq, ne)
            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: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00"
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/batchesOut/{format}/org/{orgId}:
    get:
      operationId: export_ExportBatchesOutOrg
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportBatchesOutOrg
      x-fern-request-name: ExportBatchesOutOrgRequest
      summary: Export list of pay out batches for organization
      description: Export a list of money out batches for an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
              - `batchDate` (gt, ge, lt, le, eq, ne)
              - `batchNumber` (ne, eq)
              - `batchAmount` (gt, ge, lt, le, eq, ne)
              - `status` (in, nin, eq, ne)
              - `paypointLegal` (ne, eq, ct, nct)
              - `paypointDba` (ne, eq, ct, nct)
              - `orgName` (ne, eq, ct, nct, nin, in)
              - `paypointId` (ne, eq)
              - `externalPaypointID` (ct, nct, eq, ne)
            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: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00"
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/bills/{format}/{entry}:
    get:
      operationId: export_ExportBills
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportBills
      x-fern-request-name: ExportBillsRequest
      summary: Export list of bills for an entrypoint
      description: Export a list of bills for an entrypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `status` (in, nin, eq, ne)
            - `billNumber` (ct, nct, eq, ne)
            - `billDate` (gt, ge, lt, le, eq, ne)
            - `billDueDate` (gt, ge, lt, le, eq, ne)
            - `vendorNumber` (ct, nct, eq, ne)
            - `vendorName` (ct, nct, eq, ne)
            - `ein` (ct, nct, eq, ne)
            - `paymentMethod` (ct, nct, eq, ne)
            - `paymentId` (ct, nct, eq, ne)
            - `paymentgroup` (ct, nct, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, 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 separated by "|"
            - nin => not inside array separated by "|"

            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: totalAmount(gt)=20  return all records with totalAmount greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/bills/{format}/org/{orgId}:
    get:
      operationId: export_ExportBillsOrg
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportBillsOrg
      x-fern-request-name: ExportBillsOrgRequest
      summary: Export list of bills for organization
      description: Export a list of bills for an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `status` (in, nin, eq, ne)
            - `billNumber` (ct, nct, eq, ne)
            - `billDate` (gt, ge, lt, le, eq, ne)
            - `billDueDate` (gt, ge, lt, le, eq, ne)
            - `vendorNumber` (ct, nct, eq, ne)
            - `vendorName` (ct, nct, eq, ne)
            - `ein` (ct, nct, eq, ne)
            - `paymentMethod` (ct, nct, eq, ne)
            - `paymentId` (ct, nct, eq, ne)
            - `paymentgroup` (ct, nct, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, 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 separated by "|"
            - nin => not inside array separated by "|"

            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: totalAmount(gt)=20  return all records with totalAmount greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/chargebacks/{format}/{entry}:
    get:
      operationId: export_ExportChargebacks
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportChargebacks
      x-fern-request-name: ExportChargebacksRequest
      summary: Export list of chargebacks and returned transactions for entrypoint
      description: Export a list of chargebacks and ACH returns for an entrypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `chargebackDate` (gt, ge, lt, le, eq, ne)
            - `transId` (ne, eq, ct, nct)
            - `method` (in, nin, eq, ne)
            - `netAmount` (gt, ge, lt, le, eq, ne)
            - `reasonCode` (in, nin, eq, ne)
            - `reason` (ct, nct, eq, ne)
            - `caseNumber` (ct, nct, eq, ne)
            - `status` (in, nin, eq, ne)
            - `accountType` (in, nin, eq, ne)
            - `payaccountLastfour` (nct, ct)
            - `payaccountType` (ne, eq, in, nin)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId` (eq) *mandatory when entry=org*
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            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 separated by "|"
            - nin => not inside array separated by "|"

            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: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/chargebacks/{format}/org/{orgId}:
    get:
      operationId: export_ExportChargebacksOrg
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportChargebacksOrg
      x-fern-request-name: ExportChargebacksOrgRequest
      summary: Export list of chargebacks and returned transactions for an organization
      description: Export a list of chargebacks and ACH returns for an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `chargebackDate` (gt, ge, lt, le, eq, ne)
            - `transId` (ne, eq, ct, nct)
            - `method` (in, nin, eq, ne)
            - `netAmount` (gt, ge, lt, le, eq, ne)
            - `reasonCode` (in, nin, eq, ne)
            - `reason` (ct, nct, eq, ne)
            - `caseNumber` (ct, nct, eq, ne)
            - `status` (in, nin, eq, ne)
            - `accountType` (in, nin, eq, ne)
            - `payaccountLastfour` (nct, ct)
            - `payaccountType` (ne, eq, in, nin)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId` (eq) *mandatory when entry=org*
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            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 separated by "|"
            - nin => not inside array separated by "|"

            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: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/customers/{format}/{entry}:
    get:
      operationId: export_ExportCustomers
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportCustomers
      x-fern-request-name: ExportCustomersRequest
      summary: Export list of customers for entrypoint
      description: Export a list of customers for an entrypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            **List of field names accepted:**
            - `createdDate` (gt, ge, lt, le, eq, ne)
            - `customernumber` (ne, eq, ct, nct)
            - `firstname` (ne, eq, ct, nct)
            - `lastname` (ne, eq, ct, nct)
            - `name` (ct, nct)
            - `address` (ne, eq, ct, nct)
            - `city` (ne, eq, ct, nct)
            - `country` (ne, eq, ct, nct)
            - `zip` (ne, eq, ct, nct)
            - `state` (ne, eq, ct, nct)
            - `shippingaddress` (ne, eq, ct, nct)
            - `shippingcity` (ne, eq, ct, nct)
            - `shippingcountry` (ne, eq, ct, nct)
            - `shippingzip` (ne, eq, ct, nct)
            - `shippingstate` (ne, eq, ct, nct)
            - `phone` (ne, eq, ct, nct)
            - `email` (ne, eq, ct, nct)
            - `company` (ne, eq, ct, nct)
            - `username` (ne, eq, ct, nct)
            - `balance` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
            - `orgId` (eq) *mandatory when entry=org*
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, 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 separated by "|"
            - nin => not inside array separated by "|"

            **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:**
            balance(gt)=20 return all records with balance greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/customers/{format}/org/{orgId}:
    get:
      operationId: export_ExportCustomersOrg
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportCustomersOrg
      x-fern-request-name: ExportCustomersOrgRequest
      summary: Export list of customers for organization
      description: Exports a list of customers for an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            **List of field names accepted:**
            - `createdDate` (gt, ge, lt, le, eq, ne)
            - `customernumber` (ne, eq, ct, nct)
            - `firstname` (ne, eq, ct, nct)
            - `lastname` (ne, eq, ct, nct)
            - `name` (ct, nct)
            - `address` (ne, eq, ct, nct)
            - `city` (ne, eq, ct, nct)
            - `country` (ne, eq, ct, nct)
            - `zip` (ne, eq, ct, nct)
            - `state` (ne, eq, ct, nct)
            - `shippingaddress` (ne, eq, ct, nct)
            - `shippingcity` (ne, eq, ct, nct)
            - `shippingcountry` (ne, eq, ct, nct)
            - `shippingzip` (ne, eq, ct, nct)
            - `shippingstate` (ne, eq, ct, nct)
            - `phone` (ne, eq, ct, nct)
            - `email` (ne, eq, ct, nct)
            - `company` (ne, eq, ct, nct)
            - `username` (ne, eq, ct, nct)
            - `balance` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
            - `orgId` (eq) *mandatory when entry=org*
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, 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 separated by "|"
            - nin => not inside array separated by "|"

            **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:**
            balance(gt)=20 return all records with balance greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/invoices/{format}/{entry}:
    get:
      operationId: export_ExportInvoices
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportInvoices
      x-fern-request-name: ExportInvoicesRequest
      summary: Export list of invoices for an entrypoint
      description: Export list of invoices for an entrypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
             - `invoiceDate` (gt, ge, lt, le, eq, ne)
             - `dueDate` (gt, ge, lt, le, eq, ne)
             - `sentDate` (gt, ge, lt, le, eq, ne)
             - `frequency`  (in, nin,ne, eq)
             - `invoiceType`   (eq, ne)
             - `payTerms`   (in, nin, eq, ne)
             - `paypointId`  (ne, eq)
             - `totalAmount`  (gt, ge, lt, le, eq, ne)
             - `paidAmount`  (gt, ge, lt, le, eq, ne)
             - `status`   (in, nin, eq, ne)
             - `invoiceNumber`   (ct, nct, eq, ne)
             - `purchaseOrder`   (ct, nct, eq, ne)
             - `itemProductCode` (ct, nct)
             - `itemDescription` (ct, nct)
             - `customerFirstname`   (ct, nct, eq, ne)
             - `customerLastname`    (ct, nct, eq, ne)
             - `customerName`   (ct, nct)
             - `customerId`  (eq, ne)
             - `customerNumber`  (ct, nct, eq, ne)
             - `customerCompanyname`    (ct, nct, eq, ne)
             - `customerAddress` (ct, nct, eq, ne)
             - `customerCity`    (ct, nct, eq, ne)
             - `customerZip` (ct, nct, eq, ne)
             - `customerState` (ct, nct, eq, ne)
             - `customerCountry` (ct, nct, eq, ne)
             - `customerPhone` (ct, nct, eq, ne)
             - `customerEmail` (ct, nct, eq, ne)
             - `customerShippingAddress` (ct, nct, eq, ne)
             - `customerShippingCity` (ct, nct, eq, ne)
             - `customerShippingZip` (ct, nct, eq, ne)
             - `customerShippingState` (ct, nct, eq, ne)
             - `customerShippingCountry` (ct, nct, eq, ne)
             - `orgId`  (eq)
             - `paylinkId`  (ne, eq)
             - `paypointLegal`  (ne, eq, ct, nct)
             - `paypointDba`  (ne, eq, ct, nct)
             - `orgName`  (ne, eq, ct, nct)
             - `additional-xxx`  (ne, eq, ct, nct) where xxx is the additional field name

            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: `totalAmount(gt)=20` returns all records with `totalAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/invoices/{format}/org/{orgId}:
    get:
      operationId: export_ExportInvoicesOrg
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportInvoicesOrg
      x-fern-request-name: ExportInvoicesOrgRequest
      summary: Export list of invoices for an organization
      description: Export a list of invoices for an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
             - `invoiceDate` (gt, ge, lt, le, eq, ne)
             - `dueDate` (gt, ge, lt, le, eq, ne)
             - `sentDate` (gt, ge, lt, le, eq, ne)
             - `frequency` (in, nin,ne, eq)
             - `invoiceType` (eq, ne)
             - `payTerms` (in, nin, eq, ne)
             - `paypointId` (ne, eq)
             - `totalAmount` (gt, ge, lt, le, eq, ne)
             - `paidAmount` (gt, ge, lt, le, eq, ne)
             - `status` (in, nin, eq, ne)
             - `invoiceNumber` (ct, nct, eq, ne)
             - `purchaseOrder` (ct, nct, eq, ne)
             - `itemProductCode` (ct, nct)
             - `itemDescription` (ct, nct)
             - `customerFirstname` (ct, nct, eq, ne)
             - `customerLastname` (ct, nct, eq, ne)
             - `customerName` (ct, nct)
             - `customerId` (eq, ne)
             - `customerNumber` (ct, nct, eq, ne)
             - `customerCompanyname` (ct, nct, eq, ne)
             - `customerAddress` (ct, nct, eq, ne)
             - `customerCity` (ct, nct, eq, ne)
             - `customerZip` (ct, nct, eq, ne)
             - `customerState` (ct, nct, eq, ne)
             - `customerCountry` (ct, nct, eq, ne)
             - `customerPhone` (ct, nct, eq, ne)
             - `customerEmail` (ct, nct, eq, ne)
             - `customerShippingAddress` (ct, nct, eq, ne)
             - `customerShippingCity` (ct, nct, eq, ne)
             - `customerShippingZip` (ct, nct, eq, ne)
             - `customerShippingState` (ct, nct, eq, ne)
             - `customerShippingCountry` (ct, nct, eq, ne)
             - `orgId` (eq)
             - `paylinkId` (ne, eq)
             - `paypointLegal` (ne, eq, ct, nct)
             - `paypointDba` (ne, eq, ct, nct)
             - `orgName` (ne, eq, ct, nct)
             - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            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: totalAmount(gt)=20  return all records with totalAmount greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/organizations/{format}/org/{orgId}:
    get:
      operationId: export_ExportOrganizations
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportOrganizations
      x-fern-request-name: ExportOrganizationsRequest
      summary: Export list of child organization for a parent organization
      description: Export a list of child organizations (suborganizations) for a parent organization.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `name` (ct, nct, eq, ne)
            - `type` (ne, eq)
            - `contactName` (ct, nct, eq, ne)
            - `contactTitle` (ct, nct, eq, ne)
            - `contactEmail` (ct, nct, eq, ne)
            - `contactPhone` (ct, nct, eq, ne)
            - `city` (ct, nct, eq, ne)
            - `state` (in, nin, eq, ne)
            - `address` (ct, nct, eq, ne)
            - `country` (ct, nct, eq, ne)
            - `zip` (ct, nct, eq, ne)
            - `hasBilling` any value greater than zero is taken as TRUE otherwise is FALSE
            - `hasResidual` any value greater than zero is taken as TRUE otherwise is FALSE

            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: name(ct)=hoa  return all records where name contains "hoa"
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/payouts/{format}/{entry}:
    get:
      operationId: export_ExportPayout
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportPayout
      x-fern-request-name: ExportPayoutRequest
      summary: Export list of payouts for an entrypoint
      description: Export a list of payouts and their statuses for an entrypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `status` (in, nin, eq, ne)
            - `transactionDate` (gt, ge, lt, le, eq, ne)
            - `billNumber` (ct, nct)
            - `vendorNumber` (ct, nct, eq, ne)
            - `vendorName` (ct, nct, eq, ne)
            - `paymentMethod` (ct, nct, eq, ne)
            - `paymentId` (ct, nct, eq, ne)
            - `paymentgroup` (ct, nct, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, 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 separated by "|"
            - nin => not inside array separated by "|"

            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: totalAmount(gt)=20 return all records with totalAmount greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/payouts/{format}/org/{orgId}:
    get:
      operationId: export_ExportPayoutOrg
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportPayoutOrg
      x-fern-request-name: ExportPayoutOrgRequest
      summary: Export list of payouts for organization
      description: Export a list of payouts and their details for an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `status` (in, nin, eq, ne)
            - `transactionDate` (gt, ge, lt, le, eq, ne)
            - `billNumber` (ct, nct)
            - `vendorNumber` (ct, nct, eq, ne)
            - `vendorName` (ct, nct, eq, ne)
            - `paymentMethod` (ct, nct, eq, ne)
            - `paymentId` (ct, nct, eq, ne)
            - `paymentgroup` (ct, nct, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, 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 separated by "|"
            - nin => not inside array separated by "|"

            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: totalAmount(gt)=20 return all records with totalAmount greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/paypoints/{format}/{orgId}:
    get:
      operationId: export_ExportPaypoints
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportPaypoints
      x-fern-request-name: ExportPaypointsRequest
      summary: Export list of paypoints in an organization
      description: Export a list of paypoints in an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `createdAt` (gt, ge, lt, le, eq, ne)
            - `startDate` (gt, ge, lt, le, eq, ne)
            - `dbaname` (ct, nct)
            - `legalname` (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)
            - `orgParentname` (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 `dbaname` containing "hoa"
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/settlements/{format}/{entry}:
    get:
      operationId: export_ExportSettlements
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportSettlements
      x-fern-request-name: ExportSettlementsRequest
      summary: Export list of settled transactions for entrypoint
      description: Export a list of settled transactions for an entrypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `settlementDate` (gt, ge, lt, le, eq, ne)
            - `transId` (ne, eq, ct, nct)
            - `gatewayTransId` (ne, eq, ct, nct)
            - `method` (in, nin, eq, ne)
            - `settledAmount` (gt, ge, lt, le, eq, ne)
            - `operation` (in, nin, eq, ne)
            - `source` (in, nin, eq, ne)
            - `batchNumber` (ct, nct, eq, ne)
            - `payaccountLastfour` (nct, ct)
            - `payaccountType` (ne, eq, in, nin)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId` (eq) *mandatory when entry=org*
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            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 separated by "|"
            - nin => not inside array separated by "|"

            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: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/settlements/{format}/org/{orgId}:
    get:
      operationId: export_ExportSettlementsOrg
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportSettlementsOrg
      x-fern-request-name: ExportSettlementsOrgRequest
      summary: Export list of settled transactions for organization
      description: Export a list of settled transactions for an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `settlementDate` (gt, ge, lt, le, eq, ne)
            - `transId` (ne, eq, ct, nct)
            - `gatewayTransId` (ne, eq, ct, nct)
            - `method` (in, nin, eq, ne)
            - `settledAmount` (gt, ge, lt, le, eq, ne)
            - `operation` (in, nin, eq, ne)
            - `source` (in, nin, eq, ne)
            - `batchNumber` (ct, nct, eq, ne)
            - `payaccountLastfour` (nct, ct)
            - `payaccountType` (ne, eq, in, nin)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId` (eq) *mandatory when entry=org*
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            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 separated by "|"
            - nin => not inside array separated by "|"

            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: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/subscriptions/{format}/{entry}:
    get:
      operationId: export_ExportSubscriptions
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportSubscriptions
      x-fern-request-name: ExportSubscriptionsRequest
      summary: Export list of subscriptions for an entrypoint
      description: Export a list of subscriptions for an entrypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `startDate` (gt, ge, lt, le, eq, ne)
            - `endDate` (gt, ge, lt, le, eq, ne)
            - `nextDate` (gt, ge, lt, le, eq, ne)
            - `frequency` (in, nin, ne, eq)
            - `method` (in, nin, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `netAmount` (gt, ge, lt, le, eq, ne)
            - `feeAmount` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `untilcancelled` (eq, ne)
            - `payaccountLastfour` (nct, ct)
            - `payaccountType` (ne, eq, in, nin)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId` (eq)
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            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: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/subscriptions/{format}/org/{orgId}:
    get:
      operationId: export_ExportSubscriptionsOrg
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportSubscriptionsOrg
      x-fern-request-name: ExportSubscriptionsOrgRequest
      summary: Export list of subscriptions for an organization
      description: Export a list of subscriptions for an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `startDate` (gt, ge, lt, le, eq, ne)
            - `endDate` (gt, ge, lt, le, eq, ne)
            - `nextDate` (gt, ge, lt, le, eq, ne)
            - `frequency` (in, nin, ne, eq)
            - `method` (in, nin, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `netAmount` (gt, ge, lt, le, eq, ne)
            - `feeAmount` (gt, ge, lt, le, eq, ne)
            - `status` (in, nin, eq, ne)
            - `untilcancelled` (eq, ne)
            - `payaccountLastfour` (nct, ct)
            - `payaccountType` (ne, eq, in, nin)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `orgId` (eq)
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            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: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/transactions/{format}/{entry}:
    get:
      operationId: export_ExportTransactions
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportTransactions
      x-fern-request-name: ExportTransactionsRequest
      summary: Export list of transactions for entrypoint
      description: Export a list of transactions for an entrypoint in a file in XLXS or CSV format. Use filters to limit results. If you don't specify a date range in the request, the last two months of data are returned.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `transactionDate` (gt, ge, lt, le, eq, ne)
            - `transId` (ne, eq, ct, nct)
            - `gatewayTransId` (ne, eq, ct, nct)
            - `orderId` (ne, eq)
            - `idTrans` (ne, eq)
            - `orgId` (ne, eq)
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `method` (in, nin, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `netAmount` (gt, ge, lt, le, eq, ne)
            - `feeAmount` (gt, ge, lt, le, eq, ne)
            - `operation` (in, nin, eq, ne)
            - `source` (in, nin, eq, ne)
            - `status` (in, nin, eq, ne)
            - `settlementStatus` (in, nin, eq, ne)
            - `batchNumber` (nct, ct)
            - `payaccountLastfour` (nct, ct)
            - `payaccountType` (ne, eq, in, nin)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            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: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/transactions/{format}/org/{orgId}:
    get:
      operationId: export_ExportTransactionsOrg
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportTransactionsOrg
      x-fern-request-name: ExportTransactionsOrgRequest
      summary: Export list of transactions for an org
      description: Export a list of transactions for an org in a file in XLSX or CSV format. Use filters to limit results. If you don't specify a date range in the request, the last two months of data are returned.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `transactionDate` (gt, ge, lt, le, eq, ne)
            - `transId` (ne, eq, ct, nct)
            - `gatewayTransId` (ne, eq, ct, nct)
            - `orderId` (ne, eq)
            - `idTrans` (ne, eq)
            - `orgId` (ne, eq)
            - `paypointId` (ne, eq)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, ct, nct)
            - `method` (in, nin, eq, ne)
            - `totalAmount` (gt, ge, lt, le, eq, ne)
            - `netAmount` (gt, ge, lt, le, eq, ne)
            - `feeAmount` (gt, ge, lt, le, eq, ne)
            - `operation` (in, nin, eq, ne)
            - `source` (in, nin, eq, ne)
            - `status` (in, nin, eq, ne)
            - `settlementStatus` (in, nin, eq, ne)
            - `batchNumber` (nct, ct)
            - `payaccountLastfour` (nct, ct)
            - `payaccountType` (ne, eq, in, nin)
            - `customerFirstname` (ct, nct, eq, ne)
            - `customerLastname` (ct, nct, eq, ne)
            - `customerName` (ct, nct)
            - `customerId` (eq, ne)
            - `customerNumber` (ct, nct, eq, ne)
            - `customerCompanyname` (ct, nct, eq, ne)
            - `customerAddress` (ct, nct, eq, ne)
            - `customerCity` (ct, nct, eq, ne)
            - `customerZip` (ct, nct, eq, ne)
            - `customerState` (ct, nct, eq, ne)
            - `customerCountry` (ct, nct, eq, ne)
            - `customerPhone` (ct, nct, eq, ne)
            - `customerEmail` (ct, nct, eq, ne)
            - `customerShippingAddress` (ct, nct, eq, ne)
            - `customerShippingCity` (ct, nct, eq, ne)
            - `customerShippingZip` (ct, nct, eq, ne)
            - `customerShippingState` (ct, nct, eq, ne)
            - `customerShippingCountry` (ct, nct, eq, ne)
            - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name

            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: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/transferDetails/{format}/{entry}/{transferId}:
    get:
      operationId: export_ExportTransferDetails
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportTransferDetails
      x-fern-request-name: ExportTransferDetailsRequest
      summary: Export list of transfer details
      description: Export a list of transfer details for an entrypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: transferId
          in: path
          description: Transfer identifier.
          required: true
          schema:
            type: integer
            format: int64
          example: 1000000
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:

              - `grossAmount` (gt, ge, lt, le, eq, ne)

              - `chargeBackAmount` (gt, ge, lt, le, eq, ne)

              - `returnedAmount` (gt, ge, lt, le, eq, ne)

              - `billingFeeAmount` (gt, ge, lt, le, eq, ne)

              - `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)

              - `netFundedAmount` (gt, ge, lt, le, eq, ne)

              - `adjustmentAmount` (gt, ge, lt, le, eq, ne)

              - `transactionId` (eq, ne, in, nin)

              - `category` (eq, ne, ct, nct)

              - `type` (eq, ne, in, nin)

              - `method` (eq, ne, in, nin)
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/transfers/{entry}:
    get:
      operationId: export_ExportTransfers
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportTransfers
      x-fern-request-name: ExportTransfersRequest
      summary: Export list of transfers for entrypoint
      description: Get a list of transfers for an entrypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
              - `transferDate` (gt, ge, lt, le, eq, ne)

              - `grossAmount` (gt, ge, lt, le, eq, ne)

              - `chargeBackAmount` (gt, ge, lt, le, eq, ne)

              - `returnedAmount` (gt, ge, lt, le, eq, ne)

              - `billingFeeAmount` (gt, ge, lt, le, eq, ne)

              - `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)

              - `netFundedAmount` (gt, ge, lt, le, eq, ne)

              - `adjustmentAmount` (gt, ge, lt, le, eq, ne)

              - `processor` (ne, eq, ct, nct)

              - `transferStatus` (ne, eq, in, nin)

              - `batchNumber` (ne, eq, ct, nct)

              - `batchId` (ne, eq, in, nin)
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - 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
          example: desc(field_name)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/vendors/{format}/{entry}:
    get:
      operationId: export_ExportVendors
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportVendors
      x-fern-request-name: ExportVendorsRequest
      summary: Export vendors for an entrypoint
      description: Export a list of vendors for an entrypoint. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `method` (in, nin, eq, ne)
            - `enrollmentStatus` (in, nin, eq, ne)
            - `status` (in, nin, eq, ne)
            - `vendorNumber` (ct, nct, eq, ne)
            - `name` (ct, nct, eq, ne)
            - `ein` (ct, nct, eq, ne)
            - `phone` (ct, nct, eq, ne)
            - `email` (ct, nct, eq, ne)
            - `address` (ct, nct, eq, ne)
            - `city` (ct, nct, eq, ne)
            - `state` (ct, nct, eq, ne)
            - `country` (ct, nct, eq, ne)
            - `zip` (ct, nct, eq, ne)
            - `mcc` (ct, nct, eq, ne)
            - `locationCode` (ct, nct, eq, ne)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, 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 separated by "|"
            - nin => not inside array separated by "|"

            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: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/vendors/{format}/org/{orgId}:
    get:
      operationId: export_ExportVendorsOrg
      tags:
        - Export
      x-fern-sdk-group-name: export
      x-fern-sdk-method-name: ExportVendorsOrg
      x-fern-request-name: ExportVendorsOrgRequest
      summary: Export vendors for an organization
      description: Export a list of vendors for an organization. Use filters to limit results.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: format
          in: path
          description: Format for the export, either XLSX or CSV.
          required: true
          schema:
            $ref: '#/components/schemas/ExportFormat1'
          example: csv
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
        - name: columnsExport
          in: query
          required: false
          schema:
            type: string
          example: BatchDate:Batch_Date,PaypointName:Legal_name
        - 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
          example: 251
        - name: limitRecord
          in: query
          description: The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.
          required: false
          schema:
            type: integer
            default: 25000
          example: 1000
        - 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>

            See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.

            List of field names accepted:
            - `method` (in, nin, eq, ne)
            - `enrollmentStatus` (in, nin, eq, ne)
            - `status` (in, nin, eq, ne)
            - `vendorNumber` (ct, nct, eq, ne)
            - `name` (ct, nct, eq, ne)
            - `ein` (ct, nct, eq, ne)
            - `phone` (ct, nct, eq, ne)
            - `email` (ct, nct, eq, ne)
            - `address` (ct, nct, eq, ne)
            - `city` (ct, nct, eq, ne)
            - `state` (ct, nct, eq, ne)
            - `country` (ct, nct, eq, ne)
            - `zip` (ct, nct, eq, ne)
            - `mcc` (ct, nct, eq, ne)
            - `locationCode` (ct, nct, eq, ne)
            - `paypointLegal` (ne, eq, ct, nct)
            - `paypointDba` (ne, eq, ct, nct)
            - `orgName` (ne, eq, 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 separated by "|"
            - nin => not inside array separated by "|"

            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: `netAmount(gt)=20` returns all records with a `netAmount` greater than 20.00
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
  /Organization:
    post:
      operationId: organization_AddOrganization
      tags:
        - Organization
      x-fern-sdk-group-name: organization
      x-fern-sdk-method-name: AddOrganization
      x-fern-request-name: AddOrganizationRequest
      summary: Add organization
      description: Creates an organization under a parent organization. This is also referred to as a suborganization.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
          example: 6B29FC40-CA47-1067-B31D-00DD010662DA
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddOrganizationRequest'
            example:
              billingInfo:
                achAccount: '123123123'
                achRouting: '123123123'
                billingAddress: 123 Walnut Street
                billingCity: Johnson City
                billingCountry: US
                billingState: TN
                billingZip: '37615'
              contacts:
                - contactEmail: herman@hermanscoatings.com
                  contactName: Herman Martinez
                  contactPhone: '3055550000'
                  contactTitle: Owner
              hasBilling: true
              hasResidual: true
              orgAddress: 123 Walnut Street
              orgCity: Johnson City
              orgCountry: US
              orgEntryName: pilgrim-planner
              orgId: '123'
              orgLogo:
                fContent: TXkgdGVzdCBmaWxlHJ==...
                filename: my-doc.pdf
                ftype: pdf
                furl: https://mysite.com/my-doc.pdf
              orgName: Pilgrim Planner
              orgParentId: 236
              orgState: TN
              orgTimezone: -5
              orgType: 0
              orgWebsite: www.pilgrimageplanner.com
              orgZip: '37615'
              replyToEmail: email@example.com
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddOrganizationResponse'
              example:
                isSuccess: true
                responseData: 245
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Organization/{orgId}:
    delete:
      operationId: organization_DeleteOrganization
      tags:
        - Organization
      x-fern-sdk-group-name: organization
      x-fern-sdk-method-name: DeleteOrganization
      x-fern-request-name: DeleteOrganizationRequest
      summary: Delete organization
      description: Delete an organization by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteOrganizationResponse'
              example:
                isSuccess: true
                responseData: 245
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: organization_EditOrganization
      tags:
        - Organization
      x-fern-sdk-group-name: organization
      x-fern-sdk-method-name: EditOrganization
      x-fern-request-name: OrganizationData
      summary: Update organization
      description: Updates an organization's details by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationData'
            example:
              contacts:
                - contactEmail: herman@hermanscoatings.com
                  contactName: Herman Martinez
                  contactPhone: '3055550000'
                  contactTitle: Owner
              orgAddress: 123 Walnut Street
              orgCity: Johnson City
              orgCountry: US
              orgEntryName: pilgrim-planner
              orgId: '123'
              orgName: Pilgrim Planner
              orgState: TN
              orgTimezone: -5
              orgType: 0
              orgWebsite: www.pilgrimageplanner.com
              orgZip: '37615'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EditOrganizationResponse'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 2442
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Organization/basic/{entry}:
    get:
      operationId: organization_GetBasicOrganization
      tags:
        - Organization
      x-fern-sdk-group-name: organization
      x-fern-sdk-method-name: GetBasicOrganization
      x-fern-request-name: GetBasicOrganizationRequest
      summary: Get basic organization details by entry name
      description: Gets an organization's basic information by entry name (entrypoint identifier).
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            type: string
          example: 8cfec329267
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationQueryRecord'
              example:
                services:
                  - description: description
                    enabled: true
                    monthlyCost: 1.1
                    name: name
                    reseller: true
                    setupCost: 1.1
                    txCost: 1.1
                    txPercentCost: 1.1
                billingInfo:
                  achAccount: '123123123'
                  achRouting: '123123123'
                  billingAddress: 123 Walnut Street
                  billingCity: Johnson City
                  billingCountry: US
                  billingState: TN
                  billingZip: '37615'
                contacts:
                  - contactEmail: example@email.com
                    contactName: Herman Martinez
                    contactPhone: '3055550000'
                    contactTitle: Owner
                createdAt: '2022-07-01T15:00:01Z'
                hasBilling: true
                hasResidual: true
                idOrg: 123
                isRoot: false
                orgAddress: 123 Walnut Street
                orgCity: Johnson City
                orgCountry: US
                orgEntryName: pilgrim-planner
                orgId: I-123
                orgLogo:
                  fContent: TXkgdGVzdCBmaWxlHJ==...
                  filename: my-doc.pdf
                  ftype: pdf
                  furl: https://mysite.com/my-doc.pdf
                orgName: Pilgrim Planner
                orgParentId: 236
                orgParentName: PropertyManager Pro
                orgState: TN
                orgTimezone: -5
                orgType: 0
                orgWebsite: www.pilgrimageplanner.com
                orgZip: orgZip
                recipientEmailNotification: true
                replyToEmail: example@email.com
                resumable: false
                summary:
                  amountSubs: 1.1
                  amountTx: 1.1
                  childOrgs: 1
                  childPaypoints: 1
                  countSubs: 1
                  countTx: 1
                users:
                  - Access:
                      - roleValue: true
                    AdditionalData: AdditionalData
                    createdAt: '2022-07-01T15:00:01Z'
                    Email: example@email.com
                    language: en
                    lastAccess: '2022-07-01T15:00:01Z'
                    Name: Sean Smith
                    Phone: '5555555555'
                    Scope:
                      - orgType: 0
                    snData: snData
                    snIdentifier: snIdentifier
                    snProvider: google
                    timeZone: -5
                    userId: 1000000
                    UsrMFA: false
                    UsrMFAMode: 0
                    UsrStatus: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Organization/basicById/{orgId}:
    get:
      operationId: organization_GetBasicOrganizationById
      tags:
        - Organization
      x-fern-sdk-group-name: organization
      x-fern-sdk-method-name: GetBasicOrganizationById
      x-fern-request-name: GetBasicOrganizationByIdRequest
      summary: Get basic organization details by ID
      description: Gets an organization's basic details by org ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationQueryRecord'
              example:
                services:
                  - description: description
                    enabled: true
                    monthlyCost: 1.1
                    name: name
                    reseller: true
                    setupCost: 1.1
                    txCost: 1.1
                    txPercentCost: 1.1
                billingInfo:
                  achAccount: '123123123'
                  achRouting: '123123123'
                  billingAddress: 123 Walnut Street
                  billingCity: Johnson City
                  billingCountry: US
                  billingState: TN
                  billingZip: '37615'
                contacts:
                  - contactEmail: example@email.com
                    contactName: Herman Martinez
                    contactPhone: '3055550000'
                    contactTitle: Owner
                createdAt: '2022-07-01T15:00:01Z'
                hasBilling: true
                hasResidual: true
                idOrg: 123
                isRoot: false
                orgAddress: 123 Walnut Street
                orgCity: Johnson City
                orgCountry: US
                orgEntryName: pilgrim-planner
                orgId: I-123
                orgLogo:
                  fContent: TXkgdGVzdCBmaWxlHJ==...
                  filename: my-doc.pdf
                  ftype: pdf
                  furl: https://mysite.com/my-doc.pdf
                orgName: Pilgrim Planner
                orgParentId: 236
                orgParentName: PropertyManager Pro
                orgState: TN
                orgTimezone: -5
                orgType: 0
                orgWebsite: www.pilgrimageplanner.com
                orgZip: orgZip
                recipientEmailNotification: true
                replyToEmail: example@email.com
                resumable: false
                summary:
                  amountSubs: 1.1
                  amountTx: 1.1
                  childOrgs: 1
                  childPaypoints: 1
                  countSubs: 1
                  countTx: 1
                users:
                  - Access:
                      - roleValue: true
                    AdditionalData: AdditionalData
                    createdAt: '2022-07-01T15:00:01Z'
                    Email: example@email.com
                    language: en
                    lastAccess: '2022-07-01T15:00:01Z'
                    Name: Sean Smith
                    Phone: '5555555555'
                    Scope:
                      - orgType: 0
                    snData: snData
                    snIdentifier: snIdentifier
                    snProvider: google
                    timeZone: -5
                    userId: 1000000
                    UsrMFA: false
                    UsrMFAMode: 0
                    UsrStatus: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Organization/read/{orgId}:
    get:
      operationId: organization_GetOrganization
      tags:
        - Organization
      x-fern-sdk-group-name: organization
      x-fern-sdk-method-name: GetOrganization
      x-fern-request-name: GetOrganizationRequest
      summary: Get organization
      description: Retrieves details for an organization by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationQueryRecord'
              example:
                services:
                  - description: description
                    enabled: true
                    monthlyCost: 1.1
                    name: name
                    reseller: true
                    setupCost: 1.1
                    txCost: 1.1
                    txPercentCost: 1.1
                billingInfo:
                  achAccount: '123123123'
                  achRouting: '123123123'
                  billingAddress: 123 Walnut Street
                  billingCity: Johnson City
                  billingCountry: US
                  billingState: TN
                  billingZip: '37615'
                contacts:
                  - contactEmail: example@email.com
                    contactName: Herman Martinez
                    contactPhone: '3055550000'
                    contactTitle: Owner
                createdAt: '2022-07-01T15:00:01Z'
                hasBilling: true
                hasResidual: true
                idOrg: 123
                isRoot: false
                orgAddress: 123 Walnut Street
                orgCity: Johnson City
                orgCountry: US
                orgEntryName: pilgrim-planner
                orgId: I-123
                orgLogo:
                  fContent: TXkgdGVzdCBmaWxlHJ==...
                  filename: my-doc.pdf
                  ftype: pdf
                  furl: https://mysite.com/my-doc.pdf
                orgName: Pilgrim Planner
                orgParentId: 236
                orgParentName: PropertyManager Pro
                orgState: TN
                orgTimezone: -5
                orgType: 0
                orgWebsite: www.pilgrimageplanner.com
                orgZip: orgZip
                recipientEmailNotification: true
                replyToEmail: example@email.com
                resumable: false
                summary:
                  amountSubs: 1.1
                  amountTx: 1.1
                  childOrgs: 1
                  childPaypoints: 1
                  countSubs: 1
                  countTx: 1
                users:
                  - Access:
                      - roleValue: true
                    AdditionalData: AdditionalData
                    createdAt: '2022-07-01T15:00:01Z'
                    Email: example@email.com
                    language: en
                    lastAccess: '2022-07-01T15:00:01Z'
                    Name: Sean Smith
                    Phone: '5555555555'
                    Scope:
                      - orgType: 0
                    snData: snData
                    snIdentifier: snIdentifier
                    snProvider: google
                    timeZone: -5
                    userId: 1000000
                    UsrMFA: false
                    UsrMFAMode: 0
                    UsrStatus: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Organization/settings/{orgId}:
    get:
      operationId: organization_GetSettingsOrganization
      tags:
        - Organization
      x-fern-sdk-group-name: organization
      x-fern-sdk-method-name: GetSettingsOrganization
      x-fern-request-name: GetSettingsOrganizationRequest
      summary: Get organization settings
      description: Retrieves an organization's settings.
      security:
        - APIKeyAuth: []
      parameters:
        - name: orgId
          in: path
          description: The numeric identifier for organization, assigned by Payabli.
          required: true
          schema:
            type: integer
          example: 123
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettingsQueryRecord'
              example:
                customFields:
                  - key: key
                    readOnly: false
                    value: value
                forInvoices:
                  - key: key
                    readOnly: false
                    value: value
                forPayOuts:
                  - key: key
                    readOnly: false
                    value: value
                forWallets:
                  - key: isGooglePayEnabled
                    readOnly: false
                    value: 'true'
                general:
                  - key: key
                    readOnly: false
                    value: value
                identifiers:
                  - key: key
                    readOnly: false
                    value: value
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Management/verifyAccountDetails/{entry}:
    post:
      operationId: management_VerifyAccountDetails
      tags:
        - Management
      x-fern-sdk-group-name: management
      x-fern-sdk-method-name: VerifyAccountDetails
      x-fern-request-name: VerifyAccountDetailsRequest
      summary: Verify bank account details
      description: |-
        Verifies a bank account and returns detailed verification results from the verification network, including bank name, account status, and response codes. Unlike a pass/fail verification, this endpoint returns granular data to support decision-making and troubleshooting.

        When bank authentication is enabled for the paypoint's organization, the endpoint performs an identity verification check on the account holder. Otherwise, it performs an account existence check. When bank authentication is enabled, the `accountHolderType` and `holderName` fields are required.

        Requires `inboundpayments_create` or `outboundpayments_create` permission.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: The paypoint's entry name identifier.
          required: true
          schema:
            type: string
          example: entry752
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyAccountDetailsRequest'
            example:
              routingNumber: '122105278'
              accountNumber: '0000000016'
              accountType: Checking
              country: US
              accountHolderType: personal
              holderName: Jane Doe
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyAccountDetailsResponse'
              example:
                isSuccess: true
                responseText: Success
                responseData:
                  aba: '122105278'
                  accountNumber: '0000000016'
                  isValid: true
                  errorMessage: null
                  verificationResponse: Pass
                  responseCode: '2'
                  responseValue: CA11
                  responseDescription: Customer authentication passed gAuthenticate.
                  bankName: null
                  reportedAccountType: null
                  accountAddedDate: null
                  accountLastUpdatedDate: null
                  accountClosedDate: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Statistic/basic/{mode}/{freq}/{level}/{entryId}:
    get:
      operationId: statistic_BasicStats
      tags:
        - Statistic
      x-fern-sdk-group-name: statistic
      x-fern-sdk-method-name: BasicStats
      x-fern-request-name: BasicStatsRequest
      summary: Get Basic statistics for a paypoint or organization
      description: Retrieves the basic statistics for an organization or a paypoint, for a given time period, grouped by a particular frequency.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entryId
          in: path
          description: Identifier in Payabli for the entity.
          required: true
          schema:
            type: integer
            format: int64
          example: 1000000
        - name: freq
          in: path
          description: |-
            Frequency to group series. Allowed values:

            - `m` - monthly
            - `w` - weekly
            - `d` - daily
            - `h` - hourly

            For example, `w` groups the results by week.
          required: true
          schema:
            type: string
          example: m
        - name: level
          in: path
          description: |-
            The entry level for the request:
              - 0 for Organization
              - 2 for Paypoint
          required: true
          schema:
            type: integer
          example: 2
        - name: mode
          in: path
          description: |-
            Mode for the request. Allowed values:

            - `custom` - Allows you to set a custom date range
            - `ytd` - Year To Date
            - `mtd` - Month To Date
            - `wtd` - Week To Date
            - `today` - All current day
            - `m12` - Last 12 months
            - `d30` - Last 30 days
            - `h24` - Last 24 hours
            - `lasty` - Last Year
            - `lastm` - Last Month
            - `lastw` - Last Week
            - `yesterday` - Last Day
          required: true
          schema:
            type: string
          example: custom
        - name: endDate
          in: query
          description: |-
            Used with `custom` mode. The end date for the range.
            Valid formats:
              - YYYY-mm-dd
              - YYYY/mm/dd
              - mm-dd-YYYY
              - mm/dd/YYYY
          required: false
          schema:
            type: string
          example: '2025-11-30'
        - name: parameters
          in: query
          description: List of parameters.
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - name: startDate
          in: query
          description: |-
            Used with `custom` mode. The start date for the range.
            Valid formats:
               - YYYY-mm-dd
               - YYYY/mm/dd
               -  mm-dd-YYYY
               - mm/dd/YYYY
          required: false
          schema:
            type: string
          example: '2025-11-01'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StatBasicExtendedQueryRecord'
              example:
                - outCustomers: 18196
                  outNewCustomers: 1089
                  outTransactions: 3319
                  outSubscriptionsPaid: 0
                  outCardTransactions: 0
                  outVCardTransactions: 0
                  outACHTransactions: 0
                  outCheckTransactions: 0
                  outPendingMethodTransactions: 22
                  outTransactionsVolume: 13111741.78
                  outSubscriptionsPaidVolume: 0
                  outCardVolume: 0
                  outVCardVolume: 0
                  outACHVolume: 0
                  outCheckVolume: 0
                  outPendingMethodVolume: 82
                  statX: 2025-11
                  inTransactions: 168204
                  inSubscriptionsPaid: 311
                  inCustomers: 2561522
                  inNewCustomers: 44846
                  inCardTransactions: 115059
                  inACHTransactions: 53153
                  inCheckTransactions: 0
                  inCashTransactions: 15
                  inWalletTransactions: 0
                  inCardChargeBacks: 17
                  inACHReturns: 0
                  inTransactionsVolume: 104795896.94
                  inSubscriptionsPaidVolume: 81569.32
                  inCardVolume: 41085285.13
                  inACHVolume: 63706101.81
                  inCheckVolume: 0
                  inCashVolume: 4510
                  inWalletVolume: 0
                  inCardChargeBackVolume: 15455.75
                  inACHReturnsVolume: 0
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Statistic/customerbasic/{mode}/{freq}/{customerId}:
    get:
      operationId: statistic_CustomerBasicStats
      tags:
        - Statistic
      x-fern-sdk-group-name: statistic
      x-fern-sdk-method-name: CustomerBasicStats
      x-fern-request-name: CustomerBasicStatsRequest
      summary: Get basic statistics for a customer
      description: Retrieves the basic statistics for a customer for a specific time period, grouped by a selected frequency.
      security:
        - APIKeyAuth: []
      parameters:
        - name: customerId
          in: path
          description: Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.
          required: true
          schema:
            type: integer
          example: 998
        - name: freq
          in: path
          description: |-
            Frequency to group series. Allowed values:

            - `m` - monthly
            - `w` - weekly
            - `d` - daily
            - `h` - hourly

            For example, `w` groups the results by week.
          required: true
          schema:
            type: string
          example: m
        - name: mode
          in: path
          description: |-
            Mode for request. Allowed values:

            - `ytd` - Year To Date
            - `mtd` - Month To Date
            - `wtd` - Week To Date
            - `today` - All current day
            - `m12` - Last 12 months
            - `d30` - Last 30 days
            - `h24` - Last 24 hours
            - `lasty` - Last Year
            - `lastm` - Last Month
            - `lastw` - Last Week
            - `yesterday` - Last Day
          required: true
          schema:
            type: string
          example: ytd
        - name: parameters
          in: query
          description: List of parameters.
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SubscriptionStatsQueryRecord'
              example:
                - interval: 2023-03
                  count: 45
                  volume: 12500.75
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Statistic/subscriptions/{interval}/{level}/{entryId}:
    get:
      operationId: statistic_SubStats
      tags:
        - Statistic
      x-fern-sdk-group-name: statistic
      x-fern-sdk-method-name: SubStats
      x-fern-request-name: SubStatsRequest
      summary: Get subscription statistics for a paypoint or organization
      description: Retrieves the subscription statistics for a given interval for a paypoint or organization.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entryId
          in: path
          description: Identifier in Payabli for the entity.
          required: true
          schema:
            type: integer
            format: int64
          example: 1000000
        - name: interval
          in: path
          description: |-
            Interval to get the data. Allowed values:

            - `all` - all intervals
            - `30` - 1-30 days
            - `60` - 31-60 days
            - `90` - 61-90 days
            - `plus` - +90 days
          required: true
          schema:
            type: string
          example: '30'
        - name: level
          in: path
          description: |-
            The entry level for the request:
              - 0 for Organization
              - 2 for Paypoint
          required: true
          schema:
            type: integer
          example: 2
        - name: parameters
          in: query
          description: List of parameters
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StatBasicQueryRecord'
              example:
                - statX: 2023-03
                  inTransactions: 150
                  inTransactionsVolume: 25000.5
                  inWalletTransactions: 10
                  inWalletVolume: 1000.5
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Statistic/vendorbasic/{mode}/{freq}/{idVendor}:
    get:
      operationId: statistic_VendorBasicStats
      tags:
        - Statistic
      x-fern-sdk-group-name: statistic
      x-fern-sdk-method-name: VendorBasicStats
      x-fern-request-name: VendorBasicStatsRequest
      summary: Get basic statistics for a vendor
      description: Retrieve the basic statistics about a vendor for a given time period, grouped by frequency.
      security:
        - APIKeyAuth: []
      parameters:
        - name: freq
          in: path
          description: |-
            Frequency to group series. Allowed values:

            - `m` - monthly
            - `w` - weekly
            - `d` - daily
            - `h` - hourly

            For example, `w` groups the results by week.
          required: true
          schema:
            type: string
          example: m
        - name: idVendor
          in: path
          description: Vendor ID.
          required: true
          schema:
            type: integer
          example: 1
        - name: mode
          in: path
          description: |-
            Mode for request. Allowed values:

            - `ytd` - Year To Date
            - `mtd` - Month To Date
            - `wtd` - Week To Date
            - `today` - All current day
            - `m12` - Last 12 months
            - `d30` - Last 30 days
            - `h24` - Last 24 hours
            - `lasty` - Last Year
            - `lastm` - Last Month
            - `lastw` - Last Week
            - `yesterday` - Last Day
          required: true
          schema:
            type: string
          example: ytd
        - name: parameters
          in: query
          description: List of parameters
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StatisticsVendorQueryRecord'
              example:
                - statX: 2023-03
                  active: 25
                  activeVolume: 5000.25
                  sentToApproval: 10
                  sentToApprovalVolume: 2500.75
                  toApproval: 8
                  toApprovalVolume: 1800.5
                  approved: 20
                  approvedVolume: 4200
                  disapproved: 3
                  disapprovedVolume: 600.25
                  cancelled: 2
                  cancelledVolume: 400
                  inTransit: 5
                  inTransitVolume: 1250.75
                  paid: 18
                  paidVolume: 3800.5
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Notification:
    post:
      operationId: notification_AddNotification
      tags:
        - Notification
      x-fern-sdk-group-name: notification
      x-fern-sdk-method-name: AddNotification
      x-fern-request-name: AddNotificationRequest
      summary: Add notification
      description: Create a new notification or auto-generated report.
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddNotificationRequest'
            examples:
              Webhook:
                value:
                  content:
                    eventType: CreatedApplication
                  frequency: untilcancelled
                  method: web
                  ownerId: 236
                  ownerType: 0
                  status: 1
                  target: https://webhook.site/2871b8f8-edc7-441a-b376-98d8c8e33275
              ApprovedPayment:
                value:
                  content:
                    eventType: ApprovedPayment
                  frequency: untilcancelled
                  method: web
                  ownerId: 236
                  ownerType: 0
                  status: 1
                  target: https://cfe9dc390ce2.ngrok-free.app/webhook
              ReportExample:
                value:
                  content:
                    eventType: Report
                    fileFormat: json
                    reportName: Transaction
                    timeZone: -5
                    transactionId: '0'
                  frequency: biweekly
                  method: report-email
                  ownerId: 236
                  ownerType: 0
                  status: 1
                  target: admin@example.com
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseNotifications'
              examples:
                Webhook:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseData: 1717
                    responseText: Success
                ApprovedPayment:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseData: 1717
                    responseText: Success
                ReportExample:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseData: 1717
                    responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Notification/{nId}:
    delete:
      operationId: notification_DeleteNotification
      tags:
        - Notification
      x-fern-sdk-group-name: notification
      x-fern-sdk-method-name: DeleteNotification
      x-fern-request-name: DeleteNotificationRequest
      summary: Delete notification
      description: Deletes a single notification or auto-generated report.
      security:
        - APIKeyAuth: []
      parameters:
        - name: nId
          in: path
          description: Notification ID.
          required: true
          schema:
            type: string
          example: '1717'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseNotifications'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 1717
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    get:
      operationId: notification_GetNotification
      tags:
        - Notification
      x-fern-sdk-group-name: notification
      x-fern-sdk-method-name: GetNotification
      x-fern-request-name: GetNotificationRequest
      summary: Get notification
      description: Retrieves a single notification or auto-generated report's details.
      security:
        - APIKeyAuth: []
      parameters:
        - name: nId
          in: path
          description: Notification ID.
          required: true
          schema:
            type: string
          example: '1717'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationQueryRecord'
              example:
                content:
                  fileFormat: csv
                  reportName: Returned
                createdAt: '2024-02-21T09:16:31Z'
                frequency: weekly
                lastUpdated: '2024-02-21T09:16:31Z'
                method: report-email
                notificationId: 1717
                ownerId: 123
                ownerName: The Pilgrim Planner
                ownerType: 0
                status: 1
                target: admin@business.com
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: notification_UpdateNotification
      tags:
        - Notification
      x-fern-sdk-group-name: notification
      x-fern-sdk-method-name: UpdateNotification
      summary: Update notification
      description: Update a notification or auto-generated report.
      security:
        - APIKeyAuth: []
      parameters:
        - name: nId
          in: path
          description: Notification ID.
          required: true
          schema:
            type: string
          example: '1717'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNotificationRequest'
            example:
              content:
                eventType: ApprovedPayment
              frequency: untilcancelled
              method: email
              ownerId: 136
              ownerType: 0
              status: 1
              target: newemail@email.com
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseNotifications'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 1717
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Export/notificationReport/{Id}:
    get:
      operationId: notification_GetReportFile
      tags:
        - Notification
      x-fern-sdk-group-name: notification
      x-fern-sdk-method-name: GetReportFile
      x-fern-request-name: GetReportFileRequest
      summary: Export generated report by ID
      description: Gets a copy of a generated report by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: Id
          in: path
          description: Report ID
          required: true
          schema:
            type: integer
            format: int64
          example: 1000000
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
              example:
                key: value
  /User:
    post:
      operationId: user_AddUser
      tags:
        - User
      x-fern-sdk-group-name: user
      x-fern-sdk-method-name: AddUser
      x-fern-request-name: AddUserRequest
      summary: Add User to an Organization
      description: Use this endpoint to add a new user to an organization.
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserData'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddUserResponse'
              example:
                isSuccess: true
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /User/{userId}:
    delete:
      operationId: user_DeleteUser
      tags:
        - User
      x-fern-sdk-group-name: user
      x-fern-sdk-method-name: DeleteUser
      x-fern-request-name: DeleteUserRequest
      summary: Delete User in an Organization
      description: Use this endpoint to delete a specific user within an organization.
      security:
        - APIKeyAuth: []
      parameters:
        - name: userId
          in: path
          description: The Payabli-generated `userId` value.
          required: true
          schema:
            type: integer
            format: int64
          example: 1000000
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteUserResponse'
              example:
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: user_EditUser
      tags:
        - User
      x-fern-sdk-group-name: user
      x-fern-sdk-method-name: EditUser
      x-fern-request-name: EditUserRequest
      summary: Modify User in an Organization
      description: Use this endpoint to modify the details of a specific user within an organization.
      security:
        - APIKeyAuth: []
      parameters:
        - name: userId
          in: path
          description: User Identifier
          required: true
          schema:
            type: integer
            format: int64
          example: 1000000
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserData'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse'
              example:
                isSuccess: true
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    get:
      operationId: user_GetUser
      tags:
        - User
      x-fern-sdk-group-name: user
      x-fern-sdk-method-name: GetUser
      x-fern-request-name: GetUserRequest
      summary: Get User in an Organization
      description: Use this endpoint to retrieve information about a specific user within an organization.
      security:
        - APIKeyAuth: []
      parameters:
        - name: userId
          in: path
          description: The Payabli-generated `userId` value.
          required: true
          schema:
            type: integer
            format: int64
          example: 1000000
        - name: entry
          in: query
          description: The entrypoint identifier.
          required: false
          schema:
            type: string
          example: 478ae1234
        - name: level
          in: query
          description: 'Entry level: 0 - partner, 2 - paypoint'
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserQueryRecord'
              example:
                Access:
                  - roleLabel: customers
                    roleValue: true
                AdditionalData: AdditionalData
                createdAt: '2022-07-01T15:00:01Z'
                Email: example@email.com
                language: en
                lastAccess: '2022-07-01T15:00:01Z'
                Name: Sean Smith
                Phone: '5555555555'
                Scope:
                  - orgEntry: pilgrim-planner
                    orgId: 123
                    orgType: 0
                snData: snData
                snIdentifier: snIdentifier
                snProvider: google
                timeZone: -5
                userId: 1000000
                UsrMFA: false
                UsrMFAMode: 0
                UsrStatus: 1
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /User/auth/{provider}:
    post:
      operationId: user_AuthUser
      tags:
        - User
      x-fern-sdk-group-name: user
      x-fern-sdk-method-name: AuthUser
      x-fern-request-name: UserAuthRequest
      summary: Authenticate User
      description: This endpoint requires an application API token.
      security:
        - APIKeyAuth: []
      parameters:
        - name: provider
          in: path
          description: Auth provider. Pass `null` to use the built-in provider.
          required: true
          schema:
            type: string
          example: provider
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAuthRequest'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseMfaBasic'
              example:
                isSuccess: true
                mfa: false
                mfaMode: email
                mfaValidationCode: 50-2E-4A-16-93-0E-41-41-07-EE-22-B6-00-99-00-99
                responseData: g**.com
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /User/authrefresh:
    post:
      operationId: user_AuthRefreshUser
      tags:
        - User
      x-fern-sdk-group-name: user
      x-fern-sdk-method-name: AuthRefreshUser
      x-fern-request-name: AuthRefreshUserRequest
      summary: Refresh token for User
      description: Use this endpoint to refresh the authentication token for a user within an organization.
      security:
        - APIKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseUserMfa'
              example:
                inactiveTokenTime: 31
                isSuccess: true
                remaining: 120
                responseData: u.fPLVSzFv1gZpHl......
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /User/authreset:
    post:
      operationId: user_AuthResetUser
      tags:
        - User
      x-fern-sdk-group-name: user
      x-fern-sdk-method-name: AuthResetUser
      x-fern-request-name: UserAuthResetRequest
      summary: Reset password for User
      description: Use this endpoint to initiate a password reset for a user within an organization.
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAuthResetRequest'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResetUserResponse'
              example:
                isSuccess: true
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /User/authpsw:
    put:
      operationId: user_ChangePswUser
      tags:
        - User
      x-fern-sdk-group-name: user
      x-fern-sdk-method-name: ChangePswUser
      x-fern-request-name: UserAuthPswResetRequest
      summary: Update password for User
      description: Use this endpoint to change the password for a user within an organization.
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAuthPswResetRequest'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangePswUserResponse'
              example:
                isSuccess: true
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /User/authlogout:
    get:
      operationId: user_LogoutUser
      tags:
        - User
      x-fern-sdk-group-name: user
      x-fern-sdk-method-name: LogoutUser
      x-fern-request-name: LogoutUserRequest
      summary: Logout User
      description: Use this endpoint to log a user out from the system.
      security:
        - APIKeyAuth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogoutUserResponse'
              example:
                isSuccess: true
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /User/mfa:
    post:
      operationId: user_ValidateMfaUser
      tags:
        - User
      x-fern-sdk-group-name: user
      x-fern-sdk-method-name: ValidateMfaUser
      x-fern-request-name: MfaValidationData
      summary: Validate MFA for User in an Organization
      description: Use this endpoint to validate the multi-factor authentication (MFA) code for a user within an organization.
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MfaValidationData'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseUserMfa'
              example:
                inactiveTokenTime: 31
                isSuccess: true
                remaining: 120
                responseData: u.fPLVSzFv1gZpHl......
                responseText: Success
  /User/mfa/{userId}:
    put:
      operationId: user_EditMfaUser
      tags:
        - User
      x-fern-sdk-group-name: user
      x-fern-sdk-method-name: EditMfaUser
      x-fern-request-name: EditMfaUserRequest
      summary: Enable/disable MFA for user in an organization
      description: Use this endpoint to enable or disable multi-factor authentication (MFA) for a user within an organization.
      security:
        - APIKeyAuth: []
      parameters:
        - name: userId
          in: path
          description: User Identifier
          required: true
          schema:
            type: integer
            format: int64
          example: 1000000
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MfaData'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EditMfaUserResponse'
              example:
                isSuccess: true
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /User/resendmfa/{usrname}/{Entry}/{EntryType}:
    post:
      operationId: user_ResendMFACode
      tags:
        - User
      x-fern-sdk-group-name: user
      x-fern-sdk-method-name: ResendMFACode
      x-fern-request-name: ResendMFACodeRequest
      summary: Resend MFA code
      description: Resends the MFA code to the user via the selected MFA mode (email or SMS).
      security:
        - APIKeyAuth: []
      parameters:
        - name: Entry
          in: path
          description: ''
          required: true
          schema:
            type: string
          example: Entry
        - name: EntryType
          in: path
          description: ''
          required: true
          schema:
            type: integer
          example: 1
        - name: usrname
          in: path
          description: ''
          required: true
          schema:
            type: string
          example: usrname
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseMfaBasic'
              example:
                isSuccess: true
                mfa: false
                mfaMode: email
                mfaValidationCode: 50-2E-4A-16-93-0E-41-41-07-EE-22-B6-00-99-00-99
                responseData: g**.com
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Vendor/single/{entry}:
    post:
      operationId: vendor_AddVendor
      tags:
        - Vendor
      x-fern-sdk-group-name: vendor
      x-fern-sdk-method-name: AddVendor
      x-fern-request-name: AddVendorRequest
      summary: Create vendor
      description: Creates a vendor in an entrypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: Entrypoint identifier.
          required: true
          schema:
            type: string
          example: 8cfec329267
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VendorData'
            example:
              vendorNumber: '1234'
              name1: Herman's Coatings and Masonry
              name2: <string>
              ein: 12-3456789
              phone: '5555555555'
              email: example@email.com
              address1: 123 Ocean Drive
              address2: Suite 400
              city: Miami
              state: FL
              zip: '33139'
              country: US
              mcc: '7777'
              locationCode: MIA123
              contacts:
                - contactName: Herman Martinez
                  contactEmail: example@email.com
                  contactTitle: Owner
                  contactPhone: '3055550000'
              billingData:
                id: 123
                bankName: Country Bank
                routingAccount: '123123123'
                accountNumber: '123123123'
                typeAccount: Checking
                bankAccountHolderName: Gruzya Adventure Outfitters LLC
                bankAccountHolderType: Business
                bankAccountFunction: 0
              paymentMethod: managed
              vendorStatus: 1
              remitAddress1: 123 Walnut Street
              remitAddress2: Suite 900
              remitCity: Miami
              remitState: FL
              remitZip: '31113'
              remitCountry: US
              payeeName1: <string>
              payeeName2: <string>
              customerVendorAccount: A-37622
              internalReferenceId: 123
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseVendors'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 3890
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Vendor/{idVendor}:
    delete:
      operationId: vendor_DeleteVendor
      tags:
        - Vendor
      x-fern-sdk-group-name: vendor
      x-fern-sdk-method-name: DeleteVendor
      x-fern-request-name: DeleteVendorRequest
      summary: Delete vendor
      description: Delete a vendor.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idVendor
          in: path
          description: Vendor ID.
          required: true
          schema:
            type: integer
          example: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseVendors'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 3890
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: vendor_EditVendor
      tags:
        - Vendor
      x-fern-sdk-group-name: vendor
      x-fern-sdk-method-name: EditVendor
      x-fern-request-name: EditVendorRequest
      summary: Update vendor
      description: Updates a vendor's information. Send only the fields you need to update.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idVendor
          in: path
          description: Vendor ID.
          required: true
          schema:
            type: integer
          example: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VendorData'
            example:
              name1: Theodore's Janitorial
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponseVendors'
              example:
                isSuccess: true
                responseCode: 1
                responseData: 3890
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    get:
      operationId: vendor_GetVendor
      tags:
        - Vendor
      x-fern-sdk-group-name: vendor
      x-fern-sdk-method-name: GetVendor
      x-fern-request-name: GetVendorRequest
      summary: Get vendor
      description: Retrieves a vendor's details, including enrichment status and payment acceptance info when available.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idVendor
          in: path
          description: Vendor ID.
          required: true
          schema:
            type: integer
          example: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VendorQueryRecord'
              example:
                VendorNumber: '1234'
                Name1: Herman's Coatings
                Name2: Herman's Coating Supply Company, LLC
                EIN: '123456789'
                Phone: '2125551234'
                Email: example@email.com
                RemitEmail: null
                Address1: 123 Ocean Drive
                Address2: Suite 400
                City: Bristol
                State: GA
                Zip: '31113'
                Country: US
                Mcc: '7777'
                LocationCode: LOC123
                Contacts:
                  ContactEmail: eric@martinezcoatings.com
                  ContactName: Eric Martinez
                  ContactPhone: '5555555555'
                  ContactTitle: Owner
                BillingData:
                  id: 123456
                  accountId: bank-account-001
                  nickname: Main Checking Account
                  bankName: Example Bank
                  routingAccount: '123456789'
                  accountNumber: '9876543210'
                  typeAccount: Checking
                  bankAccountHolderName: John Doe
                  bankAccountHolderType: Business
                  bankAccountFunction: 2
                  verified: true
                  status: 1
                  services: []
                  default: true
                PaymentMethod: null
                VendorStatus: 1
                VendorId: 1
                EnrollmentStatus: null
                Summary:
                  ActiveBills: 2
                  PendingBills: 4
                  InTransitBills: 3
                  PaidBills: 18
                  OverdueBills: 1
                  ApprovedBills: 5
                  DisapprovedBills: 1
                  TotalBills: 34
                  ActiveBillsAmount: 1250.75
                  PendingBillsAmount: 2890.5
                  InTransitBillsAmount: 1675.25
                  PaidBillsAmount: 15420.8
                  OverdueBillsAmount: 425
                  ApprovedBillsAmount: 3240.9
                  DisapprovedBillsAmount: 180
                  TotalBillsAmount: 25083.2
                PaypointLegalname: Sunshine Services, LLC
                PaypointDbaname: Sunshine Gutters
                PaypointEntryname: d193cf9a46
                ParentOrgName: PropertyManager Pro
                ParentOrgId: 1000
                CreatedDate: '2022-07-01T15:00:01Z'
                LastUpdated: '2022-07-01T15:00:01Z'
                remitAddress1: 123 Walnut Street
                remitAddress2: Suite 900
                remitCity: Miami
                remitState: FL
                remitZip: '31113'
                remitCountry: US
                payeeName1: payeeName1
                payeeName2: payeeName2
                customField1: ''
                customField2: ''
                customerVendorAccount: 123-456
                InternalReferenceId: 1000000
                PaymentPortalUrl: https://greenfield-landscaping.com/pay
                CardAccepted: 'yes'
                AchAccepted: unable to determine
                EnrichmentStatus: fully_enriched
                EnrichedBy: web_search
                EnrichedAt: '2026-03-05T14:22:10Z'
                EnrichmentId: enrich-3890-a1b2c3d4
                additionalData: null
                externalPaypointID: Paypoint-100
                StoredMethods: []
  /Vendor/enrich/{entry}:
    post:
      operationId: vendor_EnrichVendor
      tags:
        - Vendor
      x-fern-sdk-group-name: vendor
      x-fern-sdk-method-name: EnrichVendor
      x-fern-request-name: VendorEnrichRequest
      summary: Enrich vendor
      description: Triggers AI-powered vendor enrichment for an existing vendor. Runs one or more enrichment stages (invoice scan, web search) based on the `scope` parameter. Can automatically apply extracted payment acceptance info and vendor contact information to the vendor record, or return raw results for manual review. Contact Payabli to enable this feature.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          description: Entrypoint identifier.
          required: true
          schema:
            type: string
          examples:
            InvoiceScanReviewMode:
              value: 8cfec329267
            WebSearchReviewMode:
              value: 8cfec329267
            WebSearchAutoApply:
              value: 8cfec329267
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VendorEnrichRequest'
            examples:
              InvoiceScanReviewMode:
                value:
                  vendorId: 3890
                  scope:
                    - invoice_scan
                  applyEnrichmentData: false
                  fallbackMethod: check
                  invoiceFile:
                    ftype: pdf
                    filename: invoice-2026-001.pdf
                    fContent: <base64-encoded-pdf>
              WebSearchReviewMode:
                value:
                  vendorId: 3891
                  scope:
                    - web_search
                  applyEnrichmentData: false
                  fallbackMethod: check
              WebSearchAutoApply:
                value:
                  vendorId: 3891
                  scope:
                    - web_search
                  applyEnrichmentData: true
                  fallbackMethod: check
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VendorEnrichResponse'
              examples:
                InvoiceScanReviewMode:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseText: Success
                    responseData:
                      enrichmentId: enrich-3890-a1b2c3d4
                      status: insufficient
                      stagesTriggered:
                        - invoice_scan
                      vendorPayoutReady: false
                      enrichmentData:
                        invoiceScan:
                          vendorName: Greenfield Landscaping
                          street: 456 Commerce Blvd
                          city: Indianapolis
                          state: IN
                          zipCode: '46201'
                          country: US
                          phone: '5555550100'
                          email: null
                          paymentLink: null
                          cardAccepted: unable to determine
                          achAccepted: unable to determine
                          checkAccepted: 'yes'
                          invoiceNumber: INV-70683
                          amountDue: 390.5
                          dueDate: '2026-01-31'
                        webSearch: null
                WebSearchReviewMode:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseText: Success
                    responseData:
                      enrichmentId: enrich-3891-e5f6a7b8
                      status: completed
                      stagesTriggered:
                        - web_search
                      vendorPayoutReady: true
                      enrichmentData:
                        invoiceScan: null
                        webSearch:
                          phone: '5555550200'
                          phoneType: main
                          email: ap@greenfield-landscaping.com
                          emailType: billing
                          street: 456 Commerce Blvd
                          city: Indianapolis
                          state: IN
                          zipCode: '46201'
                          country: US
                          addressType: business
                          paymentLink: https://greenfield-landscaping.com/pay
                          paymentLinkType: payment_portal
                          cardAccepted: 'yes'
                          achAccepted: unable to determine
                          checkAccepted: 'yes'
                WebSearchAutoApply:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseText: Success
                    responseData:
                      enrichmentId: enrich-3891-c9d0e1f2
                      status: completed
                      stagesTriggered:
                        - web_search
                      vendorPayoutReady: true
                      enrichmentData:
                        invoiceScan: null
                        webSearch:
                          phone: '5555550200'
                          phoneType: main
                          email: ap@greenfield-landscaping.com
                          emailType: billing
                          street: 456 Commerce Blvd
                          city: Indianapolis
                          state: IN
                          zipCode: '46201'
                          country: US
                          addressType: business
                          paymentLink: https://greenfield-landscaping.com/pay
                          paymentLinkType: payment_portal
                          cardAccepted: 'yes'
                          achAccepted: unable to determine
                          checkAccepted: 'yes'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyOutCard/GhostCard/{entry}:
    post:
      operationId: ghostCard_CreateGhostCard
      tags:
        - GhostCard
      x-fern-sdk-group-name: ghostCard
      x-fern-sdk-method-name: CreateGhostCard
      x-fern-request-name: CreateGhostCardRequestBody
      summary: Create ghost card
      description: |-
        Creates a ghost card, a multi-use virtual debit card issued to a vendor for recurring or discretionary spend.

        Unlike single-use virtual cards issued as part of a payout transaction, ghost cards aren't tied to a specific payout. They're issued directly to a vendor and can be reused up to a configurable number of times within the card's spending limits.

        Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the existing card first.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec2e0fa
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGhostCardRequestBody'
            example:
              vendorId: 42
              expenseLimit: 500
              amount: 500
              maxNumberOfUses: 3
              exactAmount: false
              expenseLimitPeriod: monthly
              billingCycle: monthly
              billingCycleDay: '1'
              dailyTransactionCount: 5
              dailyAmountLimit: 200
              transactionAmountLimit: 100
              mcc: '5411'
              tcc: R
              misc1: PO-98765
              misc2: Dept-Finance
      responses:
        '200':
          description: Success response with ghost card details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGhostCardResponse'
              example:
                isSuccess: true
                responseText: Success
                responseData:
                  ReferenceId: gc_abc123def456
                  ResultCode: 1
                  ResultText: Ghost Card created
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyOutCard/card/{entry}:
    patch:
      operationId: ghostCard_UpdateCard
      tags:
        - GhostCard
      x-fern-sdk-group-name: ghostCard
      x-fern-sdk-method-name: UpdateCard
      x-fern-request-name: UpdateCardRequestBody
      summary: Update card status
      description: Updates the status of a virtual card (including ghost cards) under a paypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: entry
          in: path
          required: true
          description: The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          schema:
            $ref: '#/components/schemas/Entry'
          example: 8cfec2e0fa
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCardRequestBody'
            example:
              cardToken: gc_abc123def456
              status: Cancelled
      responses:
        '200':
          description: Success response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse'
              example:
                isSuccess: true
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyOut/authorize:
    post:
      operationId: moneyOut_AuthorizeOut
      tags:
        - MoneyOut
      x-fern-sdk-group-name: moneyOut
      x-fern-sdk-method-name: AuthorizeOut
      x-fern-request-name: RequestOutAuthorize
      summary: Authorize a payout
      description: |-
        Authorizes a transaction for payout.

        If you don't pass `autoCapture` with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use the `referenceId` returned in the response to capture the transaction.

        When `autoCapture` is `true`, Payabli captures the transaction asynchronously after authorization. The response confirms only that the transaction was authorized; it doesn't confirm that capture succeeded. To confirm capture, listen for the [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook event.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
        - name: allowDuplicatedBills
          in: query
          description: When `true`, the authorization bypasses the requirement for unique bills, identified by vendor invoice number. This allows you to make more than one payout authorization for a bill, like a split payment.
          required: false
          schema:
            type: boolean
            default: false
        - name: doNotCreateBills
          in: query
          description: When `true`, Payabli won't automatically create a bill for this payout transaction.
          required: false
          schema:
            type: boolean
            default: false
        - name: forceVendorCreation
          in: query
          description: When `true`, the request creates a new vendor record, regardless of whether the vendor already exists.
          required: false
          schema:
            type: boolean
            default: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthorizePayoutBody'
            examples:
              AuthorizePayout:
                value:
                  entryPoint: 48acde49
                  autoCapture: true
                  invoiceData:
                    - billId: 54323
                  orderDescription: Window Painting
                  paymentDetails:
                    totalAmount: 47
                    unbundled: false
                  paymentMethod:
                    method: managed
                  vendorData:
                    vendorNumber: '7895433'
              WithImage:
                value:
                  entryPoint: 48acde49
                  autoCapture: true
                  invoiceData:
                    - billId: 123
                      attachments:
                        - filename: bill.pdf
                          ftype: pdf
                          furl: https://example.com/bill.pdf
                  orderDescription: Window Painting
                  paymentDetails:
                    totalAmount: 47
                  paymentMethod:
                    method: managed
                  vendorData:
                    vendorNumber: '7895433'
              StoredACH:
                value:
                  entryPoint: 48acde49
                  autoCapture: true
                  source: api
                  invoiceData:
                    - billId: 54323
                  orderDescription: Window Painting
                  paymentMethod:
                    method: ach
                    storedMethodId: 4c6a4b78-72de-4bdd-9455-b9d30f991001-XXXX
                  paymentDetails:
                    totalAmount: 47
                  vendorData:
                    vendorNumber: '7895433'
              CheckPayout:
                value:
                  entryPoint: 48acde49
                  invoiceData:
                    - billId: 54323
                  orderDescription: Office Supplies
                  paymentDetails:
                    totalAmount: 1500
                    checkNumber: '10001'
                  paymentMethod:
                    method: check
                  vendorData:
                    vendorNumber: '7895433'
              AddVendor:
                value:
                  entryPoint: 47ced57b
                  paymentMethod:
                    method: ach
                    achHolder: John Doe
                    achRouting: '011401533'
                    achAccount: '123456789'
                    achAccountType: checking
                    achHolderType: business
                  paymentDetails:
                    totalAmount: 978.32
                  vendorData:
                    vendorNumber: Vendor3800638299609471
                    name1: Heritage Pro Company
                    name2: ''
                    ein: '473771889'
                    phone: '7868342364'
                    email: contact570@heritagepro.com
                    address1: 478 Mittie Roads
                    city: Jakubowskifield
                    state: WI
                    zip: '45993'
                    country: US
                    mcc: '0763'
                    locationCode: tpa
                    contacts:
                      - contactName: Dax
                        contactEmail: Mandy65@heritagepro.com
                        contactPhone: 996-325-5420 x31028
                    vendorStatus: 1
                    remitAddress1: 727 Terrell Streets
                    remitAddress2: Apt. 773
                    remitCity: South Nicholeside
                    remitState: ID
                    remitZip: 72951-9790
                    remitCountry: US
                  invoiceData:
                    - invoiceNumber: VI3BvwTG
                      netAmount: '1'
                      invoiceDate: '2026-09-03'
                      dueDate: '2026-11-04'
                      comments: Building Repairs - Community event setup (System updates)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthCapturePayoutResponse'
              examples:
                AuthorizePayout:
                  value:
                    responseCode: 1
                    pageIdentifier: null
                    roomId: 0
                    isSuccess: true
                    responseText: Success
                    responseData:
                      authCode: null
                      referenceId: 129-219
                      resultCode: 1
                      resultText: Authorized
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: 0
                      methodReferenceId: null
                WithImage:
                  value:
                    responseCode: 1
                    pageIdentifier: null
                    roomId: 0
                    isSuccess: true
                    responseText: Success
                    responseData:
                      authCode: null
                      referenceId: 129-219
                      resultCode: 1
                      resultText: Authorized
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: 0
                      methodReferenceId: null
                StoredACH:
                  value:
                    responseCode: 1
                    pageIdentifier: null
                    roomId: 0
                    isSuccess: true
                    responseText: Success
                    responseData:
                      authCode: null
                      referenceId: 129-219
                      resultCode: 1
                      resultText: Authorized
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: 0
                      methodReferenceId: null
                CheckPayout:
                  value:
                    responseCode: 1
                    pageIdentifier: null
                    roomId: 0
                    isSuccess: true
                    responseText: Success
                    responseData:
                      authCode: null
                      referenceId: 129-219
                      resultCode: 1
                      resultText: Authorized
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: 0
                      methodReferenceId: null
                AddVendor:
                  value:
                    responseCode: 1
                    pageIdentifier: null
                    roomId: 0
                    isSuccess: true
                    responseText: Success
                    responseData:
                      authCode: null
                      referenceId: 129-220
                      resultCode: 1
                      resultText: Authorized
                      avsResponseText: null
                      cvvResponseText: null
                      customerId: 12345
                      methodReferenceId: 12dea40cba9130s93s-12345
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyOut/cancelAll:
    post:
      operationId: moneyOut_CancelAllOut
      tags:
        - MoneyOut
      x-fern-sdk-group-name: moneyOut
      x-fern-sdk-method-name: CancelAllOut
      x-fern-request-name: CancelAllOutRequest
      summary: Cancel list of payout transactions
      description: Cancels an array of payout transactions.
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptureAllOutResponse'
              example:
                isSuccess: true
                pageIdentifier: null
                responseCode: 1
                responseData:
                  - CustomerId: 1000000
                    ReferenceId: 129-230
                    ResultCode: 1
                    ResultText: Cancelled
                  - CustomerId: 1000000
                    ReferenceId: 129-219
                    ResultCode: 1
                    ResultText: Cancelled
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyOut/cancel/{referenceId}:
    get:
      operationId: moneyOut_CancelOutGet
      tags:
        - MoneyOut
      x-fern-sdk-group-name: moneyOut
      x-fern-sdk-method-name: CancelOutGet
      x-fern-request-name: CancelOutGetRequest
      summary: Cancel a payout transaction
      description: Cancel a payout transaction by ID.
      x-fern-availability: deprecated
      security:
        - APIKeyAuth: []
      parameters:
        - name: referenceId
          in: path
          description: The ID for the payout transaction.
          required: true
          schema:
            type: string
          example: 129-219
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse0000'
              example:
                isSuccess: true
                responseText: Success
                pageIdentifier: null
                responseData:
                  ReferenceId: 129-219
                  ResultCode: 1
                  ResultText: Approved
                  CustomerId: 0
                  AuthCode: null
                  cvvResponseText: null
                  avsResponseText: null
                  methodReferenceId: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    delete:
      operationId: moneyOut_CancelOutDelete
      tags:
        - MoneyOut
      x-fern-sdk-group-name: moneyOut
      x-fern-sdk-method-name: CancelOutDelete
      x-fern-request-name: CancelOutDeleteRequest
      summary: Cancel a payout transaction
      description: Cancel a payout transaction by ID.
      security:
        - APIKeyAuth: []
      parameters:
        - name: referenceId
          in: path
          description: The ID for the payout transaction.
          required: true
          schema:
            type: string
          example: 129-219
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse0000'
              example:
                isSuccess: true
                responseText: Success
                pageIdentifier: null
                responseData:
                  ReferenceId: 129-219
                  ResultCode: 1
                  ResultText: Approved
                  CustomerId: 0
                  AuthCode: null
                  cvvResponseText: null
                  avsResponseText: null
                  methodReferenceId: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyOut/captureAll:
    post:
      operationId: moneyOut_CaptureAllOut
      tags:
        - MoneyOut
      x-fern-sdk-group-name: moneyOut
      x-fern-sdk-method-name: CaptureAllOut
      x-fern-request-name: CaptureAllOutRequest
      summary: Capture a list of authorized payout transactions
      description: Captures an array of authorized payout transactions for settlement. The maximum number of transactions that can be captured in a single request is 500.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptureAllOutResponse'
              example:
                isSuccess: true
                pageIdentifier: null
                responseCode: 1
                responseData:
                  - CustomerId: 1000000
                    ReferenceId: 129-230
                    ResultCode: 1
                    ResultText: Captured
                  - CustomerId: 1000000
                    ReferenceId: 129-219
                    ResultCode: 1
                    ResultText: Captured
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyOut/capture/{referenceId}:
    get:
      operationId: moneyOut_CaptureOut
      tags:
        - MoneyOut
      x-fern-sdk-group-name: moneyOut
      x-fern-sdk-method-name: CaptureOut
      x-fern-request-name: CaptureOutRequest
      summary: Capture an authorized payout transaction
      description: Captures a single authorized payout transaction by ID. If the transaction was authorized with `autoCapture` set to `true`,  you don't need to call this endpoint to capture the transaction for processing.
      security:
        - APIKeyAuth: []
      parameters:
        - name: referenceId
          in: path
          description: The ID for the payout transaction.
          required: true
          schema:
            type: string
          example: 129-219
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthCapturePayoutResponse'
              example:
                responseCode: 1
                pageIdentifier: null
                roomId: 0
                isSuccess: true
                responseText: Success
                responseData:
                  authCode: null
                  referenceId: 129-219
                  resultCode: 1
                  resultText: Authorized
                  avsResponseText: null
                  cvvResponseText: null
                  customerId: 0
                  methodReferenceId: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyOut/details/{transId}:
    get:
      operationId: moneyOut_PayoutDetails
      tags:
        - MoneyOut
      x-fern-sdk-group-name: moneyOut
      x-fern-sdk-method-name: PayoutDetails
      x-fern-request-name: PayoutDetailsRequest
      summary: Get details for a processed payout transaction
      description: Returns details for a processed money out transaction.
      security:
        - APIKeyAuth: []
      parameters:
        - name: transId
          in: path
          description: ReferenceId for the transaction (PaymentId).
          required: true
          schema:
            type: string
          examples:
            AuthorizedTransaction:
              value: 45-as456777hhhhhhhhhh77777777-324
            AuthorizeAndCapturedTransaction:
              value: 45-as456777hhhhhhhhhh77777777-324
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillDetailResponse'
              examples:
                AuthorizedTransaction:
                  value:
                    Bills:
                      - invoiceNumber: 123B
                        netAmount: '8800.00'
                    CheckData: null
                    CheckNumber: null
                    Comments: testing
                    CreatedDate: '2022-07-01T15:00:01Z'
                    Events:
                      - EventTime: '2023-04-24T09:17:49Z'
                        TransEvent: Authorized
                    FeeAmount: 0
                    Gateway: TSYS
                    IdOut: 350
                    LastUpdated: '2023-04-23T17:00:00Z'
                    NetAmount: 8800
                    ParentOrgName: PropertyManager Pro
                    PaymentData:
                      AccountType: ''
                      binData:
                        binMatchedLength: '6'
                        binCardBrand: Visa
                        binCardType: Credit
                        binCardCategory: PLATINUM
                        binCardIssuer: Bank of Example
                        binCardIssuerCountry: United States
                        binCardIssuerCountryCodeA2: US
                        binCardIssuerCountryNumber: '840'
                        binCardIsRegulated: 'false'
                        binCardUseCategory: Consumer
                        binCardIssuerCountryCodeA3: USA
                      HolderName: ''
                      Initiator: payor
                      MaskedAccount: ''
                      Sequence: subsequent
                      SignatureData: SignatureData
                      StoredMethodUsageType: subscription
                    PaymentGroup: 2345667-ddd-fff
                    PaymentId: '12345678910'
                    PaymentMethod: managed
                    PaymentStatus: Authorized
                    PaypointDbaname: Sunshine Gutters
                    PaypointLegalname: Sunshine Services, LLC
                    Source: api
                    Status: 11
                    StatusText: Captured
                    TotalAmount: 8800
                    Vendor:
                      VendorNumber: '1234'
                      Name1: Herman's Coatings
                      Name2: Herman's Coating Supply Company, LLC
                      EIN: '123456789'
                      Phone: '2125551234'
                      Email: example@email.com
                      RemitEmail: null
                      Address1: 123 Ocean Drive
                      Address2: Suite 400
                      City: Bristol
                      State: GA
                      Zip: '31113'
                      Country: US
                      Mcc: '7777'
                      LocationCode: LOC123
                      Contacts:
                        ContactEmail: eric@martinezcoatings.com
                        ContactName: Eric Martinez
                        ContactPhone: '5555555555'
                        ContactTitle: Owner
                      BillingData:
                        id: 123456
                        accountId: bank-account-001
                        nickname: Main Checking Account
                        bankName: Example Bank
                        routingAccount: '123456789'
                        accountNumber: '9876543210'
                        typeAccount: Checking
                        bankAccountHolderName: John Doe
                        bankAccountHolderType: Business
                        bankAccountFunction: 2
                        verified: true
                        status: 1
                        services: []
                        default: true
                      PaymentMethod: null
                      VendorStatus: 1
                      VendorId: 1
                      EnrollmentStatus: null
                      Summary:
                        ActiveBills: 2
                        PendingBills: 4
                        InTransitBills: 3
                        PaidBills: 18
                        OverdueBills: 1
                        ApprovedBills: 5
                        DisapprovedBills: 1
                        TotalBills: 34
                        ActiveBillsAmount: 1250.75
                        PendingBillsAmount: 2890.5
                        InTransitBillsAmount: 1675.25
                        PaidBillsAmount: 15420.8
                        OverdueBillsAmount: 425
                        ApprovedBillsAmount: 3240.9
                        DisapprovedBillsAmount: 180
                        TotalBillsAmount: 25083.2
                      PaypointLegalname: Sunshine Services, LLC
                      PaypointDbaname: Sunshine Gutters
                      PaypointEntryname: d193cf9a46
                      ParentOrgName: PropertyManager Pro
                      ParentOrgId: 1000
                      CreatedDate: '2022-07-01T15:00:01Z'
                      LastUpdated: '2022-07-01T15:00:01Z'
                      remitAddress1: 123 Walnut Street
                      remitAddress2: Suite 900
                      remitCity: Miami
                      remitState: FL
                      remitZip: '31113'
                      remitCountry: US
                      payeeName1: payeeName1
                      payeeName2: payeeName2
                      customField1: ''
                      customField2: ''
                      customerVendorAccount: 123-456
                      InternalReferenceId: 1000000
                      PaymentPortalUrl: https://greenfield-landscaping.com/pay
                      CardAccepted: 'yes'
                      AchAccepted: unable to determine
                      EnrichmentStatus: fully_enriched
                      EnrichedBy: web_search
                      EnrichedAt: '2026-03-05T14:22:10Z'
                      EnrichmentId: enrich-3890-a1b2c3d4
                      additionalData: null
                      externalPaypointID: Paypoint-100
                      StoredMethods: []
                    CreatedAt: null
                    ParentOrgId: null
                    externalPaypointID: null
                    EntryName: null
                    BatchId: null
                    HasVcardTransactions: false
                    IsSameDayACH: false
                    ScheduleId: null
                    SettlementStatus: null
                    RiskFlagged: false
                    RiskFlaggedOn: null
                    RiskStatus: null
                    RiskReason: null
                    RiskAction: null
                    RiskActionCode: null
                AuthorizeAndCapturedTransaction:
                  value:
                    Bills:
                      - invoiceNumber: 123B
                        netAmount: '8800.00'
                    CheckData: null
                    CheckNumber: null
                    Comments: testing
                    CreatedDate: '2022-07-01T15:00:01Z'
                    Events:
                      - EventTime: '2023-04-24T09:00:33Z'
                        TransEvent: Authorized
                      - EventData:
                          custId: PAYABLITST
                          dateCreated: '2023-04-24T16:14:28Z'
                          dateModified: '2023-04-24T16:14:28Z'
                          group:
                            approved: false
                            custId: PAYABLITST
                            dateCreated: '2023-04-24T16:14:28Z'
                            dateModified: '2023-04-24T16:14:28Z'
                            id: acd5ddd9-42be-4822-bc02-46e7c560d8a4
                            links:
                              - href: https://cert-api.cpayplus.com/payments/groups/acd5ddd9-42be-4822-bc02-46e7c560d8a4
                                rel: cancel
                                type: DELETE
                              - href: https://cert-api.cpayplus.com/payments/groups/acd5ddd9-42be-4822-bc02-46e7c560d8a4/approve
                                rel: approve
                                type: POST
                              - href: https://cert-api.cpayplus.com/payments/groups/acd5ddd9-42be-4822-bc02-46e7c560d8a4
                                rel: self
                                type: GET
                            name: 187-20230424-PAYABLITST
                            status: Waiting Funds
                            totalAmount: '8800.00'
                          id: 1ede3eb2-a564-43b5-b2d2-7195f6d9fded
                          invoices:
                            - invoiceNumber: 123B
                              netAmount: '8800.00'
                          links:
                            - href: https://cert-api.cpayplus.com/payments/1ede3eb2-a564-43b5-b2d2-7195f6d9fded/resendRemit
                              rel: resendRemit
                              type: POST
                            - href: https://cert-api.cpayplus.com/payments/1ede3eb2-a564-43b5-b2d2-7195f6d9fded
                              rel: cancel
                              type: DELETE
                            - href: https://cert-api.cpayplus.com/payments/1ede3eb2-a564-43b5-b2d2-7195f6d9fded
                              rel: self
                              type: GET
                            - href: https://cert-api.cpayplus.com/payments/1ede3eb2-a564-43b5-b2d2-7195f6d9fded/reissue
                              rel: reissue
                              type: POST
                          paymentNumber: 187-349
                          paymentStatus: Awaiting Funds
                          paymentType: VCard
                          remitAddress:
                            address1: 5724 daughtery downs Loop
                            address2: ''
                            city: Lakeland
                            countryCode: US
                            state: FL
                            zip: '33809'
                          vendor:
                            address:
                              address1: 5724 DAUGHTERY DOWNS LOOP
                              address2: ''
                              city: LAKELAND
                              countryCode: US
                              state: FL
                              zip: '33809'
                            contactEmail: paul@payabli.com
                            custId: PAYABLITST
                            dateCreated: '2023-04-07T15:10:13Z'
                            dateModified: '2023-04-17T15:39:33Z'
                            email: paul@payabli.com
                            id: d7d92fac-fd8a-4ce9-8f92-62ee979b43fe
                            links:
                              - href: https://cert-api.cpayplus.com/payments/d7d92fac-fd8a-4ce9-8f92-62ee979b43fe
                                rel: self
                                type: GET
                            paymentType: VCard
                            status: Enrolled
                            statusReason: Customer Enrolled
                            vendorName1: PAUL'S
                            vendorNumber: '54321'
                            vendorPhone: '19706188888'
                            vendorTaxId: '123456789'
                        EventTime: '2023-04-24T09:14:28Z'
                        TransEvent: Captured
                    FeeAmount: 0
                    Gateway: TSYS
                    IdOut: 349
                    LastUpdated: '2023-04-23T17:00:00Z'
                    NetAmount: 8800
                    ParentOrgName: PropertyManager Pro
                    PaymentData:
                      AccountType: ''
                      binData:
                        binMatchedLength: '6'
                        binCardBrand: Visa
                        binCardType: Credit
                        binCardCategory: PLATINUM
                        binCardIssuer: Bank of Example
                        binCardIssuerCountry: United States
                        binCardIssuerCountryCodeA2: US
                        binCardIssuerCountryNumber: '840'
                        binCardIsRegulated: 'false'
                        binCardUseCategory: Consumer
                        binCardIssuerCountryCodeA3: USA
                      HolderName: ''
                      Initiator: payor
                      MaskedAccount: ''
                      Sequence: subsequent
                      SignatureData: SignatureData
                      StoredMethodUsageType: subscription
                    PaymentGroup: 2345667-ddd-fff
                    PaymentId: '1234567890'
                    PaymentMethod: managed
                    PaymentStatus: Captured
                    PaypointDbaname: Sunshine Gutters
                    PaypointLegalname: Sunshine Services, LLC
                    Source: api
                    Status: 1
                    StatusText: Captured
                    TotalAmount: 8800
                    Vendor:
                      VendorNumber: '1234'
                      Name1: Herman's Coatings
                      Name2: Herman's Coating Supply Company, LLC
                      EIN: '123456789'
                      Phone: '2125551234'
                      Email: example@email.com
                      RemitEmail: null
                      Address1: 123 Ocean Drive
                      Address2: Suite 400
                      City: Bristol
                      State: GA
                      Zip: '31113'
                      Country: US
                      Mcc: '7777'
                      LocationCode: LOC123
                      Contacts:
                        ContactEmail: eric@martinezcoatings.com
                        ContactName: Eric Martinez
                        ContactPhone: '5555555555'
                        ContactTitle: Owner
                      BillingData:
                        id: 123456
                        accountId: bank-account-001
                        nickname: Main Checking Account
                        bankName: Example Bank
                        routingAccount: '123456789'
                        accountNumber: '9876543210'
                        typeAccount: Checking
                        bankAccountHolderName: John Doe
                        bankAccountHolderType: Business
                        bankAccountFunction: 2
                        verified: true
                        status: 1
                        services: []
                        default: true
                      PaymentMethod: null
                      VendorStatus: 1
                      VendorId: 1
                      EnrollmentStatus: null
                      Summary:
                        ActiveBills: 2
                        PendingBills: 4
                        InTransitBills: 3
                        PaidBills: 18
                        OverdueBills: 1
                        ApprovedBills: 5
                        DisapprovedBills: 1
                        TotalBills: 34
                        ActiveBillsAmount: 1250.75
                        PendingBillsAmount: 2890.5
                        InTransitBillsAmount: 1675.25
                        PaidBillsAmount: 15420.8
                        OverdueBillsAmount: 425
                        ApprovedBillsAmount: 3240.9
                        DisapprovedBillsAmount: 180
                        TotalBillsAmount: 25083.2
                      PaypointLegalname: Sunshine Services, LLC
                      PaypointDbaname: Sunshine Gutters
                      PaypointEntryname: d193cf9a46
                      ParentOrgName: PropertyManager Pro
                      ParentOrgId: 1000
                      CreatedDate: '2022-07-01T15:00:01Z'
                      LastUpdated: '2022-07-01T15:00:01Z'
                      remitAddress1: 123 Walnut Street
                      remitAddress2: Suite 900
                      remitCity: Miami
                      remitState: FL
                      remitZip: '31113'
                      remitCountry: US
                      payeeName1: payeeName1
                      payeeName2: payeeName2
                      customField1: ''
                      customField2: ''
                      customerVendorAccount: 123-456
                      InternalReferenceId: 1000000
                      PaymentPortalUrl: https://greenfield-landscaping.com/pay
                      CardAccepted: 'yes'
                      AchAccepted: unable to determine
                      EnrichmentStatus: fully_enriched
                      EnrichedBy: web_search
                      EnrichedAt: '2026-03-05T14:22:10Z'
                      EnrichmentId: enrich-3890-a1b2c3d4
                      additionalData: null
                      externalPaypointID: Paypoint-100
                      StoredMethods: []
                    CreatedAt: null
                    ParentOrgId: null
                    externalPaypointID: null
                    EntryName: null
                    BatchId: null
                    HasVcardTransactions: false
                    IsSameDayACH: false
                    ScheduleId: null
                    SettlementStatus: null
                    RiskFlagged: false
                    RiskFlaggedOn: null
                    RiskStatus: null
                    RiskReason: null
                    RiskAction: null
                    RiskActionCode: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyOut/vcard/{cardToken}:
    get:
      operationId: moneyOut_VCardGet
      tags:
        - MoneyOut
      x-fern-sdk-group-name: moneyOut
      x-fern-sdk-method-name: VCardGet
      x-fern-request-name: VCardGetRequest
      summary: Get a virtual card
      description: Retrieves vCard details for a single card in an entrypoint.
      security:
        - APIKeyAuth: []
      parameters:
        - name: cardToken
          in: path
          description: ID for a virtual card.
          required: true
          schema:
            type: string
          example: '20230403315245421165'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VCardGetResponse'
              example:
                vcardSent: false
                cardToken: '20231206142225226104'
                cardNumber: 553232XXXXXX3179
                cvc: XXX
                expirationDate: '2025-05-01'
                status: null
                amount: 120
                currentBalance: 120
                expenseLimit: 20
                expenseLimitPeriod: null
                maxNumberOfUses: 1
                currentNumberOfUses: 0
                exactAmount: true
                mcc: null
                tcc: null
                misc1: null
                misc2: null
                dateCreated: '2023-12-06T20:25:31.077'
                dateModified: '2023-12-06T00:00:00'
                associatedVendor:
                  VendorNumber: VENDOR123456
                  Name1: Smith Industries
                  Name2: John Smith
                  EIN: 12-3456789
                  Phone: 555-123-4567
                  Email: contact@smithindustries.com
                  RemitEmail: null
                  Address1: 1234 Main Street
                  Address2: Suite 200
                  City: New York
                  State: NY
                  Zip: '10001'
                  Country: USA
                  Mcc: '5411'
                  LocationCode: null
                  Contacts:
                    - ContactName: Herman Martinez
                      ContactEmail: herman@hermanscoatings.com
                      ContactTitle: Owner
                      ContactPhone: '3055550000'
                  BillingData:
                    id: 123
                    accountId: null
                    nickname: Checking Account
                    bankName: Chase Bank
                    routingAccount: '021000021'
                    accountNumber: 3XXXXXX8888
                    typeAccount: Checking
                    bankAccountHolderName: Gruzya Adventure Outfitters LLC
                    bankAccountHolderType: Business
                    bankAccountFunction: 0
                    verified: true
                    status: 1
                    services: []
                    default: true
                  PaymentMethod: vcard
                  VendorStatus: 1
                  VendorId: 339
                  EnrollmentStatus: null
                  Summary:
                    ActiveBills: 1
                    ActiveBillsAmount: 1.1
                    ApprovedBills: 1
                    ApprovedBillsAmount: 1.1
                    DisapprovedBills: 1
                    DisapprovedBillsAmount: 1.1
                    InTransitBills: 0
                    InTransitBillsAmount: 0
                    OverdueBills: 1
                    OverdueBillsAmount: 100
                    PaidBills: 0
                    PaidBillsAmount: 0
                    PendingBills: 1
                    PendingBillsAmount: 100
                    TotalBills: 1
                    TotalBillsAmount: 100
                  PaypointLegalname: Athlete Factory LLC
                  PaypointDbaname: Athlete Factory LLC
                  PaypointEntryname: PaypointEntryname
                  ParentOrgName: HOA Manager Pro
                  ParentOrgId: 1232
                  CreatedDate: '2022-07-01T15:00:01Z'
                  LastUpdated: '2022-07-01T15:00:01Z'
                  remitAddress1: 123 Walnut Street
                  remitAddress2: Suite 900
                  remitCity: Miami
                  remitState: FL
                  remitZip: '31113'
                  remitCountry: US
                  payeeName1: null
                  payeeName2: null
                  customField1: customField1
                  customField2: customField2
                  customerVendorAccount: null
                  InternalReferenceId: 27
                  additionalData: null
                  externalPaypointID: null
                  StoredMethods: null
                associatedCustomer: null
                ParentOrgName: HOA Manager Pro
                PaypointDbaname: Athlete Factory LLC
                PaypointLegalname: Athlete Factory LLC
                PaypointEntryname: 47acde49
                externalPaypointID: null
                paypointId: 12345
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /vcard/send-card-link:
    post:
      operationId: moneyOut_SendVCardLink
      tags:
        - MoneyOut
      x-fern-sdk-group-name: moneyOut
      x-fern-sdk-method-name: SendVCardLink
      x-fern-request-name: SendVCardLinkRequest
      summary: Send virtual card link
      description: Sends a virtual card link via email to the vendor associated with the `transId`.
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendVCardLinkRequest'
            example:
              transId: 01K33Z6YQZ6GD5QVKZ856MJBSC
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResult'
              example:
                message: 'Successfully sent email to: vendor@vendor.com'
                success: true
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyOut/checkimage/{assetName}:
    get:
      operationId: moneyOut_GetCheckImage
      tags:
        - MoneyOut
      x-fern-sdk-group-name: moneyOut
      x-fern-sdk-method-name: GetCheckImage
      x-fern-request-name: GetCheckImageRequest
      summary: Get check image
      description: |-
        Retrieve the image of a check associated with a processed transaction.
        The check image is returned in the response body as a base64-encoded string.
        The check image is only available for payouts that have been processed.
      security:
        - APIKeyAuth: []
      parameters:
        - name: assetName
          in: path
          description: |
            Name of the check asset to retrieve. This is returned as `filename` in the `CheckData` object
            in the response when you make a GET request to `/MoneyOut/details/{transId}`.
            ```
                "CheckData": {
                  "ftype": "PDF",
                  "filename": "check133832686289732320_01JKBNZ5P32JPTZY8XXXX000000.pdf",
                  "furl": "",
                  "fContent": ""
              }
            ```
          required: true
          schema:
            type: string
          example: check133832686289732320_01JKBNZ5P32JPTZY8XXXX000000.pdf
      responses:
        '200':
          description: A base64-encoded string of the check image.
          content:
            application/json:
              schema:
                type: string
              example: JVBERi0xLjcKJeLjz9MKMTIzIDAgb2JqCjwvTGluZWFyaXplZCAxL0wgMTIzNDU2L08gMTI1L0UgNzg5MDEvTiAxL1QgMTIzNDUwL0ggWyA4MDAgMjAwXT4+CmVuZG9iagouLi4=
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyOut/status/{transId}/{checkPaymentStatus}:
    patch:
      operationId: moneyOut_UpdateCheckPaymentStatus
      tags:
        - MoneyOut
      x-fern-sdk-group-name: moneyOut
      x-fern-sdk-method-name: UpdateCheckPaymentStatus
      x-fern-request-name: UpdateCheckPaymentStatusRequest
      summary: Update check payment status
      description: |-
        Updates the status of a processed check payment transaction. This endpoint handles the status transition, updates related bills, creates audit events, and triggers notifications.

        The transaction must meet all of the following criteria:
        - **Status**: Must be in Processing or Processed status.
        - **Payment method**: Must be a check payment method.

        ### Allowed status values

        | Value | Status | Description |
        |-------|--------|-------------|
        | `0` | Cancelled/Voided | Cancels the check transaction. Reverts associated bills to their previous state (Approved or Active), creates "Cancelled" events, and sends a `payout_transaction_voidedcancelled` notification if the notification is enabled. |
        | `5` | Paid | Marks the check transaction as paid. Updates associated bills to "Paid" status, creates "Paid" events, and sends a `payout_transaction_paid` notification if the notification is enabled. |
      security:
        - APIKeyAuth: []
      parameters:
        - name: transId
          in: path
          description: The Payabli transaction ID for the check payment.
          required: true
          schema:
            type: string
          examples:
            MarkCheckAsPaid:
              value: TRANS123456
            CancelCheck:
              value: TRANS123456
        - name: checkPaymentStatus
          in: path
          description: The new status to apply to the check transaction. To mark a check as `Paid`, send 5. To mark a check as `Cancelled`, send 0.
          required: true
          schema:
            $ref: '#/components/schemas/AllowedCheckPaymentStatus'
          examples:
            MarkCheckAsPaid:
              value: '5'
            CancelCheck:
              value: '0'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliApiResponse00Responsedatanonobject'
              examples:
                MarkCheckAsPaid:
                  value:
                    responseCode: 1
                    pageIdentifier: null
                    roomId: 0
                    isSuccess: true
                    responseText: Success
                    responseData: TRANS123456
                CancelCheck:
                  value:
                    responseCode: 1
                    pageIdentifier: null
                    roomId: 0
                    isSuccess: true
                    responseText: Success
                    responseData: TRANS123456
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /MoneyOut/reissue:
    post:
      operationId: moneyOut_ReissueOut
      tags:
        - MoneyOut
      x-fern-sdk-group-name: moneyOut
      x-fern-sdk-method-name: ReissueOut
      x-fern-request-name: ReissueOutRequest
      summary: Reissue a payout transaction
      description: |-
        Reissues a payout transaction with a new payment method. This creates a new transaction linked to the original and marks the original transaction as reissued.

        The original transaction must be in **Processing** or **Processed** status. The payment method in the request body is used directly. The endpoint doesn't fall back to vendor-managed payment methods.

        The new transaction goes through the standard authorize-and-capture flow automatically. Both the original and new transactions are linked through their event histories for audit purposes.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
        - name: transId
          in: query
          description: The transaction ID of the payout to reissue.
          required: true
          schema:
            type: string
          examples:
            ReissueAsACH:
              value: 129-219
            ReissueAsCheck:
              value: 129-219
            ReissueAsVCard:
              value: 129-219
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReissuePayoutBody'
            examples:
              ReissueAsACH:
                value:
                  paymentMethod:
                    method: ach
                    achAccount: '9876543210'
                    achAccountType: savings
                    achRouting: '021000021'
                    achHolder: Acme Corp
                    achHolderType: business
              ReissueAsCheck:
                value:
                  paymentMethod:
                    method: check
              ReissueAsVCard:
                value:
                  paymentMethod:
                    method: vcard
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReissuePayoutResponse'
              examples:
                ReissueAsACH:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseText: Success
                    responseData:
                      transactionId: 130-220
                      status: Authorized
                      originalTransactionId: 129-219
                ReissueAsCheck:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseText: Success
                    responseData:
                      transactionId: 130-221
                      status: Authorized
                      originalTransactionId: 129-219
                ReissueAsVCard:
                  value:
                    isSuccess: true
                    responseCode: 1
                    responseText: Success
                    responseData:
                      transactionId: 130-222
                      status: Authorized
                      originalTransactionId: 129-219
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Wallet/applepay/configure-organization:
    post:
      operationId: wallet_ConfigureApplePayOrganization
      tags:
        - Wallet
      x-fern-sdk-group-name: wallet
      x-fern-sdk-method-name: ConfigureApplePayOrganization
      x-fern-request-name: ConfigureOrganizationRequestApplePay
      summary: Configure Apple Pay for an organization
      description: Configure and activate Apple Pay for a Payabli organization
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigureOrganizationRequestApplePay'
            example:
              cascade: true
              isEnabled: true
              orgId: 901
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigureApplePayOrganizationApiResponse'
              example:
                isSuccess: true
                pageIdentifier: 'null'
                responseCode: 1
                responseData:
                  createdAt: '2022-07-01T15:00:01Z'
                  id: id
                  jobId: '445865'
                  jobStatus: completed
                  organizationId: 901
                  type: type
                  updatedAt: '2022-07-01T15:00:01Z'
                  updates:
                    cascade: true
                    isEnabled: true
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Wallet/applepay/configure-paypoint:
    post:
      operationId: wallet_ConfigureApplePayPaypoint
      tags:
        - Wallet
      x-fern-sdk-group-name: wallet
      x-fern-sdk-method-name: ConfigureApplePayPaypoint
      x-fern-request-name: ConfigurePaypointRequestApplePay
      summary: Configure Apple Pay for a paypoint
      description: Configure and activate Apple Pay for a Payabli paypoint
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigurePaypointRequestApplePay'
            example:
              entry: 8cfec329267
              isEnabled: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigureApplePaypointApiResponse'
              example:
                isSuccess: true
                pageIdentifier: 'null'
                responseCode: 1
                responseData:
                  entry: 8cfec329267
                  isEnabled: true
                  walletType: applepay
                  walletData:
                    entry: 8cfec329267
                    applePayMerchantId: applePayMerchantId
                    domainNames:
                      - subdomain.domain.com
                    paypointName: Alaskan Domes
                    paypointUrl: null
                    markedForDeletionAt: '2022-07-01T15:00:01Z'
                    createdAt: '2022-07-01T15:00:01Z'
                    updatedAt: '2022-07-01T15:00:01Z'
                    id: id
                    type: ApplePayRegistration
                responseText: Success
                roomId: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Wallet/googlepay/configure-organization:
    post:
      operationId: wallet_ConfigureGooglePayOrganization
      tags:
        - Wallet
      x-fern-sdk-group-name: wallet
      x-fern-sdk-method-name: ConfigureGooglePayOrganization
      x-fern-request-name: ConfigureOrganizationRequestGooglePay
      summary: Configure Google Pay for an organization
      description: Configure and activate Google Pay for a Payabli organization
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigureOrganizationRequestGooglePay'
            example:
              cascade: true
              isEnabled: true
              orgId: 901
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigureApplePayOrganizationApiResponse'
              example:
                isSuccess: true
                pageIdentifier: 'null'
                responseCode: 1
                responseData:
                  createdAt: '2022-07-01T15:00:01Z'
                  id: id
                  jobId: '445865'
                  jobStatus: completed
                  organizationId: 901
                  type: type
                  updatedAt: '2022-07-01T15:00:01Z'
                  updates:
                    cascade: true
                    isEnabled: true
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /Wallet/googlepay/configure-paypoint:
    post:
      operationId: wallet_ConfigureGooglePayPaypoint
      tags:
        - Wallet
      x-fern-sdk-group-name: wallet
      x-fern-sdk-method-name: ConfigureGooglePayPaypoint
      x-fern-request-name: ConfigurePaypointRequestGooglePay
      summary: Configure Google Pay for a paypoint
      description: Configure and activate Google Pay for a Payabli paypoint
      security:
        - APIKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigurePaypointRequestGooglePay'
            example:
              entry: 8cfec329267
              isEnabled: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigureGooglePaypointApiResponse'
              example:
                isSuccess: true
                pageIdentifier: 'null'
                responseCode: 1
                responseData:
                  entry: 8cfec329267
                  isEnabled: true
                  walletType: googlepay
                  walletData:
                    gatewayMerchantId: 123ID
                    gatewayId: 123ID
                responseText: Success
                roomId: null
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PayoutSubscription:
    post:
      operationId: payoutSubscription_CreatePayoutSubscription
      tags:
        - PayoutSubscription
      x-fern-sdk-group-name: payoutSubscription
      x-fern-sdk-method-name: CreatePayoutSubscription
      x-fern-request-name: RequestPayoutSchedule
      summary: Create payout subscription
      description: Creates a payout subscription to automatically send payouts to a vendor on a recurring schedule. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for a step-by-step guide.
      security:
        - APIKeyAuth: []
      parameters:
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayoutSubscriptionRequestBody'
            examples:
              ACHPayoutSubscription:
                value:
                  entryPoint: d193cf9a46
                  paymentMethod:
                    method: ach
                    achHolder: Herman Coatings
                    achRouting: '021000021'
                    achAccount: '3453445666'
                    achAccountType: checking
                  paymentDetails:
                    totalAmount: 500
                    serviceFee: 0
                    currency: USD
                  vendorData:
                    vendorId: 1501
                  billData:
                    - invoiceNumber: INV-5001
                      netAmount: '500'
                      invoiceDate: '2025-08-01'
                      dueDate: '2025-08-15'
                  scheduleDetails:
                    startDate: 09/01/2027
                    endDate: 09/01/2026
                    frequency: monthly
              VcardPayoutSubscription:
                value:
                  entryPoint: d193cf9a46
                  paymentMethod:
                    method: vcard
                  paymentDetails:
                    totalAmount: 250
                    serviceFee: 0
                  vendorData:
                    vendorId: 1501
                  billData:
                    - invoiceNumber: INV-7820
                      netAmount: '250'
                      invoiceDate: '2025-08-15'
                      dueDate: '2025-09-01'
                  scheduleDetails:
                    startDate: 09/01/2027
                    frequency: weekly
                    endDate: untilcancelled
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddPayoutSubscriptionResponse'
              examples:
                ACHPayoutSubscription:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData: 42
                    customerId: 1501
                VcardPayoutSubscription:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData: 42
                    customerId: 1501
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /PayoutSubscription/{id}:
    get:
      operationId: payoutSubscription_GetPayoutSubscription
      tags:
        - PayoutSubscription
      x-fern-sdk-group-name: payoutSubscription
      x-fern-sdk-method-name: GetPayoutSubscription
      x-fern-request-name: GetPayoutSubscriptionRequest
      summary: Get a payout subscription
      description: Retrieves a single payout subscription's details. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
      security:
        - APIKeyAuth: []
      parameters:
        - name: id
          in: path
          description: The payout subscription ID.
          required: true
          schema:
            type: integer
            format: int64
          example: 42
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPayoutSubscriptionResponse'
              example:
                responseText: Success
                isSuccess: true
                responseData:
                  idOutSubscription: 42
                  status: 1
                  events:
                    - description: TransferCreated
                      eventTime: '2025-09-01T06:00:00Z'
                      extraData: null
                      refData: refData
                      source: api
                  vendor:
                    VendorNumber: '1234'
                    Name1: Herman's Coatings
                    Name2: Herman's Coating Supply Company, LLC
                    EIN: '123456789'
                    Phone: '2125551234'
                    Email: example@email.com
                    RemitEmail: null
                    Address1: 123 Ocean Drive
                    Address2: Suite 400
                    City: Bristol
                    State: GA
                    Zip: '31113'
                    Country: US
                    Mcc: '7777'
                    LocationCode: LOC123
                    Contacts:
                      ContactEmail: eric@martinezcoatings.com
                      ContactName: Eric Martinez
                      ContactPhone: '5555555555'
                      ContactTitle: Owner
                    BillingData:
                      id: 123456
                      accountId: bank-account-001
                      nickname: Main Checking Account
                      bankName: Example Bank
                      routingAccount: '123456789'
                      accountNumber: '9876543210'
                      typeAccount: Checking
                      bankAccountHolderName: John Doe
                      bankAccountHolderType: Business
                      bankAccountFunction: 2
                      verified: true
                      status: 1
                      services: []
                      default: true
                    PaymentMethod: null
                    VendorStatus: 1
                    VendorId: 1
                    EnrollmentStatus: null
                    Summary:
                      ActiveBills: 2
                      PendingBills: 4
                      InTransitBills: 3
                      PaidBills: 18
                      OverdueBills: 1
                      ApprovedBills: 5
                      DisapprovedBills: 1
                      TotalBills: 34
                      ActiveBillsAmount: 1250.75
                      PendingBillsAmount: 2890.5
                      InTransitBillsAmount: 1675.25
                      PaidBillsAmount: 15420.8
                      OverdueBillsAmount: 425
                      ApprovedBillsAmount: 3240.9
                      DisapprovedBillsAmount: 180
                      TotalBillsAmount: 25083.2
                    PaypointLegalname: Sunshine Services, LLC
                    PaypointDbaname: Sunshine Gutters
                    PaypointEntryname: d193cf9a46
                    ParentOrgName: PropertyManager Pro
                    ParentOrgId: 1000
                    CreatedDate: '2022-07-01T15:00:01Z'
                    LastUpdated: '2022-07-01T15:00:01Z'
                    remitAddress1: 123 Walnut Street
                    remitAddress2: Suite 900
                    remitCity: Miami
                    remitState: FL
                    remitZip: '31113'
                    remitCountry: US
                    payeeName1: payeeName1
                    payeeName2: payeeName2
                    customField1: ''
                    customField2: ''
                    customerVendorAccount: 123-456
                    InternalReferenceId: 1000000
                    PaymentPortalUrl: https://greenfield-landscaping.com/pay
                    CardAccepted: 'yes'
                    AchAccepted: unable to determine
                    EnrichmentStatus: fully_enriched
                    EnrichedBy: web_search
                    EnrichedAt: '2026-03-05T14:22:10Z'
                    EnrichmentId: enrich-3890-a1b2c3d4
                    additionalData: null
                    externalPaypointID: Paypoint-100
                    StoredMethods: []
                  billData:
                    - billId: 3001
                      invoiceNumber: INV-5001
                      netAmount: '500'
                      invoiceDate: '2025-08-01'
                      dueDate: '2025-08-15'
                  externalPaypointID: d193cf9a46-10
                  method: ach
                  paypointId: 255
                  totalAmount: 500
                  netAmount: 500
                  feeAmount: 0
                  paymentData:
                    AccountType: checking
                    HolderName: Herman Coatings
                    Initiator: merchant
                    MaskedAccount: XXXXXX5666
                    paymentDetails:
                      currency: USD
                      serviceFee: 0
                      totalAmount: 500
                    Sequence: subsequent
                    StoredMethodUsageType: recurring
                  startDate: '2025-09-01T00:00:00Z'
                  endDate: '2026-09-01T00:00:00Z'
                  nextDate: '2025-10-01T00:00:00Z'
                  frequency: monthly
                  totalCycles: 12
                  leftCycles: 11
                  lastRun: '2025-09-01T06:00:00Z'
                  entrypageId: 0
                  untilCancelled: false
                  lastUpdated: '2025-08-01T12:00:00Z'
                  createdAt: '2025-08-01T12:00:00Z'
                  paypointLegalname: Sunshine Services, LLC
                  paypointDbaname: Sunshine Gutters
                  paypointEntryname: d193cf9a46
                  parentOrgName: PropertyManager Pro
                  parentOrgId: 236
                  source: api
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    put:
      operationId: payoutSubscription_UpdatePayoutSubscription
      tags:
        - PayoutSubscription
      x-fern-sdk-group-name: payoutSubscription
      x-fern-sdk-method-name: UpdatePayoutSubscription
      x-fern-request-name: UpdatePayoutSubscriptionBody
      summary: Update a payout subscription
      description: Updates a payout subscription's details. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
      security:
        - APIKeyAuth: []
      parameters:
        - name: id
          in: path
          description: The payout subscription ID.
          required: true
          schema:
            type: integer
            format: int64
          examples:
            PausePayoutSubscription:
              value: 42
            UnpausePayoutSubscription:
              value: 42
            UpdatePayoutSubscription:
              value: 42
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePayoutSubscriptionBody'
            examples:
              PausePayoutSubscription:
                value:
                  setPause: true
              UnpausePayoutSubscription:
                value:
                  setPause: false
              UpdatePayoutSubscription:
                value:
                  paymentDetails:
                    serviceFee: 0
                    totalAmount: 750
                  scheduleDetails:
                    endDate: 12/31/2027
                    frequency: monthly
                    startDate: 01/01/2027
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePayoutSubscriptionResponse'
              examples:
                PausePayoutSubscription:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData: 42 paused
                    customerId: 1501
                UnpausePayoutSubscription:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData: '42'
                    customerId: 1501
                UpdatePayoutSubscription:
                  value:
                    responseText: Success
                    isSuccess: true
                    responseData: '42'
                    customerId: 1501
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
    delete:
      operationId: payoutSubscription_DeletePayoutSubscription
      tags:
        - PayoutSubscription
      x-fern-sdk-group-name: payoutSubscription
      x-fern-sdk-method-name: DeletePayoutSubscription
      x-fern-request-name: DeletePayoutSubscriptionRequest
      summary: Delete a payout subscription
      description: Deletes a payout subscription and prevents future payouts. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
      security:
        - APIKeyAuth: []
      parameters:
        - name: id
          in: path
          description: The payout subscription ID.
          required: true
          schema:
            type: integer
            format: int64
          example: 42
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePayoutSubscriptionResponse'
              example:
                isSuccess: true
                responseData: '42'
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /ChargeBacks/response/{Id}:
    post:
      operationId: chargeBacks_AddResponse
      tags:
        - ChargeBacks
      x-fern-sdk-group-name: chargeBacks
      x-fern-sdk-method-name: AddResponse
      x-fern-request-name: ResponseChargeBack
      summary: Add response to chargeback or return
      description: Add a response to a chargeback or ACH return.
      security:
        - APIKeyAuth: []
      parameters:
        - name: Id
          in: path
          description: ID of the chargeback or return record.
          required: true
          schema:
            type: integer
            format: int64
          example: 1000000
        - name: idempotencyKey
          in: header
          required: false
          description: _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
          schema:
            $ref: '#/components/schemas/IdempotencyKey'
          example: 6B29FC40-CA47-1067-B31D-00DD010662DA
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResponseChargeBack'
            example: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddResponseResponse'
              example:
                isSuccess: true
                responseData: 126
                responseText: Success
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /ChargeBacks/read/{Id}:
    get:
      operationId: chargeBacks_GetChargeback
      tags:
        - ChargeBacks
      x-fern-sdk-group-name: chargeBacks
      x-fern-sdk-method-name: GetChargeback
      x-fern-request-name: GetChargebackRequest
      summary: Get chargeback or ACH return record
      description: Retrieves a chargeback record and its details.
      security:
        - APIKeyAuth: []
      parameters:
        - name: Id
          in: path
          description: ID of the chargeback or return record. This is returned as `chargebackID` in the [ReceivedChargeBack](/guides/pay-ops-webhooks-payloads#receivedchargeback) and [ReceivedAchReturn](/guides/pay-ops-webhooks-payloads#receivedachreturn) webhook notifications.
          required: true
          schema:
            type: integer
            format: int64
          example: 1000000
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargebackQueryRecords'
              example:
                Id: 201
                ChargebackDate: '2022-06-25T00:00:00Z'
                CaseNumber: TZ45678
                ReasonCode: reasonCode
                Reason: Buyer dispute
                ReferenceNumber: referenceNumber
                LastFour: '6789'
                AccountType: visa
                Status: 1
                Method: card
                CreatedAt: '2022-07-01T15:00:01Z'
                ReplyBy: '2022-07-15T23:59:59Z'
                PaymentTransId: 226-fe55ec0348e34702bd91b4be198ce7ec
                ScheduleReference: 0
                OrderId: O-5140
                NetAmount: 3762.87
                TransactionTime: '2024-01-15T09:30:00Z'
                Customer:
                  AdditionalData: null
                  BillingAddress1: 1111 West 1st Street
                  BillingAddress2: Suite 200
                  BillingCity: Miami
                  BillingCountry: US
                  BillingEmail: example@email.com
                  BillingPhone: '5555555555'
                  BillingState: FL
                  BillingZip: '45567'
                  CompanyName: Sunshine LLC
                  customerId: 4440
                  CustomerNumber: 3456-7645A
                  customerStatus: 1
                  FirstName: John
                  Identifiers:
                    - firstname
                    - lastname
                    - email
                    - customId
                  LastName: Doe
                  ShippingAddress1: 123 Walnut St
                  ShippingAddress2: STE 900
                  ShippingCity: Johnson City
                  ShippingCountry: US
                  ShippingState: TN
                  ShippingZip: '37619'
                PaymentData:
                  AccountExp: 11/29
                  accountId: accountId
                  AccountType: visa
                  AccountZip: '90210'
                  binData:
                    binMatchedLength: '6'
                    binCardBrand: Visa
                    binCardType: Credit
                    binCardCategory: PLATINUM
                    binCardIssuer: Bank of Example
                    binCardIssuerCountry: United States
                    binCardIssuerCountryCodeA2: US
                    binCardIssuerCountryNumber: '840'
                    binCardIsRegulated: 'false'
                    binCardUseCategory: Consumer
                    binCardIssuerCountryCodeA3: USA
                  HolderName: Chad Mercia
                  Initiator: payor
                  MaskedAccount: 4XXXXXXXX1111
                  orderDescription: Deposit for materials for 123 Walnut St
                  paymentDetails:
                    categories:
                      - amount: 1000
                        label: Deposit
                    checkImage:
                      key: value
                    checkNumber: '107'
                    currency: USD
                    serviceFee: 0
                    splitFunding:
                      - {}
                    totalAmount: 100
                  Sequence: subsequent
                  SignatureData: SignatureData
                  StoredId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                  StoredMethodUsageType: subscription
                PaypointLegalname: Sunshine Services, LLC
                PaypointDbaname: Sunshine Gutters
                ParentOrgName: PropertyManager Pro
                ParentOrgId: 123
                PaypointEntryname: d193cf9a46
                Responses:
                  - contactEmail: example@email.com
                    contactName: John Doe
                    createdAt: '2022-07-01T15:00:01Z'
                    id: 672
                    notes: any note here
                Transaction:
                  AchHolderType: personal
                  AchSecCode: AchSecCode
                  BatchAmount: 30.22
                  BatchNumber: batch_226_ach_12-30-2023
                  CfeeTransactions:
                    - transactionTime: '2024-01-15T09:30:00Z'
                  ConnectorName: gp
                  Customer:
                    AdditionalData: null
                    BillingAddress1: 1111 West 1st Street
                    BillingAddress2: Suite 200
                    BillingCity: Miami
                    BillingCountry: US
                    BillingEmail: example@email.com
                    BillingPhone: '5555555555'
                    BillingState: FL
                    BillingZip: '45567'
                    CompanyName: Sunshine LLC
                    customerId: 4440
                    CustomerNumber: 3456-7645A
                    customerStatus: 1
                    FirstName: John
                    Identifiers:
                      - firstname
                      - lastname
                      - email
                      - customId
                    LastName: Doe
                    ShippingAddress1: 123 Walnut St
                    ShippingAddress2: STE 900
                    ShippingCity: Johnson City
                    ShippingCountry: US
                    ShippingState: TN
                    ShippingZip: '37619'
                  DeviceId: 6c361c7d-674c-44cc-b790-382b75d1xxx
                  EntrypageId: 0
                  ExternalProcessorInformation: '[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]'
                  FeeAmount: 1
                  GatewayTransId: TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0
                  invoiceData:
                    AdditionalData: null
                    attachments:
                      - {}
                    company: ACME, INC
                    discount: 10
                    dutyAmount: 0
                    firstName: Chad
                    freightAmount: 10
                    frequency: onetime
                    invoiceAmount: 105
                    invoiceDate: '2025-07-01'
                    invoiceDueDate: '2025-07-01'
                    invoiceEndDate: '2025-07-01'
                    invoiceNumber: INV-2345
                    invoiceStatus: 1
                    invoiceType: 0
                    items:
                      - itemCost: 5
                        itemProductName: Materials deposit
                        itemQty: 1
                    lastName: Mercia
                    notes: Example notes.
                    paymentTerms: PIA
                    purchaseOrder: PO-345
                    shippingAddress1: 123 Walnut St
                    shippingAddress2: STE 900
                    shippingCity: Johnson City
                    shippingCountry: US
                    shippingEmail: example@email.com
                    shippingFromZip: '30040'
                    shippingPhone: '5555555555'
                    shippingState: TN
                    shippingZip: '37619'
                    summaryCommodityCode: '501718'
                    tax: 2.05
                    termsConditions: Must be paid before work scheduled.
                  Method: ach
                  NetAmount: 3762.87
                  Operation: Sale
                  OrderId: O-5140
                  OrgId: 123
                  ParentOrgName: PropertyManager Pro
                  PaymentData:
                    AccountExp: 11/29
                    accountId: accountId
                    AccountType: visa
                    AccountZip: '90210'
                    binData:
                      binMatchedLength: '6'
                      binCardBrand: Visa
                      binCardType: Credit
                      binCardCategory: PLATINUM
                      binCardIssuer: Bank of Example
                      binCardIssuerCountry: United States
                      binCardIssuerCountryCodeA2: US
                      binCardIssuerCountryNumber: '840'
                      binCardIsRegulated: 'false'
                      binCardUseCategory: Consumer
                      binCardIssuerCountryCodeA3: USA
                    HolderName: Chad Mercia
                    Initiator: payor
                    MaskedAccount: 4XXXXXXXX1111
                    orderDescription: Deposit for materials for 123 Walnut St
                    paymentDetails:
                      totalAmount: 100
                    Sequence: subsequent
                    SignatureData: SignatureData
                    StoredId: 1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440
                    StoredMethodUsageType: subscription
                  PaymentTransId: 226-fe55ec0348e34702bd91b4be198ce7ec
                  PayorId: 1551
                  PaypointDbaname: Sunshine Gutters
                  PaypointEntryname: d193cf9a46
                  PaypointId: 226
                  PaypointLegalname: Sunshine Services, LLC
                  PendingFeeAmount: 2
                  RefundId: 0
                  ResponseData:
                    authcode: authcode
                    avsresponse: avsresponse
                    avsresponse_text: avsresponse_text
                    cvvresponse: cvvresponse
                    cvvresponse_text: cvvresponse_text
                    emv_auth_response_data: emv_auth_response_data
                    orderid: O-5140
                    response: response
                    response_code: XXX
                    response_code_text: Transaction was approved.
                    responsetext: CAPTURED
                    transactionid: TRN_XXXXXGOa87juzW
                    type: type
                  ReturnedId: 0
                  ScheduleReference: 0
                  SettlementStatus: 2
                  Source: api
                  splitFundingInstructions:
                    - {}
                  splitCount: 0
                  TotalAmount: 30.22
                  TransactionEvents:
                    - {}
                  TransactionTime: '2025-10-19T00:00:00Z'
                  TransAdditionalData:
                    key: value
                  TransStatus: 1
                externalPaypointID: null
                pageidentifier: null
                messages:
                  - Id: 1
                    RoomId: 100
                    UserId: 555
                    UserName: John Admin
                    Content: Chargeback initiated by customer
                    CreatedAt: '2022-06-25T10:30:00Z'
                    MessageType: 1
                    MessageProperties:
                      status: initial
                ServiceGroup: ' '
                DisputeType: chargeback
                ProcessorName: Global Payments
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
  /ChargeBacks/getChargebackAttachments/{Id}/{fileName}:
    get:
      operationId: chargeBacks_getChargebackAttachment
      tags:
        - ChargeBacks
      x-fern-sdk-group-name: chargeBacks
      x-fern-sdk-method-name: getChargebackAttachment
      x-fern-request-name: getChargebackAttachmentRequest
      summary: Get ChargeBack attachment by fileName
      description: Retrieves a chargeback attachment file by its file name.
      security:
        - APIKeyAuth: []
      parameters:
        - name: fileName
          in: path
          description: The chargeback attachment's file name.
          required: true
          schema:
            type: string
        - name: Id
          in: path
          description: The ID of chargeback or return record.
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
components:
  schemas:
    IdempotencyKey:
      type: string
      description: |
        _Optional but recommended._ A unique ID that you can include to prevent
        duplicating objects or transactions in the case that a request is sent
        more than once. This key isn't generated in Payabli; you must generate it
        yourself. The key persists for 2 minutes. After 2 minutes, you can reuse
        the key if needed.
    AccountingField:
      type: string
      description: Optional custom field.
    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"
          }
        }
        ```
    FileContentFtype:
      type: string
      description: The MIME type of the file (if content is provided).
      enum:
        - pdf
        - doc
        - docx
        - jpg
        - jpeg
        - png
        - gif
        - txt
    FileContent:
      type: object
      description: Contains details about a file. Max upload size is 30 MB.
      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/FileContentFtype'
        furl:
          type: string
          description: Optional URL provided to show or download the file remotely.
    Attachments:
      type: array
      description: |
        Array of `fileContent` objects with attached documents. Max upload size is
        30 MB.
      items:
        $ref: '#/components/schemas/FileContent'
    ItemCommodityCode:
      type: string
      maxLength: 250
      description: Item or product commodity code. Max length of 250 characters.
    ItemDescription:
      type: string
      maxLength: 250
      description: Item or product description. Max length of 250 characters.
    ItemProductCode:
      type: string
      maxLength: 250
      description: Item or product code. Max length of 250 characters.
    ItemProductName:
      type: string
      maxLength: 250
      description: Item or product name. Max length of 250 characters.
    ItemUnitofMeasure:
      type: string
      maxLength: 100
      description: Unit of measurement. Max length of 100 characters.
    BillItem:
      type: object
      properties:
        itemCategories:
          type: array
          description: Array of tags classifying item or product.
          items:
            type: string
        itemCommodityCode:
          $ref: '#/components/schemas/ItemCommodityCode'
        itemCost:
          type: number
          format: double
          description: Item or product price per unit.
        itemDescription:
          $ref: '#/components/schemas/ItemDescription'
        itemMode:
          type: integer
          description: |
            Internal class of item or product: value `0` is only for invoices,
            `1` for bills, and `2` is common for both.
        itemProductCode:
          $ref: '#/components/schemas/ItemProductCode'
        itemProductName:
          $ref: '#/components/schemas/ItemProductName'
        itemQty:
          type: integer
          description: Quantity of item or product.
        itemTaxAmount:
          type: number
          format: double
          description: Tax amount applied to item or product.
        itemTaxRate:
          type: number
          format: double
          description: Tax rate applied to item or product.
        itemTotalAmount:
          type: number
          format: double
          description: Total amount in item or product.
        itemUnitOfMeasure:
          $ref: '#/components/schemas/ItemUnitofMeasure'
    Billitems:
      type: array
      description: Array of `LineItems` contained in bill.
      items:
        $ref: '#/components/schemas/BillItem'
    Comments:
      type: string
      maxLength: 250
      description: Any comment or description.
    Frequency:
      type: string
      description: |
        Frequency for operation. The `firstofmonth`, `fifteenthofmonth`, and `endofmonth` values are only valid on subscriptions — they aren't accepted by other endpoints (such as invoice scheduling) that use this enum.
      enum:
        - onetime
        - weekly
        - every2weeks
        - every6months
        - monthly
        - every3months
        - annually
        - firstofmonth
        - fifteenthofmonth
        - endofmonth
      x-fern-enum:
        onetime:
          name: OneTime
        firstofmonth:
          name: FirstOfMonth
        fifteenthofmonth:
          name: FifteenthOfMonth
        endofmonth:
          name: EndOfMonth
    BillOutDataScheduledOptions:
      type: object
      x-fern-availability: in-development
      description: Options for scheduled bills.
      properties:
        storedMethodId:
          type: string
          description: The ID of the stored payment method to use for the bill.
    Billstatus:
      type: integer
      description: |
        The bill's status. Values are:

        - `-99`: deleted or canceled
        - `1`: Active
        - `2`: Sent to approval
        - `5`: Partially approved
        - `11`: Rejected
        - `20`: Approved
        - `50`: Payment in transit
        - `100`: Paid
    Terms:
      type: string
      description: |
        Payment terms for invoice. If no terms are defined, then response data for
        this field defaults to `NET30`.
      enum:
        - PIA
        - CIA
        - UR
        - NET10
        - NET20
        - NET30
        - NET45
        - NET60
        - NET90
        - EOM
        - MFI
        - 5MFI
        - 10MFI
        - 15MFI
        - 20MFI
        - 2/10NET30
        - UF
        - 10UF
        - 20UF
        - 25UF
        - 50UF
      x-fern-enum:
        5MFI:
          name: FiveMfi
          description: 5th of the month following the invoice date.
        10MFI:
          name: TenMfi
          description: 10th of the month following the invoice date.
        15MFI:
          name: FifteenMfi
          description: 15th of the month following the invoice date.
        20MFI:
          name: TwentyMfi
          description: 20th of the month following the invoice date.
        2/10NET30:
          name: Two10Net30
          description: 2% discount if paid within 10 days, otherwise net 30.
        10UF:
          name: TenUf
          description: 10 day grace period under EOM.
        20UF:
          name: TwentyUf
          description: 20 day grace period under EOM.
        25UF:
          name: TwentyFiveUf
          description: 25 day grace period under EOM.
        50UF:
          name: FiftyUf
          description: 50 day grace period under EOM.
        PIA:
          description: Payment in advance.
        CIA:
          description: Cash in advance.
        UR:
          description: Upon receipt.
        NET10:
          description: 10 days after invoice date.
        NET20:
          description: 20 days after invoice date.
        NET30:
          description: 30 days after invoice date.
        NET45:
          description: 45 days after invoice date.
        NET60:
          description: 60 days after invoice date.
        NET90:
          description: 90 days after invoice date.
        EOM:
          description: Due end of this month.
        MFI:
          description: 1st of the month following the invoice date.
        UF:
          description: Under fixed terms.
    VendorNumber:
      type: string
      description: |
        Custom number identifying the vendor. Must be unique in paypoint. Can't be
        blank.
    BillOutData:
      type: object
      description: Bill payload sent when creating or updating a bill.
      properties:
        accountingField1:
          $ref: '#/components/schemas/AccountingField'
        accountingField2:
          $ref: '#/components/schemas/AccountingField'
        additionalData:
          $ref: '#/components/schemas/AdditionalDataString'
        attachments:
          $ref: '#/components/schemas/Attachments'
          description: |
            An array of bill images. Attachments aren't required, but we strongly
            recommend including them. Including a bill image can make payouts
            smoother and prevent delays. You can include either the Base64-encoded
            file content, or you can include a `furl` to a public file. The maximum
            file size for image uploads is 30 MB.

            When vendor enrichment is enabled and the first attachment is a PDF,
            the invoice is scanned and extracted vendor contact information and
            bill details (invoice number, amount due, due date) are merged into
            the request. Fields in the request body take precedence over extracted
            data. If the scan fails, bill creation proceeds with the original
            request data. See the
            [vendor enrichment guide](/guides/pay-out-vendor-enrichment-overview)
            for details. Contact Payabli to enable this feature.
        billDate:
          type: string
          format: date
          description: 'Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
        billItems:
          $ref: '#/components/schemas/Billitems'
        billNumber:
          type: string
          description: Unique identifier for the bill. Required when adding a bill.
        comments:
          $ref: '#/components/schemas/Comments'
        discount:
          type: number
          format: double
          description: Discount amount applied to the bill.
        dueDate:
          type: string
          format: date
          description: 'Due date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
        endDate:
          type: string
          format: date
          description: |
            End date for scheduled bills. Applied only in `Mode` = 1. Accepted
            formats: YYYY-MM-DD, MM/DD/YYYY.
        frequency:
          $ref: '#/components/schemas/Frequency'
        lotNumber:
          type: string
          description: Lot number associated with the bill.
        mode:
          type: integer
          description: 'Bill mode: value `0` for one-time bills, `1` for scheduled bills.'
        netAmount:
          type: number
          format: double
          description: Net amount owed in bill. Required when adding a bill.
        scheduledOptions:
          $ref: '#/components/schemas/BillOutDataScheduledOptions'
        status:
          $ref: '#/components/schemas/Billstatus'
        terms:
          $ref: '#/components/schemas/Terms'
        totalAmount:
          type: number
          format: double
          description: Total amount of the bill.
        vendor:
          type: object
          description: |
            The vendor associated with the bill. Although you can create a vendor
            in a create bill request, Payabli recommends creating a vendor
            separately and passing a valid `vendorNumber` here. At minimum, the
            `vendorNumber` is required.
          properties:
            vendorNumber:
              $ref: '#/components/schemas/VendorNumber'
    Responsecode:
      type: integer
      description: |
        Code for the response. Learn more in
        [API Response Codes](/developers/api-reference/api-responses).
    PageIdentifier:
      type: string
      description: Auxiliary validation used internally by payment pages and components.
    RoomIdNotInUse:
      type: integer
      format: int64
      description: Field not in use on this endpoint. It always returns `0`.
    IsSuccess:
      type: boolean
      description: |
        Boolean indicating whether the operation was successful. A `true` value
        indicates success. A `false` value indicates failure.
    ResponseText:
      type: string
      description: |
        Response text for operation: 'Success' or 'Declined'.
    Responsedatanonobject:
      description: The response data.
      oneOf:
        - type: string
        - type: integer
    BillResponse:
      type: object
      description: Response wrapper for bill operations.
      required:
        - responseText
      properties:
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        pageIdentifier:
          oneOf:
            - $ref: '#/components/schemas/PageIdentifier'
            - type: 'null'
        roomId:
          $ref: '#/components/schemas/RoomIdNotInUse'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          description: |
            If `isSuccess` = true, this contains the bill identifier. If
            `isSuccess` = false, this contains the reason for the error.
          $ref: '#/components/schemas/Responsedatanonobject'
    PayabliErrorBody:
      type: object
      description: |
        Shape returned by every Payabli API error response. The `responseData`
        object carries human-readable error context.
      required:
        - isSuccess
        - responseText
      properties:
        isSuccess:
          type: boolean
          description: Always `false` for error responses.
        responseCode:
          type: integer
          description: |
            Code for the response. Learn more in
            [API Response Codes](/developers/api-reference/api-responses).
        responseText:
          type: string
          description: Error text describing what went wrong.
        responseData:
          type: object
          description: Object with detailed error context.
          properties:
            explanation:
              type: string
              description: Human-readable explanation of what happened.
            todoAction:
              type: string
              description: Suggested resolution.
    BillId:
      type: integer
      format: int64
      description: |
        The bill's ID in Payabli. This value is automatically generated by Payabli
        when the bill is created.
    Email:
      type: string
      format: email
      maxLength: 320
      pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$
      description: Email address.
    Mcc:
      type: string
      description: |
        Business Merchant Category Code (MCC).
        [This resource](https://github.com/greggles/mcc-codes/blob/main/mcc_codes.csv)
        lists MCC codes.
    LocationCode:
      type: string
      description: A location code used to identify the vendor's location.
    ContactsResponse:
      type: object
      properties:
        ContactEmail:
          description: Contact email address.
          $ref: '#/components/schemas/Email'
        ContactName:
          type: string
          description: Contact name.
        ContactPhone:
          type: string
          description: Contact phone number.
        ContactTitle:
          type: string
          description: Contact title.
    VendorResponseBillingData:
      type: object
      description: Object containing vendor's bank information
      properties:
        id:
          type: integer
        accountId:
          type: string
        nickname:
          type: string
        bankName:
          type: string
        routingAccount:
          type: string
        accountNumber:
          type: string
        typeAccount:
          type: string
        bankAccountHolderName:
          type: string
        bankAccountHolderType:
          type: string
        bankAccountFunction:
          type: integer
        verified:
          type: boolean
        status:
          type: integer
        services:
          type: array
          items: {}
        default:
          type: boolean
    VendorDataResponsePaymentMethod:
      type: string
      description: Preferred payment method for vendor.
      enum:
        - vcard
        - ach
        - check
        - card
    Vendorstatus:
      type: integer
      description: |
        Vendor's status. Allowed values:

        - `0` Inactive
        - `1` Active
        - `-99` Deleted
    Vendorid:
      type: integer
      description: Payabli identifier for vendor record.
    VendorResponseSummary:
      type: object
      description: Vendor bill summary statistics
      properties:
        ActiveBills:
          type: integer
        PendingBills:
          type: integer
        InTransitBills:
          type: integer
        PaidBills:
          type: integer
        OverdueBills:
          type: integer
        ApprovedBills:
          type: integer
        DisapprovedBills:
          type: integer
        TotalBills:
          type: integer
        ActiveBillsAmount:
          type: number
          format: double
        PendingBillsAmount:
          type: number
          format: double
        InTransitBillsAmount:
          type: number
          format: double
        PaidBillsAmount:
          type: number
          format: double
        OverdueBillsAmount:
          type: number
          format: double
        ApprovedBillsAmount:
          type: number
          format: double
        DisapprovedBillsAmount:
          type: number
          format: double
        TotalBillsAmount:
          type: number
          format: double
    Remitaddress1:
      type: string
      description: |
        Remittance street address. Used for mailing paper checks. Required if any
        remittance address field is provided.
    Remitaddress2:
      type: string
      description: |
        Remittance address additional line, such as a suite or unit number. Used
        for mailing paper checks. Always optional.
    Remitcity:
      type: string
      description: |
        Remittance address city. Used for mailing paper checks. Required if any
        remittance address field is provided.
    Remitstate:
      type: string
      description: |
        Remittance address state or province. Used for mailing paper checks.
        Required if any remittance address field is provided. Must be a valid
        US state or Canadian province abbreviation.
    Remitzip:
      type: string
      description: |
        Remittance address ZIP or postal code. Used for mailing paper checks.
        Required if any remittance address field is provided. For US addresses,
        use five digits or ZIP+4 format.
    Remitcountry:
      type: string
      description: |
        Remittance address country. Used for mailing paper checks. Must be `US`
        or `CA`. Defaults to `US` if not provided.
    PayeeName:
      type: string
      description: Alternative name used to receive paper check.
    InternalReferenceId:
      type: integer
      format: int64
      description: An internal reference ID.
    AdditionalDataMap:
      type: object
      description: |
        Custom dictionary of key:value pairs. You can use this field to store any
        data related to the object or for your system.

        ```json
        {
          "additionalData": {
            "key1": "value1",
            "key2": "value2",
            "key3": "value3"
          }
        }
        ```
      additionalProperties:
        type: string
    BinData:
      type: object
      description: |-
        Object containing information related to the card. This object is `null`
        unless the payment method is card. If the payment method is Apple Pay, the
        binData will be related to the DPAN (device primary account number), not
        the card connected to Apple Pay.
      properties:
        binMatchedLength:
          type: string
          description: |-
            The number of characters from the beginning of the card number that
            were matched against a Bank Identification Number (BIN) or the Card
            Range table.
        binCardBrand:
          type: string
          description: |-
            The card brand. For example, Visa, Mastercard, American Express,
            Discover.
        binCardType:
          type: string
          description: |-
            The type of card: `Credit` or `Debit`. Case can vary between
            processors, so compare this value case-insensitively.
        binCardCategory:
          type: string
          description: 'The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked `PREPAID`.'
        binCardIssuer:
          type: string
          description: The name of the financial institution that issued the card.
        binCardIssuerCountry:
          type: string
          description: The issuing financial institution's country name.
        binCardIssuerCountryCodeA2:
          type: string
          description: The issuing financial institution's two-character ISO country code. See [this resource](https://www.iso.org/obp/ui/#search) for a list of codes.
        binCardIssuerCountryNumber:
          type: string
          description: The issuing financial institution's ISO standard numeric country code. See [this resource](https://www.iso.org/obp/ui/#search) for a list of codes.
        binCardIsRegulated:
          type: string
          description: Indicates whether the card is regulated.
        binCardUseCategory:
          type: string
          description: The use category classification for the card.
        binCardIssuerCountryCodeA3:
          type: string
          description: |-
            The issuing financial institution's three-character ISO country code.
            See [this resource](https://www.iso.org/obp/ui/#search) for a list of
            codes.
    VendorResponseStoredMethod:
      type: object
      description: Stored payment method information
      required:
        - IdPmethod
        - Method
        - Descriptor
        - MaskedAccount
        - ExpDate
        - HolderName
        - AchSecCode
        - AchHolderType
        - IsValidatedACH
        - BIN
        - binData
        - ABA
        - PostalCode
        - MethodType
        - WalletType
        - LastUpdated
        - CardUpdatedOn
      properties:
        IdPmethod:
          type:
            - string
            - 'null'
        Method:
          type:
            - string
            - 'null'
        Descriptor:
          type:
            - string
            - 'null'
        MaskedAccount:
          type:
            - string
            - 'null'
        ExpDate:
          type:
            - string
            - 'null'
        HolderName:
          type:
            - string
            - 'null'
        AchSecCode:
          type:
            - string
            - 'null'
        AchHolderType:
          type:
            - string
            - 'null'
        IsValidatedACH:
          type:
            - boolean
            - 'null'
        BIN:
          type:
            - string
            - 'null'
        binData:
          oneOf:
            - $ref: '#/components/schemas/BinData'
            - type: 'null'
        ABA:
          type:
            - string
            - 'null'
        PostalCode:
          type:
            - string
            - 'null'
        MethodType:
          type:
            - string
            - 'null'
        WalletType:
          type:
            - string
            - 'null'
          description: Digital wallet type if applicable.
        LastUpdated:
          type:
            - string
            - 'null'
          format: date-time
        CardUpdatedOn:
          type:
            - string
            - 'null'
          format: date-time
          description: Date and time the card was last updated.
    VendorDataResponse:
      type: object
      required:
        - VendorNumber
        - Name1
        - Name2
        - EIN
        - Phone
        - Email
        - Address1
        - Address2
        - City
        - State
        - Zip
        - Country
        - Mcc
        - LocationCode
        - Contacts
        - BillingData
        - PaymentMethod
        - VendorStatus
        - VendorId
        - Summary
        - PaypointLegalname
        - PaypointDbaname
        - PaypointEntryname
        - ParentOrgName
        - ParentOrgId
        - CreatedDate
        - LastUpdated
        - remitAddress1
        - remitAddress2
        - remitCity
        - remitState
        - remitZip
        - remitCountry
        - payeeName1
        - payeeName2
        - customField1
        - customField2
        - InternalReferenceId
        - additionalData
        - externalPaypointID
        - StoredMethods
      properties:
        VendorNumber:
          $ref: '#/components/schemas/VendorNumber'
        Name1:
          type: string
          description: Primary name for vendor.
        Name2:
          type: string
          description: Secondary name for vendor.
        EIN:
          type: string
          description: 'EIN/Tax ID for vendor. In responses, this field is masked, and looks like: `"ein": "XXXXX6789"`.'
        Phone:
          type: string
          description: Vendor's phone number.
        Email:
          $ref: '#/components/schemas/Email'
        RemitEmail:
          type: string
          description: Email address for remittance
        Address1:
          type: string
          description: Vendor's address.
        Address2:
          type: string
          description: Additional line for vendor's address.
        City:
          type: string
          description: Vendor's city.
        State:
          type: string
          description: Vendor's state. Must be a two-character state code.
        Zip:
          type: string
          description: Vendor's zip code.
        Country:
          type: string
          description: Vendor's country. Payabli supports only US and Canadian vendors.
        Mcc:
          $ref: '#/components/schemas/Mcc'
        LocationCode:
          $ref: '#/components/schemas/LocationCode'
        Contacts:
          type: array
          items:
            $ref: '#/components/schemas/ContactsResponse'
          description: Array of objects describing the vendor's contacts.
        BillingData:
          description: Object containing vendor's bank information.
          $ref: '#/components/schemas/VendorResponseBillingData'
        PaymentMethod:
          description: Preferred payment method for vendor.
          $ref: '#/components/schemas/VendorDataResponsePaymentMethod'
        VendorStatus:
          $ref: '#/components/schemas/Vendorstatus'
        VendorId:
          $ref: '#/components/schemas/Vendorid'
        EnrollmentStatus:
          type: string
          description: Vendor enrollment status
        Summary:
          description: Vendor bill summary statistics
          $ref: '#/components/schemas/VendorResponseSummary'
        PaypointLegalname:
          type: string
          description: Legal name of the paypoint
        PaypointDbaname:
          type: string
          description: DBA name of the paypoint
        PaypointEntryname:
          type: string
          description: Entry name of the paypoint
        ParentOrgName:
          type: string
          description: Name of the parent organization
        ParentOrgId:
          type: integer
          description: ID of the parent organization
        CreatedDate:
          type: string
          format: date-time
          description: Date when vendor was created
        LastUpdated:
          type: string
          format: date-time
          description: Date when vendor was last updated
        remitAddress1:
          $ref: '#/components/schemas/Remitaddress1'
        remitAddress2:
          $ref: '#/components/schemas/Remitaddress2'
        remitCity:
          $ref: '#/components/schemas/Remitcity'
        remitState:
          $ref: '#/components/schemas/Remitstate'
        remitZip:
          $ref: '#/components/schemas/Remitzip'
        remitCountry:
          $ref: '#/components/schemas/Remitcountry'
        payeeName1:
          $ref: '#/components/schemas/PayeeName'
        payeeName2:
          $ref: '#/components/schemas/PayeeName'
        customField1:
          type: string
          description: Custom field 1 for vendor
        customField2:
          type: string
          description: Custom field 2 for vendor
        customerVendorAccount:
          type: string
          description: Account number of paypoint in the Vendor side.
        InternalReferenceId:
          $ref: '#/components/schemas/InternalReferenceId'
        additionalData:
          $ref: '#/components/schemas/AdditionalDataMap'
        externalPaypointID:
          type: string
          description: External paypoint identifier
        StoredMethods:
          type: array
          items:
            $ref: '#/components/schemas/VendorResponseStoredMethod'
          description: Array of stored payment methods for vendor
    CreatedAt:
      type: string
      format: date-time
      description: Timestamp of when record was created, in UTC.
    LastModified:
      type: string
      format: date-time
      description: Timestamp of when record was last updated, in UTC.
    AdditionalData:
      type: object
      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"
          }
        }
        ```
      additionalProperties:
        type: object
        additionalProperties: {}
    AddressNullable:
      type: string
      description: The address.
    AddressAddtlNullable:
      type: string
      description: Additional line for the address.
    AccountId:
      type: string
      description: Custom identifier for payment connector.
    BankName:
      type: string
      description: Name of bank for account.
    RoutingAccount:
      type: string
      description: Routing number of bank account.
    AccountNumber:
      type: string
      description: Account number for bank account. This value is returned masked in responses.
    TypeAccount:
      type: string
      description: 'Type of bank account: Checking or Savings.'
      enum:
        - Checking
        - Savings
    BankAccountHolderName:
      type: string
      description: The accountholder's name.
    BankAccountHolderType:
      type: string
      description: Describes whether the bank is a personal or business account.
      enum:
        - Personal
        - Business
    BillingDataResponse:
      type: object
      required:
        - id
        - nickname
        - bankName
        - routingAccount
        - accountNumber
        - typeAccount
        - bankAccountHolderName
        - bankAccountHolderType
        - bankAccountFunction
        - verified
        - status
        - services
        - default
      properties:
        id:
          type: integer
          description: The bank's ID in Payabli.
        accountId:
          description: An identifier for the bank account. 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. If a duplicate exists within the same service at the paypoint, a numeric suffix is appended, such as `-2`. This value is also used as the identifier for the bank account's associated payment connector.
          $ref: '#/components/schemas/AccountId'
        nickname:
          type: string
        bankName:
          $ref: '#/components/schemas/BankName'
        routingAccount:
          $ref: '#/components/schemas/RoutingAccount'
        accountNumber:
          $ref: '#/components/schemas/AccountNumber'
        typeAccount:
          $ref: '#/components/schemas/TypeAccount'
        bankAccountHolderName:
          $ref: '#/components/schemas/BankAccountHolderName'
        bankAccountHolderType:
          $ref: '#/components/schemas/BankAccountHolderType'
        bankAccountFunction:
          type: integer
          description: |-
            Describes whether the bank account is used for deposits or withdrawals in Payabli:
              - `0`: Deposit
              - `1`: Withdrawal
              - `2`: Deposit and withdrawal
        verified:
          type: boolean
        status:
          type: integer
        services:
          type: array
          items: {}
        default:
          type: boolean
    CityNullable:
      type: string
      description: The city.
    Ein:
      type: string
      description: Business EIN or tax ID. This value is masked in API responses.
    EnrollmentStatus:
      type: string
      description: Enrollment status of vendor in payables program.
    ExternalPaypointId:
      type: string
      description: |
        A custom identifier for the paypoint, if applicable.
    OrgParentName:
      type: string
      description: The name of the parent organization.
    OrgParentId:
      type: integer
      format: int64
      description: The ID of the org's parent organization.
    VendorPaymentMethodString:
      type: string
      description: |
        The vendor's preferred payment method. Can be one of:

        - `managed` — Managed payment method
        - `vcard` — Virtual card payment method
        - `check` — Check payment method
        - `ach` — ACH payment method
    Dbaname:
      type: string
      description: |
        The alternate or common name that this business is doing business under,
        usually referred to as a DBA name.
    Entrypointfield:
      type: string
      maxLength: 50
      description: The entrypoint identifier.
    Legalname:
      type: string
      description: Business legal name.
    RemitEmail:
      type: string
      format: email
      description: |
        Remittance email address. Used for sending virtual cards and other
        information about payouts.
    StateNullable:
      type: string
      description: The state or province.
    VendorSummary:
      type: object
      properties:
        ActiveBills:
          type: integer
        PendingBills:
          type: integer
        InTransitBills:
          type: integer
        PaidBills:
          type: integer
        OverdueBills:
          type: integer
        ApprovedBills:
          type: integer
        DisapprovedBills:
          type: integer
        TotalBills:
          type: integer
        ActiveBillsAmount:
          type: number
          format: double
        PendingBillsAmount:
          type: number
          format: double
        InTransitBillsAmount:
          type: number
          format: double
        PaidBillsAmount:
          type: number
          format: double
        OverdueBillsAmount:
          type: number
          format: double
        ApprovedBillsAmount:
          type: number
          format: double
        DisapprovedBillsAmount:
          type: number
          format: double
        TotalBillsAmount:
          type: number
          format: double
    Zip:
      type: string
      description: ZIP code for address.
    VendorQueryRecord:
      type: object
      properties:
        additionalData:
          $ref: '#/components/schemas/AdditionalData'
        Address1:
          $ref: '#/components/schemas/AddressNullable'
        Address2:
          $ref: '#/components/schemas/AddressAddtlNullable'
        BillingData:
          $ref: '#/components/schemas/BillingDataResponse'
        City:
          $ref: '#/components/schemas/CityNullable'
        Contacts:
          $ref: '#/components/schemas/ContactsResponse'
        Country:
          type: string
        CreatedDate:
          $ref: '#/components/schemas/CreatedAt'
        customerVendorAccount:
          type: string
        customField1:
          type: string
        customField2:
          type: string
        EIN:
          $ref: '#/components/schemas/Ein'
        Email:
          $ref: '#/components/schemas/Email'
        EnrollmentStatus:
          $ref: '#/components/schemas/EnrollmentStatus'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        InternalReferenceId:
          $ref: '#/components/schemas/InternalReferenceId'
        LastUpdated:
          $ref: '#/components/schemas/LastModified'
        LocationCode:
          type: string
        Mcc:
          $ref: '#/components/schemas/Mcc'
        Name1:
          type: string
        Name2:
          type: string
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        ParentOrgId:
          $ref: '#/components/schemas/OrgParentId'
        payeeName1:
          $ref: '#/components/schemas/PayeeName'
        payeeName2:
          $ref: '#/components/schemas/PayeeName'
        PaymentMethod:
          $ref: '#/components/schemas/VendorPaymentMethodString'
        PaypointDbaname:
          $ref: '#/components/schemas/Dbaname'
        PaypointEntryname:
          $ref: '#/components/schemas/Entrypointfield'
        PaypointLegalname:
          $ref: '#/components/schemas/Legalname'
        Phone:
          type: string
        remitAddress1:
          $ref: '#/components/schemas/Remitaddress1'
        remitAddress2:
          $ref: '#/components/schemas/Remitaddress2'
        remitCity:
          $ref: '#/components/schemas/Remitcity'
        remitCountry:
          $ref: '#/components/schemas/Remitcountry'
        RemitEmail:
          $ref: '#/components/schemas/RemitEmail'
        remitState:
          $ref: '#/components/schemas/Remitstate'
        remitZip:
          $ref: '#/components/schemas/Remitzip'
        State:
          $ref: '#/components/schemas/StateNullable'
        StoredMethods:
          type: array
          items:
            $ref: '#/components/schemas/VendorResponseStoredMethod'
        Summary:
          $ref: '#/components/schemas/VendorSummary'
        VendorId:
          $ref: '#/components/schemas/Vendorid'
        VendorNumber:
          $ref: '#/components/schemas/VendorNumber'
        VendorStatus:
          $ref: '#/components/schemas/Vendorstatus'
        Zip:
          $ref: '#/components/schemas/Zip'
        PaymentPortalUrl:
          type: string
          description: URL for the vendor's online payment portal, if known. Populated by the vendor enrichment pipeline.
        CardAccepted:
          type: string
          description: Whether the vendor accepts card payments. Values are `yes`, `no`, or `unable to determine`. Populated by the vendor enrichment pipeline.
        AchAccepted:
          type: string
          description: Whether the vendor accepts ACH payments. Values are `yes`, `no`, or `unable to determine`. Populated by the vendor enrichment pipeline.
        EnrichmentStatus:
          type: string
          description: Current enrichment state of the vendor. Values are `not_enriched`, `partially_enriched`, `fully_enriched`, or `fallback_applied`.
        EnrichedBy:
          type: string
          description: Which enrichment method resolved the vendor's payment acceptance info. Values are `invoice_scan`, `web_search`, `vendor_network`, or `manual`.
        EnrichedAt:
          type: string
          format: date-time
          description: When the vendor was last enriched (UTC).
        EnrichmentId:
          type: string
          description: Identifier for the enrichment request that last updated this vendor.
    Netamountnullable:
      type: number
      format: double
      description: Net amount.
    FeeAmount:
      type: number
      format: double
      description: Service fee or sub-charge applied.
    Source:
      type: string
      maxLength: 100
      description: Custom identifier to indicate the transaction or request source.
    Orgid:
      type: integer
      format: int64
      description: Organization ID. Unique identifier assigned to an org by Payabli.
    PaymentIdString:
      type: string
      description: |
        The unique transaction ID. This value is a string representation of a
        long integer.
    Accountexp:
      type: string
      description: Expiration date of card used in transaction.
    Accounttype:
      type: string
      description: Bank account type or card brand.
    Accountzip:
      type: string
      description: ZIP code for card used in transaction.
    Holdername:
      type: string
      description: The cardholder name.
    Initiator:
      type: string
      description: |
        The transaction's initiator. Indicates who initiated the transaction.
    Maskedaccount:
      type: string
      description: |
        Masked card or bank account used in transaction. In the case of Apple
        Pay, this is a masked DPAN (device primary account number).
    Orderdescription:
      type: string
      maxLength: 250
      description: Text description of the transaction.
    PaymentCategories:
      type: object
      required:
        - amount
        - label
      properties:
        amount:
          type: number
          format: double
          description: Price/cost per unit of item or category.
        description:
          type: string
          description: Description of item or category
        label:
          type: string
          description: Name of item or category.
        qty:
          type: integer
          description: Quantity of item or category
          default: 1
    SplitFundingContent:
      type: object
      properties:
        accountId:
          type: string
          description: The accountId for the account the split should be sent to.
        amount:
          type: number
          format: double
          description: Amount from the transaction to send to this recipient.
        description:
          type: string
          description: A description for the split.
        recipientEntryPoint:
          type: string
          description: The entrypoint the split should be sent to.
    SplitFunding:
      type: array
      items:
        $ref: '#/components/schemas/SplitFundingContent'
      description: Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
    PaymentDetail:
      type: object
      description: Details about the payment.
      required:
        - totalAmount
      properties:
        categories:
          type: array
          items:
            $ref: '#/components/schemas/PaymentCategories'
          description: |-
            Array of payment categories/line items describing the amount to be paid.
            **Note**: These categories are for information only and aren't validated against the total amount provided.
        checkImage:
          type: object
          additionalProperties: {}
          description: Object containing image of paper check.
        checkNumber:
          type: string
          description: A check number to be used in the ach transaction. **Required** for payment method = 'check'.
        currency:
          type: string
          description: The currency for the transaction, `USD` or `CAD`. If your paypoint is configured for CAD, you must send the `CAD` value in this field, otherwise it defaults to USD, which will cause the transaction to fail.
        serviceFee:
          type: number
          format: double
          description: Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually.
        splitFunding:
          description: Split funding instructions for the transaction. See [Split a Transaction](/developers/developer-guides/money-in-split-funding) for more.
          $ref: '#/components/schemas/SplitFunding'
        checkUniqueId:
          type: string
          description: Unique identifier for a processed check image. Required for RDC (Remote Deposit Capture) transactions where `achCode` is `BOC`. Use the `id` value from the [check processing](/developers/api-reference/moneyin/check-capture) response.
        totalAmount:
          type: number
          format: double
          description: Total amount to be charged. If a service fee is sent, then this amount should include the service fee."
    Sequence:
      type: string
      description: |
        The order of the transaction for cardholder-initiated transaction (CIT)
        and merchant-initiated transaction (MIT) purposes. This field is
        automatically detected and populated by Payabli.

        Available values:

        - `first`: The first use of the payment method. This is almost always
          a cardholder-initiated transaction.
        - `subsequent`: For merchant-initiated transactions after the first use
          of the payment method.

        See
        [Understanding CIT and MIT Indicators](/guides/pay-in-transactions-cit-mit-overview)
        for more information.
    Signaturedata:
      type: string
    Storedmethodid:
      type: string
      description: |
        Payabli identifier of a tokenized payment method. If this field is
        used in a request, the `method` field is overridden and the payment
        is made using the payment token.
    StoredMethodUsageType:
      type: string
      description: |
        **Strongly recommended.** The usage type for the stored method, used
        for merchant-initiated transactions (MIT). If you don't specify a
        value, Payabli defaults to `unscheduled`.

        Available values:

        - `unscheduled`: One-time or otherwise not pre-scheduled.
        - `subscription`: Subscription payments. For example, monthly rental
          fees or ongoing service subscriptions.
        - `recurring`: Recurring payments per a set plan. For example,
          splitting an HOA special assessment over 6 monthly payments.

        See
        [Understanding CIT and MIT Indicators](/guides/pay-in-transactions-cit-mit-overview)
        for more information.
    QueryPaymentData:
      type: object
      properties:
        AccountExp:
          $ref: '#/components/schemas/Accountexp'
        accountId:
          $ref: '#/components/schemas/AccountId'
        AccountType:
          $ref: '#/components/schemas/Accounttype'
        AccountZip:
          $ref: '#/components/schemas/Accountzip'
        binData:
          $ref: '#/components/schemas/BinData'
        HolderName:
          $ref: '#/components/schemas/Holdername'
        Initiator:
          $ref: '#/components/schemas/Initiator'
        MaskedAccount:
          $ref: '#/components/schemas/Maskedaccount'
        orderDescription:
          $ref: '#/components/schemas/Orderdescription'
        paymentDetails:
          $ref: '#/components/schemas/PaymentDetail'
        Sequence:
          $ref: '#/components/schemas/Sequence'
        SignatureData:
          $ref: '#/components/schemas/Signaturedata'
        StoredId:
          description: Identifier of stored payment method used in transaction.
          $ref: '#/components/schemas/Storedmethodid'
        StoredMethodUsageType:
          $ref: '#/components/schemas/StoredMethodUsageType'
    InvoiceNumber:
      type: string
      description: Invoice number. Identifies the invoice under a paypoint.
    NetAmountstring:
      type: string
      description: Net amount owed in bill. Required when adding a bill.
    BillPayOutData:
      type: object
      required:
        - dueDate
        - invoiceDate
      properties:
        billId:
          type: integer
          format: int64
          description: Bill ID in Payabli.
        comments:
          description: Any comments about bill. **For managed payouts, this field has a limit of 100 characters**.
          $ref: '#/components/schemas/Comments'
        dueDate:
          type:
            - string
            - 'null'
          format: date
          description: Bill due date in format YYYY-MM-DD or MM/DD/YYYY.
        invoiceDate:
          type:
            - string
            - 'null'
          format: date
          description: Bill date in format YYYY-MM-DD or MM/DD/YYYY.
        invoiceNumber:
          description: Custom number identifying the bill. Must be unique in paypoint. **Required** for new bill and when `billId` isn't provided.
          $ref: '#/components/schemas/InvoiceNumber'
        netAmount:
          description: Net Amount owed in bill. Required when adding a bill.
          $ref: '#/components/schemas/NetAmountstring'
        discount:
          type: string
          description: Bill discount amount.
        Terms:
          description: Description of payment terms.
          $ref: '#/components/schemas/Terms'
        AccountingField1:
          $ref: '#/components/schemas/AccountingField'
        AccountingField2:
          $ref: '#/components/schemas/AccountingField'
        AdditionalData:
          $ref: '#/components/schemas/AdditionalDataString'
        attachments:
          description: Bill image attachment. Send the bill image as Base64-encoded string, or as a publicly accessible link. For full details on using this field with a payout authorization, see [the documentation](/developers/developer-guides/pay-out-manage-payouts).
          $ref: '#/components/schemas/Attachments'
    QueryTransactionEventsEventData:
      description: |
        Any data associated to the event received from processor. Contents vary
        by event type.
      oneOf:
        - type: object
          additionalProperties: {}
        - type: string
    QueryTransactionEvents:
      type: object
      properties:
        EventData:
          description: Any data associated to the event received from processor. Contents vary by event type.
          $ref: '#/components/schemas/QueryTransactionEventsEventData'
        EventTime:
          type: string
          format: date-time
          description: Date and time of event.
        TransEvent:
          type: string
          description: Event descriptor. See [TransEvent Reference](/guides/pay-in-transevents-reference) for more details.
    Gatewayfield:
      type: string
      description: |
        The payment gateway used to process the transaction.
    HasVcardTransactions:
      type: boolean
      description: |
        When `true`, indicates that the paypoint has vCard transactions.
    IsSameDayACH:
      type: boolean
      x-fern-availability: in-development
      description: |
        When `true`, this is a same-day ACH transaction.
    ScheduleId:
      type: integer
      format: int64
      x-fern-availability: in-development
      description: ID of the recurring payment schedule associated with the transaction.
    SettlementStatusPayout:
      type: string
      description: |
        The settlement status of the payout transaction. See
        [Payout Transaction Statuses](/guides/money-out-statuses#payout-transaction-statuses)
        for a full reference.
    RiskFlagged:
      type: boolean
      description: Indicates if the transaction was flagged for risk.
    RiskFlaggedOn:
      type: string
      format: date-time
      description: Timestamp when the transaction was flagged for risk.
    RiskStatus:
      type: string
      description: Current risk status of the transaction.
    RiskReason:
      type: string
      description: Reason for risk flagging.
    RiskAction:
      type: string
      description: Action taken due to risk assessment.
    RiskActionCode:
      type: integer
      description: Numeric code representing the risk action.
    PayoutProgram:
      type: string
      x-fern-availability: in-development
      description: |
        The payout program associated with the transaction: managed or on-demand.
    TransactionOutQueryRecord:
      type: object
      properties:
        IdOut:
          type: integer
          format: int64
          description: Identifier of payout transaction.
        CreatedAt:
          $ref: '#/components/schemas/CreatedAt'
        Comments:
          description: Any comment or description for payout transaction.
          $ref: '#/components/schemas/Comments'
        Vendor:
          description: Vendor related to the payout transaction.
          $ref: '#/components/schemas/VendorQueryRecord'
        PaypointDbaname:
          $ref: '#/components/schemas/Dbaname'
        PaypointLegalname:
          $ref: '#/components/schemas/Legalname'
        Status:
          type: integer
          description: Internal status of transaction.
        LastUpdated:
          description: Timestamp when payment record was updated, in UTC.
          $ref: '#/components/schemas/LastModified'
        TotalAmount:
          type: number
          format: double
          description: Transaction total amount (including service fee or sub-charge).
        NetAmount:
          $ref: '#/components/schemas/Netamountnullable'
        FeeAmount:
          $ref: '#/components/schemas/FeeAmount'
        Source:
          $ref: '#/components/schemas/Source'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        ParentOrgId:
          $ref: '#/components/schemas/Orgid'
        BatchNumber:
          type: string
          description: The batch number for the payout transaction.
        PaymentStatus:
          type: string
          description: Status of payout transaction.
        PaymentMethod:
          type: string
          description: Method of payment applied to the transaction.
        CardToken:
          type: string
          x-fern-availability: in-development
        CheckNumber:
          type: string
          description: Paper check number related to payout transaction.
        CheckData:
          description: Object referencing to paper check image.
          $ref: '#/components/schemas/FileContent'
        PaymentId:
          $ref: '#/components/schemas/PaymentIdString'
        PaymentData:
          $ref: '#/components/schemas/QueryPaymentData'
        Bills:
          type: array
          items:
            $ref: '#/components/schemas/BillPayOutData'
          description: Bills associated with this transaction.
        Events:
          type: array
          items:
            $ref: '#/components/schemas/QueryTransactionEvents'
          description: Events associated with this transaction.
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        EntryName:
          $ref: '#/components/schemas/Entrypointfield'
        Gateway:
          $ref: '#/components/schemas/Gatewayfield'
        BatchId:
          type: string
          description: ID of the batch the transaction belongs to.
        HasVcardTransactions:
          $ref: '#/components/schemas/HasVcardTransactions'
          x-fern-availability: in-development
        IsSameDayACH:
          $ref: '#/components/schemas/IsSameDayACH'
          x-fern-availability: in-development
        ScheduleId:
          $ref: '#/components/schemas/ScheduleId'
          x-fern-availability: in-development
        SettlementStatus:
          $ref: '#/components/schemas/SettlementStatusPayout'
        RiskFlagged:
          $ref: '#/components/schemas/RiskFlagged'
        RiskFlaggedOn:
          $ref: '#/components/schemas/RiskFlaggedOn'
        RiskStatus:
          $ref: '#/components/schemas/RiskStatus'
        RiskReason:
          $ref: '#/components/schemas/RiskReason'
        RiskAction:
          $ref: '#/components/schemas/RiskAction'
        RiskActionCode:
          $ref: '#/components/schemas/RiskActionCode'
        PayoutProgram:
          $ref: '#/components/schemas/PayoutProgram'
          x-fern-availability: in-development
    GeneralEvents:
      type: object
      properties:
        description:
          type: string
          description: Event description.
        eventTime:
          type: string
          format: date-time
          description: Event timestamp, in UTC.
        extraData:
          type:
            - string
            - 'null'
          description: Extra data.
        refData:
          type: string
          description: Reference data.
        source:
          description: The event source.
          $ref: '#/components/schemas/Source'
    BillEvents:
      type: array
      items:
        $ref: '#/components/schemas/GeneralEvents'
      description: Array of event objects with information related to events associated to the invoice.
    BillQueryRecord2BillApprovalsItem:
      type: object
      required:
        - approvedTime
      properties:
        approved:
          type: integer
          description: Indicates whether the bill has been approved. `0` is false, and `1` is true.
        approvedTime:
          type:
            - string
            - 'null'
          format: date-time
          description: Timestamp of when the approval was made, in UTC.
        comments:
          type: string
          description: Additional comments on the approval.
        email:
          description: The approving user's email address.
          $ref: '#/components/schemas/Email'
        Id:
          type: integer
          format: int64
          description: The approving user's ID.
    BillApprovals:
      type: array
      items:
        $ref: '#/components/schemas/BillQueryRecord2BillApprovalsItem'
      description: Approvals associated with the bill.
    PaylinkId:
      type: string
      description: Identifier of payment link associated to the invoice or bill.
    PairFiles:
      type: object
      properties:
        originalName:
          type: string
          description: Original filename
        zipName:
          type: string
          description: Filename assigned to zipped file. This is the name to use for reference in the API functions to get files in attachments.
        descriptor:
          type: string
          description: Descriptor of the file.
    DocumentsRef:
      type: object
      properties:
        filelist:
          type: array
          items:
            $ref: '#/components/schemas/PairFiles'
          description: Array of objects describing files contained in the ZIP file.
        zipfile:
          type: string
          description: Zip file containing attachments.
    EntityId:
      type: integer
      format: int64
      description: |
        The entity's ID in Payabli. If the entity is a paypoint, this is the
        paypoint ID. If the entity is an organization, this is the organization
        ID.
    BillResponseData:
      type: object
      required:
        - BillDate
        - DueDate
        - EndDate
      properties:
        IdBill:
          $ref: '#/components/schemas/BillId'
        BillNumber:
          type: string
          description: Unique identifier for the bill.
        NetAmount:
          type: number
          format: double
          description: Net amount owed in bill.
        Discount:
          type: number
          format: double
          description: Bill discount amount.
        TotalAmount:
          type: number
          format: double
          description: Total amount for the bill.
        BillDate:
          type:
            - string
            - 'null'
          format: date
          description: 'Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY'
        DueDate:
          type:
            - string
            - 'null'
          format: date
          description: 'Due Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY'
        Comments:
          type: string
          description: Comments associated with the bill. For managed payables, the character limit is 200. For on demand payouts, the characters limit is 250.
        BatchNumber:
          type: string
          description: The batch number that the bill belongs to.
        BillItems:
          description: Array of `LineItems` contained in bill.
          $ref: '#/components/schemas/Billitems'
        Mode:
          type: integer
          description: 'Bill mode: value `0` for single/one-time bills, `1` for scheduled bills.'
        PaymentMethod:
          type: string
          description: Payment method used for the bill.
        PaymentId:
          type: string
          description: Payment ID associated with the bill.
        AccountingField1:
          $ref: '#/components/schemas/AccountingField'
        AccountingField2:
          $ref: '#/components/schemas/AccountingField'
        Terms:
          $ref: '#/components/schemas/Terms'
        Source:
          type: string
          description: The source of the bill, such as "API" or "UI".
        AdditionalData:
          $ref: '#/components/schemas/AdditionalDataString'
        Vendor:
          $ref: '#/components/schemas/VendorDataResponse'
        Status:
          $ref: '#/components/schemas/Billstatus'
        CreatedAt:
          $ref: '#/components/schemas/CreatedAt'
        EndDate:
          type:
            - string
            - 'null'
          format: date
          description: End date for scheduled bills. Applied only in `Mode` = 1.
        LastUpdated:
          $ref: '#/components/schemas/LastModified'
        Frequency:
          description: Frequency for scheduled bills. Applied only in `Mode` = 1.
          $ref: '#/components/schemas/Frequency'
        Transaction:
          description: MoneyOut transaction associated to the bill
          $ref: '#/components/schemas/TransactionOutQueryRecord'
        billEvents:
          $ref: '#/components/schemas/BillEvents'
        billApprovals:
          $ref: '#/components/schemas/BillApprovals'
        PaypointLegalname:
          $ref: '#/components/schemas/Legalname'
        PaypointDbaname:
          $ref: '#/components/schemas/Dbaname'
        ParentOrgId:
          $ref: '#/components/schemas/OrgParentId'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        PaypointEntryname:
          $ref: '#/components/schemas/Entrypointfield'
        paylinkId:
          $ref: '#/components/schemas/PaylinkId'
        DocumentsRef:
          description: Object with the attached documents.
          $ref: '#/components/schemas/DocumentsRef'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        LotNumber:
          type: string
          description: Lot number of the bill.
        EntityID:
          $ref: '#/components/schemas/EntityId'
    GetBillResponse:
      type: object
      description: A successful response returns a bill object with all its details. If the bill isn't found, the response will contain an error message.
      required:
        - responseText
      properties:
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        roomId:
          $ref: '#/components/schemas/RoomIdNotInUse'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          $ref: '#/components/schemas/BillResponseData'
    EditBillResponse:
      type: object
      description: Response wrapper for the Update bill endpoint.
      required:
        - responseText
      properties:
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        pageIdentifier:
          oneOf:
            - $ref: '#/components/schemas/PageIdentifier'
            - type: 'null'
        roomId:
          $ref: '#/components/schemas/RoomIdNotInUse'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          type: integer
          description: |
            If `isSuccess` = true, this contains the bill identifier. If
            `isSuccess` = false, this contains the reason for the error.
    PayabliApiResponseGeneric2Part:
      type: object
      description: |
        Minimal response wrapper used by approval-style endpoints that don't carry
        the standard response envelope.
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    ModifyApprovalBillResponse:
      description: Response from approval-modification endpoints.
      allOf:
        - $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
        - type: object
          properties:
            responseData:
              type: integer
              description: |
                If `isSuccess` = true, this contains the bill identifier. If
                `isSuccess` = false, this contains the reason for the error.
    SetApprovedBillResponse:
      description: Response from the Approve or disapprove a bill endpoint.
      allOf:
        - $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
        - type: object
          properties:
            responseData:
              type: integer
              description: |
                If `isSuccess` = true, this contains the bill identifier. If
                `isSuccess` = false, this contains the reason for the error.
    ExportFormat:
      type: string
      description: |
        Export format for file downloads. When specified, returns data as a file
        instead of JSON.
      enum:
        - csv
        - xlsx
      x-fern-enum:
        csv:
          description: Comma-separated values file.
        xlsx:
          description: Excel spreadsheet file.
    Pagesize:
      type: integer
      description: Number of records on each response page.
    Totalpages:
      type: integer
      description: Total number of pages in response.
    Totalrecords:
      type: integer
      description: Total number of records in response.
    BillQueryResponseSummary:
      type: object
      properties:
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
        pageSize:
          $ref: '#/components/schemas/Pagesize'
        total2approval:
          type: integer
        totalactive:
          type: integer
        totalAmount:
          type: number
          format: double
          description: Total amount of bills in response.
        totalamount2approval:
          type: number
          format: double
        totalamountactive:
          type: number
          format: double
        totalamountapproved:
          type: number
          format: double
          description: The total amount of approved bills.
        totalamountcancel:
          type: number
          format: double
        totalamountdisapproved:
          type: number
          format: double
          description: The total amount of disapproved bills.
        totalamountintransit:
          type: number
          format: double
        totalamountoverdue:
          type: number
          format: double
          description: The total amount of bills that are overdue.
        totalamountpaid:
          type: number
          format: double
          description: The total amount of paid bills.
        totalamountsent2approval:
          type: number
          format: double
        totalapproved:
          type: integer
          description: The total number of bills that were approved.
        totalcancel:
          type: integer
        totaldisapproved:
          type: integer
          description: The number of bills that were disapproved.
        totalintransit:
          type: integer
        totaloverdue:
          type: integer
          description: The number of bills that are overdue.
        totalPages:
          $ref: '#/components/schemas/Totalpages'
        totalpaid:
          type: integer
          description: The total number of paid bills.
        totalRecords:
          $ref: '#/components/schemas/Totalrecords'
        totalsent2approval:
          type: integer
    BillQueryRecord2PaymentMethod:
      type: string
      description: Preferred payment method used.
      enum:
        - vcard
        - ach
        - check
        - card
        - managed
    BillingData:
      type: object
      properties:
        accountNumber:
          type: string
          description: Account number for bank account.
        bankAccountFunction:
          type: integer
          description: |-
            Describes whether the bank account is used for deposits or withdrawals in Payabli:
              - `0`: Deposit
              - `1`: Withdrawal
              - `2`: Deposit and withdrawal
        bankAccountHolderName:
          $ref: '#/components/schemas/BankAccountHolderName'
        bankAccountHolderType:
          $ref: '#/components/schemas/BankAccountHolderType'
        bankName:
          $ref: '#/components/schemas/BankName'
        id:
          type: integer
          description: The bank's ID in Payabli.
        routingAccount:
          $ref: '#/components/schemas/RoutingAccount'
        typeAccount:
          $ref: '#/components/schemas/TypeAccount'
    Contacts:
      type: object
      properties:
        contactEmail:
          description: Contact email address.
          $ref: '#/components/schemas/Email'
        contactName:
          type: string
          description: Contact name.
        contactPhone:
          type: string
          description: Contact phone number.
        contactTitle:
          type: string
          description: Contact title.
        additionalData:
          $ref: '#/components/schemas/AdditionalDataString'
    ContactsField:
      type: array
      items:
        $ref: '#/components/schemas/Contacts'
      description: List of contacts.
    VendorPaymentMethod:
      type: object
      description: |-
        Payment method object to use for the payout.
        - `{ method: "managed" }` - Managed payment method
        - `{ method: "vcard" }` - Virtual card payment method
        - `{ method: "check" }` - Check payment method
        - `{ method: "ach", storedMethodId?: "..." }` - ACH payment method with optional stored method ID
      required:
        - method
      properties:
        method:
          type: string
          description: Payment method type - "managed", "vcard", "check", or "ach"
        storedMethodId:
          type: string
          description: ID of the stored ACH payment method. Only applicable when method is "ach". Required when using a previously saved ACH method when the vendor has more than one saved method. See the [Payouts with saved ACH payment methods](/developers/developer-guides/pay-out-manage-payouts) section for more details.
    VendorOutData:
      type: object
      required:
        - City
        - Country
        - EIN
        - Name1
        - Phone
        - State
        - Zip
      properties:
        additionalData:
          $ref: '#/components/schemas/AdditionalData'
        Address1:
          description: Vendor's street address. Allowed characters are letters, numbers, spaces, and `. ,
          $ref: '#/components/schemas/AddressNullable'
        Address2:
          description: Additional line for vendor's address, such as a suite or unit number.
          $ref: '#/components/schemas/AddressAddtlNullable'
        BillingData:
          description: Object containing vendor's bank information.
          $ref: '#/components/schemas/BillingData'
        City:
          type: string
          description: Vendor's city.
        Contacts:
          description: Array of objects describing the vendor's contacts.
          $ref: '#/components/schemas/ContactsField'
        Country:
          type: string
          description: Vendor's country. `US` or `CA`.
        customerVendorAccount:
          type: string
          description: Account number of paypoint in the vendor side.
        EIN:
          type: string
          description: 'EIN/Tax ID for vendor. Must be nine digits formatted as `XX-XXXXXXX`. In responses, this field is masked and looks like: `XXXXX6789`.'
        Email:
          description: Vendor's email address. Required for vCard.
          $ref: '#/components/schemas/Email'
        InternalReferenceId:
          type: integer
          format: int64
          description: Internal identifier for global vendor account.
        LocationCode:
          $ref: '#/components/schemas/LocationCode'
        Mcc:
          $ref: '#/components/schemas/Mcc'
        Name1:
          type: string
          description: Primary name for vendor. Required for new vendor. Allowed characters are letters, numbers, spaces, and `. , ' & ( )
        Name2:
          type: string
          description: Secondary name for vendor. If provided, allowed characters are the same as `Name1`.
        payeeName1:
          $ref: '#/components/schemas/PayeeName'
        payeeName2:
          $ref: '#/components/schemas/PayeeName'
        PaymentMethod:
          $ref: '#/components/schemas/VendorPaymentMethod'
        Phone:
          type: string
          description: Vendor's phone number. Digits only when creating or updating a vendor.
        remitAddress1:
          $ref: '#/components/schemas/Remitaddress1'
        remitAddress2:
          $ref: '#/components/schemas/Remitaddress2'
        remitCity:
          $ref: '#/components/schemas/Remitcity'
        remitCountry:
          $ref: '#/components/schemas/Remitcountry'
        remitState:
          $ref: '#/components/schemas/Remitstate'
        remitZip:
          $ref: '#/components/schemas/Remitzip'
        State:
          type: string
          description: Vendor's state or province. Must be a valid US state or Canadian province abbreviation, depending on the `Country` value.
        VendorId:
          description: Payabli identifier for vendor record. Required when `VendorNumber` isn't included.
          $ref: '#/components/schemas/Vendorid'
        VendorNumber:
          $ref: '#/components/schemas/VendorNumber'
        VendorStatus:
          $ref: '#/components/schemas/Vendorstatus'
        Zip:
          type: string
          description: Vendor's ZIP or postal code. For US addresses, five digits (`12345`) or ZIP+4 format (`12345-6789`).
    BillQueryRecord2:
      type: object
      required:
        - AccountingField1
        - AccountingField2
        - AdditionalData
        - BatchNumber
        - billApprovals
        - BillDate
        - billEvents
        - BillItems
        - BillNumber
        - Comments
        - CreatedAt
        - Discount
        - DocumentsRef
        - DueDate
        - EndDate
        - EntityID
        - externalPaypointID
        - Frequency
        - IdBill
        - LastUpdated
        - LotNumber
        - Mode
        - NetAmount
        - ParentOrgId
        - ParentOrgName
        - PaymentId
        - PaymentMethod
        - paylinkId
        - PaypointDbaname
        - PaypointEntryname
        - PaypointLegalname
        - Source
        - Status
        - Terms
        - TotalAmount
        - Transaction
        - Vendor
      properties:
        AccountingField1:
          oneOf:
            - $ref: '#/components/schemas/AccountingField'
            - type: 'null'
        AccountingField2:
          oneOf:
            - $ref: '#/components/schemas/AccountingField'
            - type: 'null'
        AdditionalData:
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
          description: Additional data associated with the bill.
        BatchNumber:
          type:
            - string
            - 'null'
          description: Batch number associated with the bill.
        billApprovals:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/BillQueryRecord2BillApprovalsItem'
        BillDate:
          type:
            - string
            - 'null'
          format: date
          description: 'Bill creation date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
        billEvents:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/GeneralEvents'
          description: Events associated with the bill.
        BillItems:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/BillItem'
          description: Array of items included in the bill.
        BillNumber:
          type:
            - string
            - 'null'
          description: Bill number.
        Comments:
          type:
            - string
            - 'null'
          description: Additional comments on the bill.
        CreatedAt:
          description: Timestamp of when bill was created, in UTC.
          oneOf:
            - $ref: '#/components/schemas/CreatedAt'
            - type: 'null'
        Discount:
          type:
            - number
            - 'null'
          format: double
          description: Discount amount applied to the bill.
        DocumentsRef:
          type:
            - string
            - 'null'
          description: Reference to documents associated with the bill.
        DueDate:
          type:
            - string
            - 'null'
          format: date
          description: 'Bill due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
        EndDate:
          type:
            - string
            - 'null'
          format: date
          description: End date for the bill.
        EntityID:
          type:
            - string
            - 'null'
          description: Entity identifier associated with the bill.
        externalPaypointID:
          oneOf:
            - $ref: '#/components/schemas/ExternalPaypointId'
            - type: 'null'
        Frequency:
          description: Frequency for scheduled bills. Applied only in `Mode` = 1.
          oneOf:
            - $ref: '#/components/schemas/Frequency'
            - type: 'null'
        IdBill:
          type:
            - integer
            - 'null'
          format: int64
          description: Identifier of the bill.
        LastUpdated:
          type:
            - string
            - 'null'
          format: date-time
          description: Timestamp of when bill was last updated, in UTC.
        LotNumber:
          type:
            - string
            - 'null'
          description: Lot number associated with the bill.
        Mode:
          type:
            - integer
            - 'null'
          description: 'Bill mode: value `0` for single/one-time bills, `1` for scheduled bills.'
        NetAmount:
          type:
            - number
            - 'null'
          format: double
          description: Net amount of the bill.
        ParentOrgId:
          type:
            - integer
            - 'null'
          format: int64
          description: Parent organization identifier.
        ParentOrgName:
          oneOf:
            - $ref: '#/components/schemas/OrgParentName'
            - type: 'null'
        PaymentId:
          oneOf:
            - $ref: '#/components/schemas/PaymentIdString'
            - type: 'null'
        PaymentMethod:
          description: Preferred payment method used.
          oneOf:
            - $ref: '#/components/schemas/BillQueryRecord2PaymentMethod'
            - type: 'null'
        paylinkId:
          type:
            - string
            - 'null'
          description: Paylink identifier associated with the bill.
        PaypointDbaname:
          description: The paypoint's DBA name.
          oneOf:
            - $ref: '#/components/schemas/Dbaname'
            - type: 'null'
        PaypointEntryname:
          type:
            - string
            - 'null'
          description: Entry name of the paypoint.
        PaypointLegalname:
          description: The paypoint's legal name.
          oneOf:
            - $ref: '#/components/schemas/Legalname'
            - type: 'null'
        Source:
          type:
            - string
            - 'null'
          description: Source of the bill.
        Status:
          oneOf:
            - $ref: '#/components/schemas/Billstatus'
            - type: 'null'
        Terms:
          description: The payment terms for invoice. If no terms were defined initially, then response data for this field will default to `N30`.
          oneOf:
            - $ref: '#/components/schemas/Terms'
            - type: 'null'
        TotalAmount:
          type:
            - number
            - 'null'
          format: double
          description: Total amount of the bill including taxes and fees.
        Transaction:
          description: MoneyOut transaction associated to the bill.
          oneOf:
            - $ref: '#/components/schemas/TransactionOutQueryRecord'
            - type: 'null'
        Vendor:
          oneOf:
            - $ref: '#/components/schemas/VendorOutData'
            - type: 'null'
    BillQueryResponse:
      type: object
      properties:
        Summary:
          description: Summary statistics for the bill query response.
          $ref: '#/components/schemas/BillQueryResponseSummary'
        Records:
          type: array
          items:
            $ref: '#/components/schemas/BillQueryRecord2'
          description: Array of bill records returned by the query.
    CustomerNumberNullable:
      type: string
      maxLength: 250
      description: |
        User-provided unique identifier for the customer. This is typically the
        customer ID from your own system.
    CustomerStatus:
      type: integer
      description: |
        Customer Status. Possible values:

        - `-99` Deleted
        - `0` Inactive
        - `1` Active
        - `85` Locked (typically due to multiple failed login attempts)
    Shippingaddress:
      type: string
      maxLength: 250
      description: The shipping address.
    Shippingaddressadditional:
      type: string
      maxLength: 100
      description: Additional line for shipping address.
    Shippingcity:
      type: string
      maxLength: 250
      description: Shipping city.
    Shippingstate:
      type: string
      description: Shipping state or province.
    Shippingzip:
      type: string
      maxLength: 50
      description: |
        Shipping ZIP code. For Pay In functions, this field supports 5-digit
        and 9-digit ZIP codes and alphanumeric Canadian postal codes. For
        example: `37615-1234` or `37615`.
    Shippingcountry:
      type: string
      description: Shipping address country.
    Timezone:
      type: integer
      description: Timezone, in UTC offset. For example, -5 is Eastern time.
    Identifierfields:
      type: array
      items:
        type: string
      description: List of fields acting as customer identifiers, to be used instead of CustomerNumber.
    CustomerData:
      type: object
      description: Data about a single customer.
      properties:
        customerNumber:
          $ref: '#/components/schemas/CustomerNumberNullable'
        customerUsername:
          type: string
          description: Customer username for customer portal
        customerPsw:
          type: string
          description: Customer password for customer portal
        customerStatus:
          $ref: '#/components/schemas/CustomerStatus'
        company:
          type: string
          description: Company name
        firstname:
          type: string
          description: Customer first name
        lastname:
          type: string
          description: Customer last name
        phone:
          type: string
          description: Customer phone number
        email:
          description: Customer email address.
          $ref: '#/components/schemas/Email'
        address:
          type: string
          description: Customer address
        address1:
          type: string
          description: Additional customer address
        city:
          type: string
          description: Customer city
        state:
          type: string
          description: Customer State
        zip:
          type: string
          description: Customer postal code
        country:
          type: string
          description: Customer country in ISO-3166-1 alpha 2 format. See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
        shippingAddress:
          $ref: '#/components/schemas/Shippingaddress'
        shippingAddress1:
          $ref: '#/components/schemas/Shippingaddressadditional'
        shippingCity:
          $ref: '#/components/schemas/Shippingcity'
        shippingState:
          $ref: '#/components/schemas/Shippingstate'
        shippingZip:
          $ref: '#/components/schemas/Shippingzip'
        shippingCountry:
          $ref: '#/components/schemas/Shippingcountry'
        balance:
          type: number
          format: double
          description: Customer balance.
        timeZone:
          $ref: '#/components/schemas/Timezone'
        additionalFields:
          type: object
          additionalProperties:
            type: string
          description: Additional Custom fields in format "key":"value".
        identifierFields:
          $ref: '#/components/schemas/Identifierfields'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
    CustomerId:
      type: integer
      format: int64
      description: The Payabli-generated unique ID for the customer.
    Mfa:
      type: boolean
      description: When `true`, multi-factor authentication (MFA) is enabled.
    MfaMode:
      type: integer
    BillingZip:
      type: string
      maxLength: 50
      description: Billing address ZIP code.
    QueryTransactionPayorData:
      type: object
      properties:
        Identifiers:
          type: array
          items: {}
          description: Array of field names to be used as identifiers.
        FirstName:
          type: string
          description: Customer/Payor first name.
        LastName:
          type: string
          description: Customer/Payor last name.
        CompanyName:
          type: string
          description: Customer's company name.
        BillingAddress1:
          type: string
          description: Customer's billing address.
        BillingAddress2:
          type: string
          description: Additional line for Customer's billing address.
        BillingCity:
          type: string
          description: Customer's billing city.
        BillingState:
          type: string
          description: Customer's billing state. Must be 2-letter state code for address in US.
        BillingZip:
          description: Customer's billing ZIP code.
          $ref: '#/components/schemas/BillingZip'
        BillingCountry:
          type: string
          description: Customer's billing country.
        BillingPhone:
          type: string
          description: Customer's phone number.
        BillingEmail:
          description: Customer's email address.
          $ref: '#/components/schemas/Email'
        CustomerNumber:
          $ref: '#/components/schemas/CustomerNumberNullable'
        ShippingAddress1:
          $ref: '#/components/schemas/Shippingaddress'
        ShippingAddress2:
          $ref: '#/components/schemas/Shippingaddressadditional'
        ShippingCity:
          $ref: '#/components/schemas/Shippingcity'
        ShippingState:
          $ref: '#/components/schemas/Shippingstate'
        ShippingZip:
          $ref: '#/components/schemas/Shippingzip'
        ShippingCountry:
          $ref: '#/components/schemas/Shippingcountry'
        customerId:
          $ref: '#/components/schemas/CustomerId'
        customerStatus:
          $ref: '#/components/schemas/CustomerStatus'
        AdditionalData:
          $ref: '#/components/schemas/AdditionalDataMap'
    EntrypageId:
      type: integer
      format: int64
      description: |
        If applicable, the internal reference ID to the payment page associated
        with the transaction.
    Discount:
      type: number
      format: double
      description: Discount applied to the invoice.
    DutyAmount:
      type: number
      format: double
      description: Duty amount.
    FreightAmount:
      type: number
      format: double
      description: Freight/shipping amount.
    InvoiceAmount:
      type: number
      format: double
      description: The invoice amount.
    Invoicestatus:
      type: integer
      description: Invoice status code.
    InvoiceType:
      type: integer
      description: |
        Invoice type. Value `0` is for single/one-time invoices, `1` for
        scheduled invoices.
    BillDataPaymentTerms:
      type: string
      description: |
        Payment terms for invoice. If no terms are defined, then response data for
        this field defaults to `NET30`. Mirrors the values in
        [`Terms`](#schema-terms).
      enum:
        - PIA
        - CIA
        - UR
        - NET10
        - NET20
        - NET30
        - NET45
        - NET60
        - NET90
        - EOM
        - MFI
        - 5MFI
        - 10MFI
        - 15MFI
        - 20MFI
        - 2/10NET30
        - UF
        - 10UF
        - 20UF
        - 25UF
        - 50UF
      x-fern-enum:
        5MFI:
          name: FiveMfi
        10MFI:
          name: TenMfi
        15MFI:
          name: FifteenMfi
        20MFI:
          name: TwentyMfi
        2/10NET30:
          name: Two10Net30
        10UF:
          name: TenUf
        20UF:
          name: TwentyUf
        25UF:
          name: TwentyFiveUf
        50UF:
          name: FiftyUf
    PurchaseOrder:
      type: string
      description: Purchase order number.
    ShippingFromZip:
      type: string
      description: Sender shipping ZIP code.
    SummaryCommodityCode:
      type: string
      description: Commodity code.
    Tax:
      type: number
      format: double
      description: Tax rate in percent applied to the invoice.
    TermsConditions:
      type: string
      description: Custom terms and conditions included in the invoice.
    BillData:
      type: object
      properties:
        AdditionalData:
          $ref: '#/components/schemas/AdditionalDataMap'
        attachments:
          $ref: '#/components/schemas/Attachments'
        company:
          type: string
          description: Company name of the recipient of the invoice.
        discount:
          $ref: '#/components/schemas/Discount'
        dutyAmount:
          $ref: '#/components/schemas/DutyAmount'
        firstName:
          type: string
          description: First name of the recipient of the invoice.
        freightAmount:
          $ref: '#/components/schemas/FreightAmount'
        frequency:
          description: Frequency of scheduled invoice.
          $ref: '#/components/schemas/Frequency'
        invoiceAmount:
          $ref: '#/components/schemas/InvoiceAmount'
        invoiceDate:
          type: string
          format: date
          description: 'Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
        invoiceDueDate:
          type: string
          format: date
          description: 'Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
        invoiceEndDate:
          type: string
          format: date
          description: 'Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
        invoiceNumber:
          description: Invoice number. Identifies the invoice under a paypoint.
          $ref: '#/components/schemas/InvoiceNumber'
        invoiceStatus:
          $ref: '#/components/schemas/Invoicestatus'
        invoiceType:
          $ref: '#/components/schemas/InvoiceType'
        items:
          type: array
          items:
            $ref: '#/components/schemas/BillItem'
          description: Array of line items included in the invoice.
        lastName:
          type: string
          description: Last name of the recipient of the invoice.
        notes:
          type: string
          description: Notes included in the invoice.
        paymentTerms:
          $ref: '#/components/schemas/BillDataPaymentTerms'
        purchaseOrder:
          $ref: '#/components/schemas/PurchaseOrder'
        shippingAddress1:
          $ref: '#/components/schemas/Shippingaddress'
        shippingAddress2:
          $ref: '#/components/schemas/Shippingaddressadditional'
        shippingCity:
          $ref: '#/components/schemas/Shippingcity'
        shippingCountry:
          $ref: '#/components/schemas/Shippingcountry'
        shippingEmail:
          description: Shipping recipient's contact email address.
          $ref: '#/components/schemas/Email'
        shippingFromZip:
          $ref: '#/components/schemas/ShippingFromZip'
        shippingPhone:
          type: string
          description: Recipient phone number.
        shippingState:
          $ref: '#/components/schemas/Shippingstate'
        shippingZip:
          $ref: '#/components/schemas/Shippingzip'
        summaryCommodityCode:
          $ref: '#/components/schemas/SummaryCommodityCode'
        tax:
          $ref: '#/components/schemas/Tax'
        termsConditions:
          $ref: '#/components/schemas/TermsConditions'
    PaypointId:
      type: integer
      format: int64
      description: The paypoint's ID. Note that this is different than the entryname.
    SubscriptionType:
      type: string
      description: |
        Subscription type or category. Can't be changed after the subscription is created; if sent to the update endpoint, it's ignored.

        - `Regular`: A standard recurring subscription that charges a fixed amount each cycle.
        - `BalanceDriven`: A subscription that charges the payor's outstanding balance at run time instead of a fixed amount. Each scheduled run reads the live balance and charges that amount; a zero balance is skipped, not charged. `BalanceDriven` subscriptions only accept the `firstofmonth`, `fifteenthofmonth`, and `endofmonth` frequencies, ignore any `startDate` and `endDate` you supply (start date is calculated from `frequency`; the schedule runs until cancelled), and don't store a static `totalAmount` on the schedule.
      enum:
        - Regular
        - BalanceDriven
    SubscriptionQueryRecords:
      type: object
      required:
        - EndDate
        - LastRun
        - NextDate
        - StartDate
        - StoredMethod
      properties:
        CreatedAt:
          description: Timestamp of when the subscription ws created, in UTC.
          $ref: '#/components/schemas/CreatedAt'
        Customer:
          $ref: '#/components/schemas/QueryTransactionPayorData'
        EndDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The subscription's end date.
        EntrypageId:
          $ref: '#/components/schemas/EntrypageId'
        ExternalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        FeeAmount:
          type: number
          format: double
          description: Fee applied to the subscription.
        Frequency:
          type: string
          description: The subscription's frequency.
        IdSub:
          type: integer
          format: int64
          description: The subscription's ID.
        invoiceData:
          $ref: '#/components/schemas/BillData'
        LastRun:
          type:
            - string
            - 'null'
          format: date-time
          description: The last time the subscription was processed.
        LastUpdated:
          description: The last date and time the subscription was updated.
          $ref: '#/components/schemas/LastModified'
        LeftCycles:
          type: integer
          description: The number of cycles the subscription has left.
        Method:
          type: string
          description: The subscription's payment method.
        NetAmount:
          description: The subscription amount, minus any fees.
          $ref: '#/components/schemas/Netamountnullable'
        NextDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The next date the subscription will be processed.
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        PaymentData:
          $ref: '#/components/schemas/QueryPaymentData'
        PaypointDbaname:
          description: The paypoint's DBA name.
          $ref: '#/components/schemas/Dbaname'
        PaypointEntryname:
          description: The paypoint's entryname.
          $ref: '#/components/schemas/Entrypointfield'
        PaypointId:
          $ref: '#/components/schemas/PaypointId'
        PaypointLegalname:
          description: The paypoint's legal name.
          $ref: '#/components/schemas/Legalname'
        PlanId:
          type: integer
          description: Payment plan ID.
        Source:
          $ref: '#/components/schemas/Source'
        StartDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The subscription start date.
        StoredMethod:
          description: |-
            The full stored payment method record linked to the subscription
            and charged on each billing cycle. Returned as `null` for legacy
            subscriptions that don't have a linked stored method.
            The shape is the same across payment vehicles (card, ACH, check).
            Only the populated fields differ. For example, `ABA` is populated
            for ACH, while `ExpDate` and `binData` are populated for card.
          oneOf:
            - $ref: '#/components/schemas/VendorResponseStoredMethod'
            - type: 'null'
        SubEvents:
          type: array
          items:
            $ref: '#/components/schemas/GeneralEvents'
          description: Events associated with the subscription.
        SubStatus:
          type: integer
          description: |-
            The subscription's status.
            - 0: Paused
            - 1: Active
        SubscriptionType:
          description: Subscription type or category. Returns `null` when no type is assigned.
          oneOf:
            - $ref: '#/components/schemas/SubscriptionType'
            - type: 'null'
        TotalAmount:
          type: number
          format: double
          description: The subscription amount, including any fees.
        TotalCycles:
          type: integer
          description: The total number of cycles the subscription is set to run.
        UntilCancelled:
          type: boolean
          description: When `true`, the subscription has no explicit end date and will run until canceled.
    Descriptor:
      type: string
      description: |
        When the method is a card, this field displays card brand. When the
        method is ACH, this field displays the account type for ACH (checking or
        savings).
    MethodQueryRecords:
      type: object
      properties:
        IdPmethod:
          type: string
          description: Method internal ID
        Method:
          type: string
          description: 'Type of payment vehicle: **ach** or **card**'
        Descriptor:
          $ref: '#/components/schemas/Descriptor'
        MaskedAccount:
          $ref: '#/components/schemas/Maskedaccount'
        ExpDate:
          type: string
          description: Expiration date associated to the method (only for card) in format MMYY.
        HolderName:
          $ref: '#/components/schemas/Holdername'
        AchSecCode:
          type:
            - string
            - 'null'
          description: Standard Entry Class (SEC) code for the ACH transaction.
        AchHolderType:
          type:
            - string
            - 'null'
          description: 'Bank accountholder type: `personal` or `business`.'
        IsValidatedACH:
          type:
            - boolean
            - 'null'
          description: Whether the ACH account has been validated.
        BIN:
          type: string
          description: The bank identification number (BIN). Null when method is ACH.
        binData:
          $ref: '#/components/schemas/BinData'
        ABA:
          type:
            - string
            - 'null'
          description: Bank routing number.
        PostalCode:
          type:
            - string
            - 'null'
          description: The payment method postal code.
        MethodType:
          type:
            - string
            - 'null'
          description: The payment method's token type.
        WalletType:
          type:
            - string
            - 'null'
          description: Digital wallet type if applicable.
        LastUpdated:
          description: Date of last update
          $ref: '#/components/schemas/LastModified'
        CardUpdatedOn:
          type:
            - string
            - 'null'
          format: date-time
          description: Date and time the card was last updated.
    AchHolderType:
      type: string
      default: personal
      description: |
        The bank's accountholder type: personal or business.
      enum:
        - personal
        - business
    AchSecCode:
      type: string
      description: |
        Standard Entry Class (SEC) code is a three letter code that describes
        how an ACH payment was authorized. Supported values are:

        - **PPD** (Prearranged Payment and Deposit) — Used for credits or debits
          where an accountholder authorizes a company to initiate either a single
          or recurring transaction to their personal bank account. Common examples
          include direct deposit of payroll, mortgage payments, or utility bills.
          This is the default value for subscription payments.
        - **WEB** (Internet-Initiated/Mobile Entry) — Used for debit entries when
          authorization is obtained from an accountholder via the internet or a
          wireless network. Common examples are online bill payments, ecommerce
          purchases, and mobile app payments where the consumer enters their
          banking information online.
        - **TEL** (Telephone-Initiated Entry) — Used for one-time debit entries
          where authorization is obtained from a consumer via telephone. Common
          examples are phone-based purchases or bill payments where the consumer
          provides their banking information over the phone.
        - **CCD** (Corporate Credit or Debit) — Used for fund transfers between
          business accounts. This code is specifically for business-to-business
          transactions. Common examples include vendor payments and other
          business-to-business payments.
        - **BOC** (Back Office Conversion) — Used to convert paper checks received
          in-person at a point-of-sale or staffed payment location into electronic
          ACH debits. Required for Remote Deposit Capture (RDC) transactions. Only
          supports consumer checks; business, government, and mailed checks
          aren't eligible.
    BatchNumber:
      type: string
      maxLength: 65
      description: |
        A unique identifier for the batch. This is generated by Payabli when the
        batch is created, and follows this format:
        `paypointId + "_" + serviceName + "_" + batchDate:yyyyMMdd + "_" + Guid.NewGuid()`.
        Payabli generates the GUID to ensure that the batch number is unique.

        For example, in this batch number:
        `123_card_20251008_3f2504e0-4f89-11d3-9a0c-0305e82c3301`, the paypointID
        is `123`, the service is `card`, the batch date is `2025-10-08`, and
        the GUID is `3f2504e0-4f89-11d3-9a0c-0305e82c3301`.
    TransactionTime:
      type: string
      format: date-time
      description: Timestamp when transaction was submitted, in UTC.
    QueryCFeeTransaction:
      type: object
      properties:
        cFeeTransid:
          type: string
        feeAmount:
          type: number
          format: double
        operation:
          type: string
        refundId:
          type: integer
          format: int64
        responseData:
          type: object
          additionalProperties: {}
        settlementStatus:
          type: integer
        transactionTime:
          $ref: '#/components/schemas/TransactionTime'
        transStatus:
          type: integer
    Device:
      type: string
      description: Identifier of registered cloud device used in the transaction.
    ExternalProcessorInformation:
      type: string
      description: Information from the external processor about the transaction.
    Operation:
      type: string
      description: The transaction's operation.
    OrderId:
      type: string
      maxLength: 250
      description: Custom identifier for the transaction.
    PayorId:
      type: integer
      format: int64
      description: |
        Unique ID for the customer linked to the transaction. This is the same
        value as the `customerId` used when creating or referencing a customer.
    PendingFeeAmount:
      type: number
      format: double
      description: |
        The difference between the configured pass-through fee and the fee amount
        sent in the request. When transferring funds, Payabli uses this field to
        deduct the fee difference and transfer the correct amount to the
        merchant.

        When a paypoint is set up to absorb fees, and the pass-through fee sent
        with the request is less than the configured amount, the difference must
        be covered by the merchant. See
        [Fee Configuration](/guides/pay-in-fees-passthrough-overview#fee-configuration)
        to learn more about pass-through fee settings.
    RefundId:
      type: integer
      format: int64
      description: Identifier of refund transaction linked to this payment.
    Authcode:
      type: string
      description: Authorization code for the transaction.
    AvsResponse:
      type: string
      description: |
        Text code describing the result for address validation (applies only for
        card transactions).
    AvsResponseText:
      type: string
      description: |
        Text code describing the result for address validation (applies only for
        card transactions).
    CvvResponse:
      type: string
      description: |
        Text code describing the result for CVV validation (applies only for card
        transactions).
    CvvResponseText:
      type: string
      description: |
        Text code describing the result for CVV validation (applies only for card
        transactions).
    EmvAuthResponseData:
      type: string
      description: EMV authorization response data, applicable for card transactions.
    ResultCodev2:
      type: string
      description: |
        Unified result code for the transaction. See
        [Pay In unified response codes](/developers/references/pay-in-unified-response-codes-reference)
        for more information.
    ResultCodeText:
      type: string
      description: |
        Description of the result code. See
        [Pay In unified response codes](/developers/references/pay-in-unified-response-codes-reference)
        for more information.
    QueryResponseData:
      type: object
      description: The transaction's response data.
      properties:
        authcode:
          $ref: '#/components/schemas/Authcode'
        avsresponse:
          $ref: '#/components/schemas/AvsResponse'
        avsresponse_text:
          $ref: '#/components/schemas/AvsResponseText'
        cvvresponse:
          $ref: '#/components/schemas/CvvResponse'
        cvvresponse_text:
          $ref: '#/components/schemas/CvvResponseText'
        emv_auth_response_data:
          $ref: '#/components/schemas/EmvAuthResponseData'
        orderid:
          $ref: '#/components/schemas/OrderId'
        response:
          type: string
          description: 'Response text for operation: ''Success'' or ''Declined''.'
        response_code:
          type: string
          description: Internal result code processing the transaction. Value 1 indicates successful operation, values 2 and 3 indicate errors.
        response_code_text:
          type: string
          description: Text describing the result. If resultCode = 1, will return 'Approved' or a general success message. If resultCode = 2 or 3, will contain the cause of the decline.
        responsetext:
          type: string
          description: Text describing the result. If resultCode = 1, will return 'Approved' or a general success message. If resultCode = 2 or 3, will contain the cause of the decline.
        resultCode:
          $ref: '#/components/schemas/ResultCodev2'
        resultCodeText:
          $ref: '#/components/schemas/ResultCodeText'
        transactionid:
          type: string
          description: The transaction identifier in Payabli.
        type:
          type: string
          description: Type of transaction or operation.
    ReturnedId:
      type: integer
      format: int64
      description: Identifier of return/chargeback transaction linked to this payment.
    SplitCount:
      type: integer
      description: |
        Number of split funding instructions associated with the transaction.
        Returns `0` when the transaction has no splits.
    TransactionQueryRecords:
      type: object
      required:
        - splitCount
        - TransactionTime
      properties:
        AchHolderType:
          $ref: '#/components/schemas/AchHolderType'
        AchSecCode:
          $ref: '#/components/schemas/AchSecCode'
        BatchAmount:
          type: number
          format: double
          description: Batch amount.
        BatchNumber:
          $ref: '#/components/schemas/BatchNumber'
        CfeeTransactions:
          type: array
          items:
            $ref: '#/components/schemas/QueryCFeeTransaction'
          description: Service Fee or sub-charge transaction associated to the main transaction.
        ConnectorName:
          type: string
          description: Connector used for transaction.
        Customer:
          $ref: '#/components/schemas/QueryTransactionPayorData'
        DeviceId:
          $ref: '#/components/schemas/Device'
        EntrypageId:
          $ref: '#/components/schemas/EntrypageId'
        ExternalProcessorInformation:
          $ref: '#/components/schemas/ExternalProcessorInformation'
        FeeAmount:
          $ref: '#/components/schemas/FeeAmount'
        GatewayTransId:
          type: string
          description: Internal identifier used for processing.
        invoiceData:
          $ref: '#/components/schemas/BillData'
        Method:
          type: string
          description: 'Payment method used: card, ach, or wallet.'
        NetAmount:
          description: Net amount paid.
          $ref: '#/components/schemas/Netamountnullable'
        Operation:
          $ref: '#/components/schemas/Operation'
        OrderId:
          $ref: '#/components/schemas/OrderId'
        OrgId:
          description: ID of immediate parent organization.
          $ref: '#/components/schemas/Orgid'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        PaymentData:
          $ref: '#/components/schemas/QueryPaymentData'
        PaymentTransId:
          type: string
          description: Unique Transaction ID.
        PayorId:
          $ref: '#/components/schemas/PayorId'
        PaypointDbaname:
          description: Paypoint's DBA name.
          $ref: '#/components/schemas/Dbaname'
        PaypointEntryname:
          description: Paypoint's entryname.
          $ref: '#/components/schemas/Entrypointfield'
        PaypointId:
          type: integer
          format: int64
          description: InternalId for paypoint.
        PaypointLegalname:
          description: Paypoint's legal name.
          $ref: '#/components/schemas/Legalname'
        PendingFeeAmount:
          $ref: '#/components/schemas/PendingFeeAmount'
        RefundId:
          $ref: '#/components/schemas/RefundId'
        ResponseData:
          $ref: '#/components/schemas/QueryResponseData'
        ReturnedId:
          $ref: '#/components/schemas/ReturnedId'
        ScheduleReference:
          type: integer
          format: int64
          description: Reference to the subscription that originated the transaction.
        SettlementStatus:
          type: integer
          description: Settlement status for transaction. See [the docs](/developers/references/money-in-statuses#payment-funding-status) for a full reference.
        Source:
          $ref: '#/components/schemas/Source'
        splitFundingInstructions:
          $ref: '#/components/schemas/SplitFunding'
        splitCount:
          $ref: '#/components/schemas/SplitCount'
        TotalAmount:
          type: number
          format: double
          description: Transaction total amount (including service fee or sub-charge)
        TransactionEvents:
          type: array
          items:
            $ref: '#/components/schemas/QueryTransactionEvents'
          description: Events associated with this transaction.
        TransactionTime:
          type:
            - string
            - 'null'
          format: date-time
          description: Transaction date and time, in UTC.
        TransAdditionalData: {}
        TransStatus:
          type: integer
          description: Status of transaction. See [the docs](/developers/references/money-in-statuses#money-in-transaction-status) for a full reference.
    CustomerSummaryRecord:
      type: object
      properties:
        NumberofTransactions:
          type: integer
          description: Number total of transactions or payments
        RecentTransactions:
          type: array
          items:
            $ref: '#/components/schemas/TransactionQueryRecords'
          description: List of more recent 5 transactions belonging to the customer
        TotalAmountTransactions:
          type: number
          format: double
          description: Total amount in transactions
        TotalNetAmountTransactions:
          type: number
          format: double
          description: Total net amount in transactions
    OptinStatus:
      type: integer
      description: |
        Customer's consent status. Allowed status:

        - `0`: Customer hasn't opted in to communications
        - `-1`: Customer opt in pending
        - `1`: Customer has opted in to communications
    CustomerQueryRecordsCustomerConsentECommunication:
      type: object
      description: Describes the customer's email communications consent status.
      properties:
        status:
          $ref: '#/components/schemas/OptinStatus'
        updatedAt:
          $ref: '#/components/schemas/LastModified'
    CustomerQueryRecordsCustomerConsentSms:
      type: object
      description: Describes the customer's SMS communications consent status.
      properties:
        status:
          $ref: '#/components/schemas/OptinStatus'
        updatedAt:
          $ref: '#/components/schemas/LastModified'
    CustomerQueryRecordsCustomerConsent:
      type: object
      properties:
        eCommunication:
          description: Describes the customer's email communications consent status.
          $ref: '#/components/schemas/CustomerQueryRecordsCustomerConsentECommunication'
        sms:
          description: Describes the customer's SMS communications consent status.
          $ref: '#/components/schemas/CustomerQueryRecordsCustomerConsentSms'
    CustomerQueryRecords:
      type: object
      properties:
        customerId:
          $ref: '#/components/schemas/CustomerId'
        customerNumber:
          $ref: '#/components/schemas/CustomerNumberNullable'
        customerUsername:
          type: string
          description: Username for customer.
        customerStatus:
          $ref: '#/components/schemas/CustomerStatus'
        Company:
          type: string
          description: Company name.
        Firstname:
          type: string
          description: Customer first name.
        Lastname:
          type: string
          description: Customer last name.
        Phone:
          type: string
          description: Customer phone number.
        Email:
          description: Customer email address.
          $ref: '#/components/schemas/Email'
        Address:
          type: string
          description: Customer address.
        Address1:
          type: string
          description: Additional line for customer address.
        City:
          type: string
          description: Customer city.
        State:
          type: string
          description: Customer state.
        Zip:
          type: string
          description: Customer postal code.
        Country:
          type: string
          description: Customer country.
        ShippingAddress:
          $ref: '#/components/schemas/Shippingaddress'
        ShippingAddress1:
          $ref: '#/components/schemas/Shippingaddressadditional'
        ShippingCity:
          $ref: '#/components/schemas/Shippingcity'
        ShippingState:
          $ref: '#/components/schemas/Shippingstate'
        ShippingZip:
          $ref: '#/components/schemas/Shippingzip'
        ShippingCountry:
          $ref: '#/components/schemas/Shippingcountry'
        Balance:
          type: number
          format: double
          description: Customer balance.
        TimeZone:
          $ref: '#/components/schemas/Timezone'
        MFA:
          $ref: '#/components/schemas/Mfa'
        MFAMode:
          $ref: '#/components/schemas/MfaMode'
        snProvider:
          type: string
          description: |-
            Social network linked to customer. Possible values:
            - `facebook`
            - `google`
            - `twitter`
            - `microsoft`
        snIdentifier:
          type: string
          description: Identifier or token for customer in linked social network.
        snData:
          type: string
          description: Additional data provided by the social network related to the customer.
        LastUpdated:
          type: string
          format: date-time
          description: Date and time of last update.
        Created:
          type: string
          format: date-time
          description: Date and time created.
        AdditionalFields:
          type: object
          additionalProperties:
            type: string
          description: List of additional custom fields in format key:value.
        IdentifierFields:
          $ref: '#/components/schemas/Identifierfields'
        Subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionQueryRecords'
          description: List of subscriptions associated to the customer.
        StoredMethods:
          type: array
          items:
            $ref: '#/components/schemas/MethodQueryRecords'
          description: List of payment methods associated to the customer.
        customerSummary:
          $ref: '#/components/schemas/CustomerSummaryRecord'
        PaypointLegalname:
          description: Paypoint legal name.
          $ref: '#/components/schemas/Legalname'
        PaypointDbaname:
          description: Paypoint DBA name.
          $ref: '#/components/schemas/Dbaname'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        ParentOrgId:
          $ref: '#/components/schemas/OrgParentId'
        PaypointEntryname:
          $ref: '#/components/schemas/Entrypointfield'
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        customerConsent:
          $ref: '#/components/schemas/CustomerQueryRecordsCustomerConsent'
        customerPortal:
          type:
            - string
            - 'null'
    PayabliApiResponseCustomerQuery:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          $ref: '#/components/schemas/CustomerQueryRecords'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    PayabliApiResponse00Responsedatanonobject:
      type: object
      required:
        - responseText
      properties:
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        roomId:
          type: integer
          format: int64
          description: Describes the room ID. Only in use on Boarding endpoints, returns `0` when not applicable.
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          $ref: '#/components/schemas/Responsedatanonobject'
    Entry:
      type: string
      description: |
        The entity's entrypoint identifier.
        [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry).
    CheckCaptureRequestBody:
      type: object
      required:
        - entryPoint
        - frontImage
        - rearImage
        - checkAmount
      properties:
        entryPoint:
          $ref: '#/components/schemas/Entry'
        frontImage:
          type: string
          description: Base64-encoded front check image. Must be JPEG or PNG format and less than 1MB. Image must show the entire check clearly with no partial, blurry, or illegible portions.
        rearImage:
          type: string
          description: Base64-encoded rear check image. Must be JPEG or PNG format and less than 1MB. Image must show the entire check clearly with no partial, blurry, or illegible portions.
        checkAmount:
          type: integer
          description: Check amount in cents (maximum 32-bit integer value).
    CheckCaptureResponse:
      type: object
      description: Response model for check capture processing.
      required:
        - success
        - processDate
        - amountDiscrepancyDetected
        - endorsementDetected
        - checkType
      properties:
        id:
          type: string
          description: Unique ID for the check capture, to be used with the /api/MoneyIn/getpaid endpoint.
        success:
          type: boolean
          description: Indicates whether the check processing was successful.
        processDate:
          type: string
          description: The date and time when the check was processed (ISO 8601 format).
        ocrMicr:
          type: string
          description: The OCR-extracted MICR (Magnetic Ink Character Recognition) line from the check.
        ocrMicrStatus:
          type: string
          description: Status of the MICR extraction process.
        ocrMicrConfidence:
          type: string
          description: Confidence score for the MICR extraction (0 to 100).
        ocrAccountNumber:
          type: string
          description: The bank account number extracted from the check.
        ocrRoutingNumber:
          type: string
          description: The bank routing number extracted from the check.
        ocrCheckNumber:
          type: string
          description: The check number extracted from the check.
        ocrCheckTranCode:
          type: string
          description: The transaction code extracted from the check.
        ocrAmount:
          type: string
          description: The amount extracted via OCR from the check.
        ocrAmountStatus:
          type: string
          description: Status of the amount extraction process.
        ocrAmountConfidence:
          type: string
          description: Confidence score for the amount extraction (0 to 100).
        amountDiscrepancyDetected:
          type: boolean
          description: Flag indicating whether there's a discrepancy between the provided amount and the OCR-detected amount.
        endorsementDetected:
          type: boolean
          description: Flag indicating whether an endorsement was detected on the check.
        errors:
          type: array
          items:
            type: string
          description: List of error messages that occurred during processing.
        messages:
          type: array
          items:
            type: string
          description: List of informational messages about the processing.
        carLarMatchConfidence:
          type: string
          description: Confidence score for the match between Courtesy Amount Recognition (CAR) and Legal Amount Recognition (LAR).
        carLarMatchStatus:
          type: string
          description: Status of the CAR/LAR match.
        frontImage:
          type: string
          description: Processed front image of the check (Base64-encoded).
        rearImage:
          type: string
          description: Processed rear image of the check (Base64-encoded).
        checkType:
          type: number
          format: double
          description: |-
            Identifier for the type of check.
            Personal = 1
            Business = 2
            Only personal checks are supported for check capture.
        referenceNumber:
          type: string
          description: Reference number for the transaction.
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
    ForceCustomerCreation:
      type: boolean
      description: |
        When `true`, the request creates a new customer record, regardless of
        whether customer identifiers match an existing customer. Defaults to
        `false`.
    BillingAddressNullable:
      type: string
      maxLength: 250
      description: Billing address.
    BillingAddressAddtlNullable:
      type: string
      maxLength: 100
      description: Additional line for the billing address.
    BillingCityNullable:
      type: string
      maxLength: 250
      description: Billing city.
    BillingCountryNullable:
      type: string
      maxLength: 100
      description: Billing address country.
    PhoneNumber:
      type: string
      maxLength: 50
      description: Phone number.
    BillingStateNullable:
      type: string
      maxLength: 100
      description: Billing state. Must be a 2-letter state code for addresses in the US.
    PayorDataRequest:
      type: object
      description: Customer information. May be required, depending on the paypoint's settings. Required for subscriptions.
      properties:
        additionalData:
          $ref: '#/components/schemas/AdditionalData'
        billingAddress1:
          $ref: '#/components/schemas/BillingAddressNullable'
        billingAddress2:
          $ref: '#/components/schemas/BillingAddressAddtlNullable'
        billingCity:
          $ref: '#/components/schemas/BillingCityNullable'
        billingCountry:
          $ref: '#/components/schemas/BillingCountryNullable'
        billingEmail:
          $ref: '#/components/schemas/Email'
        billingPhone:
          $ref: '#/components/schemas/PhoneNumber'
        billingState:
          $ref: '#/components/schemas/BillingStateNullable'
        billingZip:
          description: 'Customer''s billing ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: "37615-1234" or "37615".'
          $ref: '#/components/schemas/BillingZip'
        company:
          type: string
          description: Customer's company name.
          maxLength: 250
        customerId:
          $ref: '#/components/schemas/CustomerId'
        customerNumber:
          $ref: '#/components/schemas/CustomerNumberNullable'
        firstName:
          type: string
          description: Customer/Payor first name.
          maxLength: 250
        identifierFields:
          $ref: '#/components/schemas/Identifierfields'
        lastName:
          type: string
          description: Customer/Payor last name.
          maxLength: 250
        shippingAddress1:
          $ref: '#/components/schemas/Shippingaddress'
        shippingAddress2:
          $ref: '#/components/schemas/Shippingaddressadditional'
        shippingCity:
          $ref: '#/components/schemas/Shippingcity'
        shippingCountry:
          $ref: '#/components/schemas/Shippingcountry'
        shippingState:
          $ref: '#/components/schemas/Shippingstate'
        shippingZip:
          $ref: '#/components/schemas/Shippingzip'
    IpAddress:
      type: string
      description: The IP address associated with the transaction.
    Cardcvv:
      type: string
      maxLength: 4
      description: |
        Card Verification Value (CVV) associated with the card number. We
        **strongly recommend** that you include this field when using `card`
        as a method.
    Cardexp:
      type: string
      maxLength: 5
      description: Card expiration date in format MMYY or MM/YY. Required for card transactions.
    Cardholder:
      type: string
      maxLength: 250
      description: Cardholder name.
    Cardnumber:
      type: string
      maxLength: 20
      description: |
        The card number. Required when method is `card` and a `storedMethodId`
        isn't included.
    Cardzip:
      type: string
      maxLength: 50
      description: |
        ZIP or postal code for the billing address of cardholder. We **strongly
        recommend** that you include this field when using `card` as a method.
    SaveIfSuccess:
      type: boolean
      description: |
        When `true`, Payabli saves the payment method if the transaction is
        successful. The payment method ID is returned in the response as
        `methodReferenceId`. Defaults to `false`.
    PayMethodCredit:
      type: object
      required:
        - cardexp
        - cardnumber
        - method
      properties:
        cardcvv:
          $ref: '#/components/schemas/Cardcvv'
        cardexp:
          $ref: '#/components/schemas/Cardexp'
        cardHolder:
          $ref: '#/components/schemas/Cardholder'
        cardnumber:
          $ref: '#/components/schemas/Cardnumber'
        cardzip:
          $ref: '#/components/schemas/Cardzip'
        initiator:
          $ref: '#/components/schemas/Initiator'
        method:
          type: string
          const: card
          description: Method to use for the transaction. For transactions with a credit or debit card, or a tokenized card, use `card`.
        saveIfSuccess:
          $ref: '#/components/schemas/SaveIfSuccess'
    Achaccount:
      type: string
      minLength: 4
      maxLength: 17
      description: Bank account number.
    Achaccounttype:
      type: string
      description: 'Bank account type: Checking or Savings.'
      enum:
        - Checking
        - Savings
    AchHolder:
      type: string
      maxLength: 250
      description: |
        Bank account holder. This field is **required** when `method` is `ach` or
        `check`.
    Achrouting:
      type: string
      minLength: 9
      maxLength: 9
      description: ABA/routing number of Bank account.
    PayMethodACH:
      type: object
      required:
        - achAccount
        - achHolder
        - achRouting
        - method
      properties:
        achAccount:
          description: Bank account number. This field is **required** when method = 'ach'.
          $ref: '#/components/schemas/Achaccount'
        achAccountType:
          description: Bank account type. This field is **required** when method = 'ach'.
          $ref: '#/components/schemas/Achaccounttype'
        achCode:
          $ref: '#/components/schemas/AchSecCode'
        achHolder:
          $ref: '#/components/schemas/AchHolder'
        achHolderType:
          $ref: '#/components/schemas/AchHolderType'
        achRouting:
          description: ABA/routing number of bank account. This field is **required** when method = 'ach'.
          $ref: '#/components/schemas/Achrouting'
        device:
          $ref: '#/components/schemas/Device'
        method:
          type: string
          const: ach
    PayMethodStoredMethodMethod:
      type: string
      description: |
        Method to use for the transaction. Use `card`, `ach`, or `wallet` depending
        on what kind of method was tokenized to use a saved payment method for
        this transaction.
      enum:
        - card
        - ach
        - wallet
    PayMethodStoredMethod:
      type: object
      description: The required and recommended fields for a payment made with a stored payment method.
      required:
        - method
      properties:
        initiator:
          $ref: '#/components/schemas/Initiator'
        method:
          description: Method to use for the transaction. Use `card`, `ach`, or `wallet` depending on what kind of method was tokenized to use a saved payment method for this transaction.
          $ref: '#/components/schemas/PayMethodStoredMethodMethod'
        storedMethodId:
          description: Payabli identifier of a tokenized payment method.
          $ref: '#/components/schemas/Storedmethodid'
        storedMethodUsageType:
          $ref: '#/components/schemas/StoredMethodUsageType'
    PayMethodCloud:
      type: object
      required:
        - method
      properties:
        device:
          $ref: '#/components/schemas/Device'
        method:
          type: string
          const: cloud
          description: Method to use for the transaction. For cloud device transactions, the method is `cloud`.
        saveIfSuccess:
          $ref: '#/components/schemas/SaveIfSuccess'
    Check:
      type: object
      required:
        - achHolder
        - method
      properties:
        achHolder:
          description: The checking accountholder's name.
          $ref: '#/components/schemas/AchHolder'
        method:
          type: string
          const: check
          description: Method to use for the transaction. Use `check` for a paper check transaction. When the method is `check`, then `paymentDetails.checkNumber` is required.
    Cash:
      type: object
      required:
        - method
      properties:
        method:
          type: string
          const: cash
          description: Method to use for the transaction. For cash transactions, use `cash`.
    Methodall:
      type: string
      description: Method to use for the transaction.
      enum:
        - card
        - ach
        - cloud
        - check
        - cash
    PayMethodBodyAllFields:
      type: object
      description: Model for the PaymentMethod object, includes all method types.
      required:
        - achAccount
        - achHolder
        - achRouting
      properties:
        achAccount:
          description: Bank account number. This field is **required** when method = 'ach'.
          $ref: '#/components/schemas/Achaccount'
        achAccountType:
          $ref: '#/components/schemas/Achaccounttype'
        achCode:
          $ref: '#/components/schemas/AchSecCode'
        achHolder:
          $ref: '#/components/schemas/AchHolder'
        achRouting:
          description: ABA/routing number of Bank account. This field is **required** when method = 'ach'.
          $ref: '#/components/schemas/Achrouting'
        cardcvv:
          $ref: '#/components/schemas/Cardcvv'
        cardexp:
          $ref: '#/components/schemas/Cardexp'
        cardHolder:
          $ref: '#/components/schemas/Cardholder'
        cardnumber:
          $ref: '#/components/schemas/Cardnumber'
        cardzip:
          $ref: '#/components/schemas/Cardzip'
        device:
          $ref: '#/components/schemas/Device'
        initator:
          $ref: '#/components/schemas/Initiator'
        method:
          $ref: '#/components/schemas/Methodall'
        saveIfSuccess:
          $ref: '#/components/schemas/SaveIfSuccess'
        storedMethodId:
          $ref: '#/components/schemas/Storedmethodid'
        storedMethodUsageType:
          $ref: '#/components/schemas/StoredMethodUsageType'
    PaymentMethod:
      description: Information about the payment method for the transaction.
      oneOf:
        - $ref: '#/components/schemas/PayMethodCredit'
        - $ref: '#/components/schemas/PayMethodACH'
        - $ref: '#/components/schemas/PayMethodStoredMethod'
        - $ref: '#/components/schemas/PayMethodCloud'
        - $ref: '#/components/schemas/Check'
        - $ref: '#/components/schemas/Cash'
        - $ref: '#/components/schemas/PayMethodBodyAllFields'
    Subdomain:
      type: string
      maxLength: 50
      description: |
        Refers to the payment page identifier. If provided, then the
        transaction is linked to the payment page.
    Subscriptionid:
      type: integer
      format: int64
      description: Payabli identifier of the subscription associated with the transaction.
    TransRequestBody:
      type: object
      required:
        - paymentDetails
        - paymentMethod
      properties:
        accountId:
          $ref: '#/components/schemas/AccountId'
        customerData:
          description: Object describing the Customer/Payor. Which fields are required depends on the paypoint's custom identifier settings.
          $ref: '#/components/schemas/PayorDataRequest'
        entryPoint:
          $ref: '#/components/schemas/Entrypointfield'
        invoiceData:
          description: Object describing an Invoice linked to the transaction.
          $ref: '#/components/schemas/BillData'
        ipaddress:
          $ref: '#/components/schemas/IpAddress'
        orderDescription:
          $ref: '#/components/schemas/Orderdescription'
        orderId:
          $ref: '#/components/schemas/OrderId'
        paymentDetails:
          description: Object describing details of the payment. Required.
          $ref: '#/components/schemas/PaymentDetail'
        paymentMethod:
          description: Information about the payment method for the transaction. Required and recommended fields for each payment method type are described in each schema below.
          $ref: '#/components/schemas/PaymentMethod'
        source:
          $ref: '#/components/schemas/Source'
        subdomain:
          $ref: '#/components/schemas/Subdomain'
        subscriptionId:
          $ref: '#/components/schemas/Subscriptionid'
    Referenceidtrans:
      type: string
      description: The transaction identifier in Payabli.
    ResultCode:
      type: integer
      description: |
        Result code for the operation. Value `1` indicates a successful
        operation, values `2` and `3` indicate errors. A value of `10` indicates
        that an operation has been initiated and is pending.
    Resulttext:
      type: string
      description: |
        Text describing the result. If `ResultCode` = 1, will return `Approved`
        or a general success message. If `ResultCode` = 2 or 3, will contain
        the cause of the error or decline.
    Customeridtrans:
      type: integer
      format: int64
      description: |
        Payabli-generated unique ID of customer owner of transaction. Returns `0`
        if the transaction wasn't assigned to an existing customer or no customer
        was created.
    MethodReferenceId:
      type: string
      description: |
        The stored method's identifier (sometimes referred to as 'token') in
        Payabli. When `null`, the method wasn't created, or doesn't exist,
        depending on the operation performed.
    AuthResponseResponseData:
      type: object
      required:
        - authCode
        - referenceId
        - resultCode
        - resultText
        - avsResponseText
        - cvvResponseText
        - customerId
      properties:
        authCode:
          $ref: '#/components/schemas/Authcode'
        referenceId:
          $ref: '#/components/schemas/Referenceidtrans'
        resultCode:
          $ref: '#/components/schemas/ResultCode'
        resultText:
          $ref: '#/components/schemas/Resulttext'
        avsResponseText:
          $ref: '#/components/schemas/AvsResponseText'
        cvvResponseText:
          $ref: '#/components/schemas/CvvResponseText'
        customerId:
          $ref: '#/components/schemas/Customeridtrans'
        methodReferenceId:
          $ref: '#/components/schemas/MethodReferenceId'
    AuthResponse:
      type: object
      description: Response for MoneyIn/authorize.
      required:
        - responseText
        - isSuccess
        - responseData
      properties:
        responseText:
          $ref: '#/components/schemas/ResponseText'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseData:
          $ref: '#/components/schemas/AuthResponseResponseData'
    CaptureResponseData:
      type: object
      description: Response data for capture transactions
      required:
        - authCode
        - referenceId
        - resultCode
        - resultText
        - avsResponseText
        - cvvResponseText
        - customerId
        - methodReferenceId
      properties:
        authCode:
          $ref: '#/components/schemas/Authcode'
        referenceId:
          $ref: '#/components/schemas/Referenceidtrans'
        resultCode:
          $ref: '#/components/schemas/ResultCode'
        resultText:
          $ref: '#/components/schemas/Resulttext'
        avsResponseText:
          oneOf:
            - $ref: '#/components/schemas/AvsResponseText'
            - type: 'null'
        cvvResponseText:
          oneOf:
            - $ref: '#/components/schemas/CvvResponseText'
            - type: 'null'
        customerId:
          oneOf:
            - $ref: '#/components/schemas/Customeridtrans'
            - type: 'null'
        methodReferenceId:
          oneOf:
            - $ref: '#/components/schemas/MethodReferenceId'
            - type: 'null'
    CaptureResponse:
      type: object
      description: Response for MoneyIn/capture endpoint
      required:
        - responseCode
        - pageIdentifier
        - roomId
        - isSuccess
        - responseText
        - responseData
      properties:
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        pageIdentifier:
          oneOf:
            - $ref: '#/components/schemas/PageIdentifier'
            - type: 'null'
        roomId:
          $ref: '#/components/schemas/RoomIdNotInUse'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          $ref: '#/components/schemas/CaptureResponseData'
    CapturePaymentDetails:
      type: object
      required:
        - totalAmount
      properties:
        totalAmount:
          type: number
          format: double
          description: |-
            Total amount to be captured, including the `serviceFee` amount. The amount can't be greater the original
            total amount of the transaction, and can't be more than 15% lower than the original amount.
        serviceFee:
          type: number
          format: double
          description: Service fee to capture for the transaction.
    CaptureRequest:
      type: object
      required:
        - paymentDetails
      properties:
        paymentDetails:
          $ref: '#/components/schemas/CapturePaymentDetails'
    PaymentDetailCredit:
      type: object
      description: The PaymentDetail object for microdeposit (MakeCredit) transactions.
      required:
        - totalAmount
      properties:
        currency:
          type: string
          description: Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is **USD**
        serviceFee:
          type: number
          format: double
          description: Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually.
        totalAmount:
          type: number
          format: double
          description: Total amount to be charged. If a service fee is provided, then this amount should include the service fee.
    RequestCreditPaymentMethod:
      type: object
      description: Object describing the ACH payment method to use for transaction.
      required:
        - method
      properties:
        achAccount:
          $ref: '#/components/schemas/Achaccount'
        achAccountType:
          $ref: '#/components/schemas/Achaccounttype'
        achCode:
          $ref: '#/components/schemas/AchSecCode'
        achHolder:
          description: Bank account holder.
          $ref: '#/components/schemas/AchHolder'
        achRouting:
          $ref: '#/components/schemas/Achrouting'
        method:
          type: string
          const: ach
          description: Method to use for the transaction. Must be ACH.
    RequestCredit:
      type: object
      required:
        - customerData
        - paymentDetails
        - paymentMethod
      properties:
        accountId:
          $ref: '#/components/schemas/AccountId'
        customerData:
          description: Object describing the customer/payor.
          $ref: '#/components/schemas/PayorDataRequest'
        entrypoint:
          $ref: '#/components/schemas/Entrypointfield'
        orderDescription:
          $ref: '#/components/schemas/Orderdescription'
        orderId:
          $ref: '#/components/schemas/OrderId'
        paymentDetails:
          $ref: '#/components/schemas/PaymentDetailCredit'
        paymentMethod:
          description: Object describing the ACH payment method to use for transaction.
          $ref: '#/components/schemas/RequestCreditPaymentMethod'
        source:
          $ref: '#/components/schemas/Source'
        subdomain:
          $ref: '#/components/schemas/Subdomain'
    PayabliApiResponse0ResponseData:
      type: object
      properties:
        AuthCode:
          $ref: '#/components/schemas/Authcode'
        avsResponseText:
          $ref: '#/components/schemas/AvsResponseText'
        CustomerId:
          $ref: '#/components/schemas/Customeridtrans'
        cvvResponseText:
          $ref: '#/components/schemas/CvvResponseText'
        methodReferenceId:
          $ref: '#/components/schemas/MethodReferenceId'
        ReferenceId:
          $ref: '#/components/schemas/Referenceidtrans'
        ResultCode:
          $ref: '#/components/schemas/ResultCode'
        ResultText:
          $ref: '#/components/schemas/Resulttext'
    PayabliApiResponse0:
      type: object
      description: General response for certain `moneyIn` and `moneyOut` endpoints.
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseData:
          $ref: '#/components/schemas/PayabliApiResponse0ResponseData'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    QueryTransactionPayorDataCustomer:
      type: object
      properties:
        Identifiers:
          type: array
          items: {}
          description: Array of field names to be used as identifiers.
        FirstName:
          type: string
          description: Customer/Payor first name.
        LastName:
          type: string
          description: Customer/Payor last name.
        CompanyName:
          type: string
          description: Customer's company name.
        BillingAddress1:
          type: string
          description: Customer's billing address.
        BillingAddress2:
          type: string
          description: Additional line for Customer's billing address.
        BillingCity:
          type: string
          description: Customer's billing city.
        BillingState:
          type: string
          description: Customer's billing state. Must be 2-letter state code for address in US.
        BillingZip:
          description: Customer's billing ZIP code.
          $ref: '#/components/schemas/BillingZip'
        BillingCountry:
          type: string
          description: Customer's billing country.
        BillingPhone:
          type: string
          description: Customer's phone number.
        BillingEmail:
          description: Customer's email address.
          $ref: '#/components/schemas/Email'
        CustomerNumber:
          $ref: '#/components/schemas/CustomerNumberNullable'
        ShippingAddress1:
          $ref: '#/components/schemas/Shippingaddress'
        ShippingAddress2:
          $ref: '#/components/schemas/Shippingaddressadditional'
        ShippingCity:
          $ref: '#/components/schemas/Shippingcity'
        ShippingState:
          $ref: '#/components/schemas/Shippingstate'
        ShippingZip:
          $ref: '#/components/schemas/Shippingzip'
        ShippingCountry:
          $ref: '#/components/schemas/Shippingcountry'
        customerId:
          $ref: '#/components/schemas/CustomerId'
        customerStatus:
          $ref: '#/components/schemas/CustomerStatus'
        AdditionalData:
          $ref: '#/components/schemas/AdditionalDataMap'
    TransactionQueryRecordsCustomer:
      type: object
      required:
        - splitCount
        - TransactionTime
      properties:
        AchHolderType:
          $ref: '#/components/schemas/AchHolderType'
        AchSecCode:
          $ref: '#/components/schemas/AchSecCode'
        BatchAmount:
          type: number
          format: double
          description: Batch amount.
        BatchNumber:
          $ref: '#/components/schemas/BatchNumber'
        CfeeTransactions:
          type: array
          items:
            $ref: '#/components/schemas/QueryCFeeTransaction'
          description: Service Fee or sub-charge transaction associated to the main transaction.
        ConnectorName:
          type: string
          description: Connector used for transaction.
        Customer:
          $ref: '#/components/schemas/QueryTransactionPayorDataCustomer'
        DeviceId:
          $ref: '#/components/schemas/Device'
        EntrypageId:
          $ref: '#/components/schemas/EntrypageId'
        ExternalProcessorInformation:
          $ref: '#/components/schemas/ExternalProcessorInformation'
        FeeAmount:
          $ref: '#/components/schemas/FeeAmount'
        GatewayTransId:
          type: string
          description: Internal identifier used for processing.
        invoiceData:
          $ref: '#/components/schemas/BillData'
        Method:
          type: string
          description: 'Payment method used: card, ach, or wallet.'
        NetAmount:
          description: Net amount paid.
          $ref: '#/components/schemas/Netamountnullable'
        Operation:
          $ref: '#/components/schemas/Operation'
        OrderId:
          $ref: '#/components/schemas/OrderId'
        OrgId:
          description: ID of immediate parent organization.
          $ref: '#/components/schemas/Orgid'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        PaymentData:
          $ref: '#/components/schemas/QueryPaymentData'
        PaymentTransId:
          type: string
          description: Unique Transaction ID.
        PayorId:
          $ref: '#/components/schemas/PayorId'
        PaypointDbaname:
          description: Paypoint's DBA name.
          $ref: '#/components/schemas/Dbaname'
        PaypointEntryname:
          description: Paypoint's entryname.
          $ref: '#/components/schemas/Entrypointfield'
        PaypointId:
          type: integer
          format: int64
          description: InternalId for paypoint.
        PaypointLegalname:
          description: Paypoint's legal name.
          $ref: '#/components/schemas/Legalname'
        PendingFeeAmount:
          $ref: '#/components/schemas/PendingFeeAmount'
        RefundId:
          $ref: '#/components/schemas/RefundId'
        ResponseData:
          $ref: '#/components/schemas/QueryResponseData'
        ReturnedId:
          $ref: '#/components/schemas/ReturnedId'
        ScheduleReference:
          type: integer
          format: int64
          description: Reference to the subscription that originated the transaction.
        SettlementStatus:
          type: integer
          description: Settlement status for transaction. See [the docs](/developers/references/money-in-statuses#payment-funding-status) for a full reference.
        Source:
          $ref: '#/components/schemas/Source'
        splitFundingInstructions:
          $ref: '#/components/schemas/SplitFunding'
        splitCount:
          $ref: '#/components/schemas/SplitCount'
        TotalAmount:
          type: number
          format: double
          description: Transaction total amount (including service fee or sub-charge)
        TransactionEvents:
          type: array
          items:
            $ref: '#/components/schemas/QueryTransactionEvents'
          description: Events associated with this transaction.
        TransactionTime:
          type:
            - string
            - 'null'
          format: date-time
          description: Transaction date and time, in UTC.
        TransAdditionalData: {}
        TransStatus:
          type: integer
          description: Status of transaction. See [the docs](/developers/references/money-in-statuses#money-in-transaction-status) for a full reference.
    AchValidation:
      type: boolean
      description: |
        When `true`, enables real-time validation of ACH account and routing
        numbers. This is an add-on feature, contact Payabli for more information.
    TransactionDetailRecordMethod:
      type: string
      description: Payment method used for the transaction
      enum:
        - ach
        - card
    TransactionDetailPaymentDetails:
      type: object
      description: Detailed breakdown of payment amounts and identifiers
      required:
        - totalAmount
        - serviceFee
        - checkNumber
        - checkImage
        - checkUniqueId
        - currency
        - orderDescription
        - orderId
        - orderIdAlternative
        - paymentDescription
        - groupNumber
        - source
        - payabliTransId
        - unbundled
        - categories
        - splitFunding
      properties:
        totalAmount:
          type: number
          format: double
        serviceFee:
          type: number
          format: double
        checkNumber:
          type:
            - string
            - 'null'
        checkImage:
          oneOf:
            - {}
            - type: 'null'
        checkUniqueId:
          type: string
        currency:
          type: string
        orderDescription:
          oneOf:
            - $ref: '#/components/schemas/Orderdescription'
            - type: 'null'
        orderId:
          oneOf:
            - $ref: '#/components/schemas/OrderId'
            - type: 'null'
        orderIdAlternative:
          type:
            - string
            - 'null'
        paymentDescription:
          type:
            - string
            - 'null'
        groupNumber:
          type:
            - string
            - 'null'
        source:
          oneOf:
            - $ref: '#/components/schemas/Source'
            - type: 'null'
        payabliTransId:
          type:
            - string
            - 'null'
        unbundled:
          oneOf:
            - {}
            - type: 'null'
        categories:
          type: array
          items: {}
        splitFunding:
          type: array
          items: {}
    TransactionDetailPaymentData:
      type: object
      description: Payment method and transaction details
      required:
        - maskedAccount
        - accountType
        - accountExp
        - holderName
        - storedId
        - initiator
        - storedMethodUsageType
        - sequence
        - orderDescription
        - accountId
        - signatureData
        - binData
        - paymentDetails
      properties:
        maskedAccount:
          $ref: '#/components/schemas/Maskedaccount'
        accountType:
          $ref: '#/components/schemas/Accounttype'
        accountExp:
          oneOf:
            - $ref: '#/components/schemas/Accountexp'
            - type: 'null'
        holderName:
          $ref: '#/components/schemas/Holdername'
        storedId:
          oneOf:
            - $ref: '#/components/schemas/Storedmethodid'
            - type: 'null'
        initiator:
          oneOf:
            - $ref: '#/components/schemas/Initiator'
            - type: 'null'
        storedMethodUsageType:
          oneOf:
            - $ref: '#/components/schemas/StoredMethodUsageType'
            - type: 'null'
        sequence:
          oneOf:
            - $ref: '#/components/schemas/Sequence'
            - type: 'null'
        orderDescription:
          oneOf:
            - $ref: '#/components/schemas/Orderdescription'
            - type: 'null'
        accountId:
          oneOf:
            - $ref: '#/components/schemas/AccountId'
            - type: 'null'
        signatureData:
          oneOf:
            - $ref: '#/components/schemas/Signaturedata'
            - type: 'null'
        binData:
          oneOf:
            - $ref: '#/components/schemas/BinData'
            - type: 'null'
        paymentDetails:
          $ref: '#/components/schemas/TransactionDetailPaymentDetails'
    TransStatus:
      type: integer
      description: |
        Status of transaction. See
        [the docs](/developers/references/money-in-statuses#money-in-transaction-status)
        for a full reference.
    SettlementStatus:
      type: integer
      description: |
        Settlement status for transaction. See
        [the docs](/developers/references/money-in-statuses#payment-funding-status)
        for a full reference.
    TransactionDetailResponseData:
      type: object
      description: Response data from payment processor
      required:
        - response
        - responsetext
        - authcode
        - transactionid
        - avsresponse
        - avsresponse_text
        - cvvresponse
        - cvvresponse_text
        - orderid
        - type
        - response_code
        - response_code_text
        - customer_vault_id
        - emv_auth_response_data
      properties:
        resultCode:
          type: string
          description: Unified result code for the transaction. See [Pay In unified response codes](/guides/pay-in-unified-response-codes-reference) for more information.
        resultCodeText:
          type: string
          description: Description of the result code. See [Pay In unified response codes](/guides/pay-in-unified-response-codes-reference) for more information.
        response:
          type:
            - string
            - 'null'
        responsetext:
          $ref: '#/components/schemas/Resulttext'
        authcode:
          oneOf:
            - $ref: '#/components/schemas/Authcode'
            - type: 'null'
        transactionid:
          type: string
        avsresponse:
          type:
            - string
            - 'null'
        avsresponse_text:
          oneOf:
            - $ref: '#/components/schemas/AvsResponseText'
            - type: 'null'
        cvvresponse:
          type:
            - string
            - 'null'
        cvvresponse_text:
          oneOf:
            - $ref: '#/components/schemas/CvvResponseText'
            - type: 'null'
        orderid:
          oneOf:
            - $ref: '#/components/schemas/OrderId'
            - type: 'null'
        type:
          type:
            - string
            - 'null'
        response_code:
          type: string
        response_code_text:
          type: string
        customer_vault_id:
          type:
            - string
            - 'null'
        emv_auth_response_data:
          oneOf:
            - $ref: '#/components/schemas/EmvAuthResponseData'
            - type: 'null'
    ChargebackId:
      type: integer
      format: int64
      description: Identifier of chargeback transaction.
    RetrievalId:
      type: integer
      format: int64
      description: Identifier of retrieval request.
    TransactionDetailInvoiceData:
      type: object
      description: Invoice information if transaction is associated with an invoice
      required:
        - invoiceNumber
        - invoiceDate
        - invoiceDueDate
        - invoiceEndDate
        - invoiceStatus
        - invoiceType
        - frequency
        - paymentTerms
        - termsConditions
        - notes
        - tax
        - discount
        - invoiceAmount
        - freightAmount
        - dutyAmount
        - purchaseOrder
        - firstName
        - lastName
        - company
        - shippingAddress1
        - shippingAddress2
        - shippingCity
        - shippingState
        - shippingZip
        - shippingCountry
        - shippingEmail
        - shippingPhone
        - shippingFromZip
        - summaryCommodityCode
        - items
        - attachments
        - additionalData
      properties:
        invoiceNumber:
          oneOf:
            - $ref: '#/components/schemas/InvoiceNumber'
            - type: 'null'
        invoiceDate:
          type:
            - string
            - 'null'
          format: date
        invoiceDueDate:
          type:
            - string
            - 'null'
          format: date
        invoiceEndDate:
          type:
            - string
            - 'null'
          format: date
        invoiceStatus:
          oneOf:
            - $ref: '#/components/schemas/Invoicestatus'
            - type: 'null'
        invoiceType:
          oneOf:
            - $ref: '#/components/schemas/InvoiceType'
            - type: 'null'
        frequency:
          oneOf:
            - $ref: '#/components/schemas/Frequency'
            - type: 'null'
        paymentTerms:
          type:
            - string
            - 'null'
        termsConditions:
          oneOf:
            - $ref: '#/components/schemas/TermsConditions'
            - type: 'null'
        notes:
          type:
            - string
            - 'null'
        tax:
          oneOf:
            - $ref: '#/components/schemas/Tax'
            - type: 'null'
        discount:
          oneOf:
            - $ref: '#/components/schemas/Discount'
            - type: 'null'
        invoiceAmount:
          oneOf:
            - $ref: '#/components/schemas/InvoiceAmount'
            - type: 'null'
        freightAmount:
          oneOf:
            - $ref: '#/components/schemas/FreightAmount'
            - type: 'null'
        dutyAmount:
          oneOf:
            - $ref: '#/components/schemas/DutyAmount'
            - type: 'null'
        purchaseOrder:
          oneOf:
            - $ref: '#/components/schemas/PurchaseOrder'
            - type: 'null'
        firstName:
          type:
            - string
            - 'null'
        lastName:
          type:
            - string
            - 'null'
        company:
          type:
            - string
            - 'null'
        shippingAddress1:
          oneOf:
            - $ref: '#/components/schemas/Shippingaddress'
            - type: 'null'
        shippingAddress2:
          oneOf:
            - $ref: '#/components/schemas/Shippingaddressadditional'
            - type: 'null'
        shippingCity:
          oneOf:
            - $ref: '#/components/schemas/Shippingcity'
            - type: 'null'
        shippingState:
          oneOf:
            - $ref: '#/components/schemas/Shippingstate'
            - type: 'null'
        shippingZip:
          oneOf:
            - $ref: '#/components/schemas/Shippingzip'
            - type: 'null'
        shippingCountry:
          oneOf:
            - $ref: '#/components/schemas/Shippingcountry'
            - type: 'null'
        shippingEmail:
          oneOf:
            - $ref: '#/components/schemas/Email'
            - type: 'null'
        shippingPhone:
          type:
            - string
            - 'null'
        shippingFromZip:
          oneOf:
            - $ref: '#/components/schemas/ShippingFromZip'
            - type: 'null'
        summaryCommodityCode:
          oneOf:
            - $ref: '#/components/schemas/SummaryCommodityCode'
            - type: 'null'
        items:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/BillItem'
        attachments:
          oneOf:
            - $ref: '#/components/schemas/Attachments'
            - type: 'null'
        additionalData:
          oneOf:
            - $ref: '#/components/schemas/AdditionalDataMap'
            - type: 'null'
    TransactionDetailCustomer:
      type: object
      description: Customer information associated with the transaction
      required:
        - identifiers
        - firstName
        - lastName
        - companyName
        - billingAddress1
        - billingAddress2
        - billingCity
        - billingState
        - billingZip
        - billingCountry
        - billingPhone
        - billingEmail
        - customerNumber
        - shippingAddress1
        - shippingAddress2
        - shippingCity
        - shippingState
        - shippingZip
        - shippingCountry
        - customerId
        - customerStatus
        - additionalData
      properties:
        identifiers:
          oneOf:
            - $ref: '#/components/schemas/Identifierfields'
            - type: 'null'
        firstName:
          type: string
        lastName:
          type: string
        companyName:
          type:
            - string
            - 'null'
        billingAddress1:
          oneOf:
            - $ref: '#/components/schemas/BillingAddressNullable'
            - type: 'null'
        billingAddress2:
          oneOf:
            - $ref: '#/components/schemas/BillingAddressAddtlNullable'
            - type: 'null'
        billingCity:
          oneOf:
            - $ref: '#/components/schemas/BillingCityNullable'
            - type: 'null'
        billingState:
          oneOf:
            - $ref: '#/components/schemas/BillingStateNullable'
            - type: 'null'
        billingZip:
          oneOf:
            - $ref: '#/components/schemas/BillingZip'
            - type: 'null'
        billingCountry:
          oneOf:
            - $ref: '#/components/schemas/BillingCountryNullable'
            - type: 'null'
        billingPhone:
          oneOf:
            - $ref: '#/components/schemas/PhoneNumber'
            - type: 'null'
        billingEmail:
          oneOf:
            - $ref: '#/components/schemas/Email'
            - type: 'null'
        customerNumber:
          oneOf:
            - $ref: '#/components/schemas/CustomerNumberNullable'
            - type: 'null'
        shippingAddress1:
          oneOf:
            - $ref: '#/components/schemas/Shippingaddress'
            - type: 'null'
        shippingAddress2:
          oneOf:
            - $ref: '#/components/schemas/Shippingaddressadditional'
            - type: 'null'
        shippingCity:
          oneOf:
            - $ref: '#/components/schemas/Shippingcity'
            - type: 'null'
        shippingState:
          oneOf:
            - $ref: '#/components/schemas/Shippingstate'
            - type: 'null'
        shippingZip:
          oneOf:
            - $ref: '#/components/schemas/Shippingzip'
            - type: 'null'
        shippingCountry:
          oneOf:
            - $ref: '#/components/schemas/Shippingcountry'
            - type: 'null'
        customerId:
          $ref: '#/components/schemas/CustomerId'
        customerStatus:
          $ref: '#/components/schemas/CustomerStatus'
        additionalData:
          oneOf:
            - $ref: '#/components/schemas/AdditionalDataMap'
            - type: 'null'
    TransactionDetailEvent:
      type: object
      description: Event associated with transaction processing
      required:
        - transEvent
        - eventData
        - eventTime
      properties:
        transEvent:
          type: string
        eventData:
          type: string
        eventTime:
          type: string
    TransactionDetailRecord:
      type: object
      description: Complete transaction details including payment information, customer data, and processing metadata. This is returned when includeDetails=true.
      required:
        - parentOrgName
        - paypointDbaname
        - paypointLegalname
        - paypointEntryname
        - paymentTransId
        - connectorName
        - externalProcessorInformation
        - gatewayTransId
        - orderId
        - method
        - batchNumber
        - batchAmount
        - payorId
        - paymentData
        - transStatus
        - paypointId
        - totalAmount
        - netAmount
        - feeAmount
        - settlementStatus
        - operation
        - responseData
        - source
        - scheduleReference
        - orgId
        - refundId
        - returnedId
        - chargebackId
        - retrievalId
        - transAdditionalData
        - invoiceData
        - entrypageId
        - externalPaypointID
        - isValidatedACH
        - transactionTime
        - customer
        - splitFundingInstructions
        - cfeeTransactions
        - transactionEvents
        - riskStatus
        - riskReason
        - riskAction
        - deviceId
        - achSecCode
        - achHolderType
        - ipAddress
        - isSameDayACH
        - walletType
      properties:
        parentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        paypointDbaname:
          $ref: '#/components/schemas/Dbaname'
        paypointLegalname:
          $ref: '#/components/schemas/Legalname'
        paypointEntryname:
          $ref: '#/components/schemas/Entrypointfield'
        paymentTransId:
          type: string
        connectorName:
          type: string
        externalProcessorInformation:
          $ref: '#/components/schemas/ExternalProcessorInformation'
        gatewayTransId:
          type: string
        orderId:
          oneOf:
            - $ref: '#/components/schemas/OrderId'
            - type: 'null'
        method:
          $ref: '#/components/schemas/TransactionDetailRecordMethod'
        batchNumber:
          $ref: '#/components/schemas/BatchNumber'
        batchAmount:
          type: number
          format: double
        payorId:
          $ref: '#/components/schemas/PayorId'
        paymentData:
          $ref: '#/components/schemas/TransactionDetailPaymentData'
        transStatus:
          $ref: '#/components/schemas/TransStatus'
        paypointId:
          $ref: '#/components/schemas/PaypointId'
        totalAmount:
          type: number
          format: double
        netAmount:
          type: number
          format: double
        feeAmount:
          $ref: '#/components/schemas/FeeAmount'
        settlementStatus:
          $ref: '#/components/schemas/SettlementStatus'
        operation:
          $ref: '#/components/schemas/Operation'
        responseData:
          $ref: '#/components/schemas/TransactionDetailResponseData'
        source:
          $ref: '#/components/schemas/Source'
        scheduleReference:
          type: integer
          format: int64
        orgId:
          $ref: '#/components/schemas/Orgid'
        refundId:
          $ref: '#/components/schemas/RefundId'
        returnedId:
          $ref: '#/components/schemas/ReturnedId'
        chargebackId:
          $ref: '#/components/schemas/ChargebackId'
        retrievalId:
          $ref: '#/components/schemas/RetrievalId'
        transAdditionalData:
          oneOf:
            - {}
            - type: 'null'
        invoiceData:
          $ref: '#/components/schemas/TransactionDetailInvoiceData'
        entrypageId:
          $ref: '#/components/schemas/EntrypageId'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        isValidatedACH:
          type: boolean
        transactionTime:
          type: string
        customer:
          $ref: '#/components/schemas/TransactionDetailCustomer'
        splitFundingInstructions:
          oneOf:
            - $ref: '#/components/schemas/SplitFunding'
            - type: 'null'
        cfeeTransactions:
          type: array
          items:
            $ref: '#/components/schemas/QueryCFeeTransaction'
        transactionEvents:
          type: array
          items:
            $ref: '#/components/schemas/TransactionDetailEvent'
        pendingFeeAmount:
          $ref: '#/components/schemas/PendingFeeAmount'
        riskFlagged:
          $ref: '#/components/schemas/RiskFlagged'
        riskFlaggedOn:
          $ref: '#/components/schemas/RiskFlaggedOn'
        riskStatus:
          $ref: '#/components/schemas/RiskStatus'
        riskReason:
          $ref: '#/components/schemas/RiskReason'
        riskAction:
          $ref: '#/components/schemas/RiskAction'
        riskActionCode:
          $ref: '#/components/schemas/RiskActionCode'
        deviceId:
          $ref: '#/components/schemas/Device'
        achSecCode:
          $ref: '#/components/schemas/AchSecCode'
        achHolderType:
          $ref: '#/components/schemas/AchHolderType'
        ipAddress:
          $ref: '#/components/schemas/IpAddress'
        isSameDayACH:
          type: boolean
        walletType:
          type:
            - string
            - 'null'
    GetPaidResponseData:
      type: object
      description: Response data for GetPaid transactions
      required:
        - authCode
        - referenceId
        - resultCode
        - resultText
        - avsResponseText
        - cvvResponseText
        - customerId
      properties:
        authCode:
          oneOf:
            - $ref: '#/components/schemas/Authcode'
            - type: 'null'
        transactionDetails:
          description: Details of the transaction. Present only if `includeDetails` query parameter is set to `true` in the request.
          $ref: '#/components/schemas/TransactionDetailRecord'
        referenceId:
          $ref: '#/components/schemas/Referenceidtrans'
        resultCode:
          $ref: '#/components/schemas/ResultCode'
        resultText:
          $ref: '#/components/schemas/Resulttext'
        avsResponseText:
          $ref: '#/components/schemas/AvsResponseText'
        cvvResponseText:
          $ref: '#/components/schemas/CvvResponseText'
        customerId:
          $ref: '#/components/schemas/Customeridtrans'
        methodReferenceId:
          $ref: '#/components/schemas/MethodReferenceId'
    PayabliAPIResponseGetPaid:
      type: object
      description: General response for GetPaid endpoint supporting multiple payment methods
      required:
        - responseText
        - isSuccess
        - responseData
      properties:
        responseText:
          $ref: '#/components/schemas/ResponseText'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          type: string
        responseData:
          $ref: '#/components/schemas/GetPaidResponseData'
    ExpectedProcessingDateTime:
      type: string
      format: date-time
      description: |
        The expected time that the refund will be processed.
    ResponseDataRefunds:
      type: object
      required:
        - authCode
        - expectedProcessingDateTime
        - customerId
        - cvvResponseText
        - methodReferenceId
        - referenceId
        - resultCode
        - resultText
      properties:
        authCode:
          $ref: '#/components/schemas/Authcode'
        expectedProcessingDateTime:
          oneOf:
            - $ref: '#/components/schemas/ExpectedProcessingDateTime'
            - type: 'null'
        avsResponseText:
          description: This field isn't applicable to refund operations.
          $ref: '#/components/schemas/AvsResponseText'
        customerId:
          oneOf:
            - $ref: '#/components/schemas/CustomerId'
            - type: 'null'
        cvvResponseText:
          description: This field isn't applicable to refund operations.
          oneOf:
            - $ref: '#/components/schemas/CvvResponseText'
            - type: 'null'
        methodReferenceId:
          description: This field isn't applicable to refund operations.
          oneOf:
            - $ref: '#/components/schemas/MethodReferenceId'
            - type: 'null'
        referenceId:
          $ref: '#/components/schemas/Referenceidtrans'
        resultCode:
          $ref: '#/components/schemas/ResultCode'
        resultText:
          type: string
          description: Text description of the transaction result
    ReverseResponse:
      type: object
      required:
        - responseCode
        - roomId
        - isSuccess
        - responseText
        - responseData
      properties:
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        roomId:
          type: integer
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          $ref: '#/components/schemas/ResponseDataRefunds'
    RefundResponse:
      type: object
      required:
        - responseText
        - isSuccess
        - responseData
      properties:
        responseText:
          $ref: '#/components/schemas/ResponseText'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          $ref: '#/components/schemas/ResponseDataRefunds'
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
    SplitFundingRefundContent:
      type: object
      properties:
        accountId:
          type: string
          description: The accountId for the account the transaction was routed to.
        amount:
          type: number
          format: double
          description: The amount to refund to this account.
        description:
          type: string
          description: Refund description.
        originationEntryPoint:
          type: string
          description: The entrypoint the transaction belongs to.
    RefundDetail:
      type: object
      description: Object containing details about the refund, including line items and optional split instructions.
      properties:
        categories:
          type: array
          items:
            $ref: '#/components/schemas/PaymentCategories'
          description: 'Array of payment categories/line items describing the amount to be paid. Note: These categories are for information only and aren''t validated against the total amount provided.'
        splitRefunding:
          type: array
          items:
            $ref: '#/components/schemas/SplitFundingRefundContent'
          description: Array of objects containing split instructions for the refund.
    RequestRefund:
      type: object
      properties:
        amount:
          type: number
          format: double
          description: |-
            Amount to refund from original transaction, minus any service fees charged on the original transaction.

            The amount provided can't be greater than the original total amount of the transaction, minus service fees. For example, if a transaction was $90 plus a $10 service fee, you can refund up to $90.

            An amount equal to zero will refund the total amount authorized minus any service fee.
        ipaddress:
          $ref: '#/components/schemas/IpAddress'
        orderDescription:
          $ref: '#/components/schemas/Orderdescription'
        orderId:
          $ref: '#/components/schemas/OrderId'
        refundDetails:
          $ref: '#/components/schemas/RefundDetail'
        source:
          $ref: '#/components/schemas/Source'
    RefundWithInstructionsResponse:
      type: object
      required:
        - responseText
        - isSuccess
        - responseData
      properties:
        responseText:
          $ref: '#/components/schemas/ResponseText'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          $ref: '#/components/schemas/ResponseDataRefunds'
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
    Responsedata:
      type: object
      additionalProperties: {}
      description: The object containing the response data.
    PayabliApiResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          $ref: '#/components/schemas/Responsedata'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    ReceiptResponse:
      type: object
      description: Response for SendReceipt endpoint.
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    RequestPaymentValidatePaymentMethodMethod:
      type: string
      description: The card validation method.
      enum:
        - card
        - cloud
    RequestPaymentValidatePaymentMethod:
      type: object
      description: Object describing payment method to use for validation.
      required:
        - method
        - cardnumber
        - cardexp
        - cardzip
        - cardHolder
      properties:
        method:
          $ref: '#/components/schemas/RequestPaymentValidatePaymentMethodMethod'
        cardnumber:
          $ref: '#/components/schemas/Cardnumber'
        cardexp:
          $ref: '#/components/schemas/Cardexp'
        cardzip:
          $ref: '#/components/schemas/Cardzip'
        cardHolder:
          $ref: '#/components/schemas/Cardholder'
    RequestPaymentValidate:
      type: object
      required:
        - entryPoint
        - paymentMethod
      properties:
        accountId:
          $ref: '#/components/schemas/AccountId'
        entryPoint:
          $ref: '#/components/schemas/Entrypointfield'
        orderDescription:
          $ref: '#/components/schemas/Orderdescription'
        orderId:
          $ref: '#/components/schemas/OrderId'
        paymentMethod:
          description: Object describing payment method to use for transaction.
          $ref: '#/components/schemas/RequestPaymentValidatePaymentMethod'
    ValidateResponseData:
      type: object
      description: Response data for card validation
      required:
        - authCode
        - referenceId
        - resultCode
        - resultText
        - avsResponseText
        - cvvResponseText
        - customerId
      properties:
        authCode:
          $ref: '#/components/schemas/Authcode'
        referenceId:
          $ref: '#/components/schemas/Referenceidtrans'
        resultCode:
          $ref: '#/components/schemas/ResultCode'
        resultText:
          $ref: '#/components/schemas/Resulttext'
        avsResponseText:
          $ref: '#/components/schemas/AvsResponseText'
        cvvResponseText:
          $ref: '#/components/schemas/CvvResponseText'
        customerId:
          $ref: '#/components/schemas/Customeridtrans'
        methodReferenceId:
          $ref: '#/components/schemas/MethodReferenceId'
    ValidateResponse:
      type: object
      description: Response for card validation endpoint
      required:
        - responseText
        - isSuccess
        - responseData
      properties:
        responseText:
          $ref: '#/components/schemas/ResponseText'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          $ref: '#/components/schemas/ValidateResponseData'
    VoidResponseData:
      type: object
      description: Response data for void transactions
      required:
        - authCode
        - referenceId
        - resultCode
        - resultText
      properties:
        authCode:
          $ref: '#/components/schemas/Authcode'
        referenceId:
          $ref: '#/components/schemas/Referenceidtrans'
        resultCode:
          $ref: '#/components/schemas/ResultCode'
        resultText:
          $ref: '#/components/schemas/Resulttext'
        avsResponseText:
          $ref: '#/components/schemas/AvsResponseText'
        cvvResponseText:
          $ref: '#/components/schemas/CvvResponseText'
        customerId:
          $ref: '#/components/schemas/Customeridtrans'
        methodReferenceId:
          $ref: '#/components/schemas/MethodReferenceId'
    VoidResponse:
      type: object
      description: Response for MoneyIn/void endpoint
      required:
        - responseCode
        - roomId
        - isSuccess
        - responseText
        - responseData
      properties:
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        roomId:
          $ref: '#/components/schemas/RoomIdNotInUse'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          $ref: '#/components/schemas/VoidResponseData'
    V2ResponseCode:
      type: string
      description: Payabli's unified response code. Starts with `A` (Approved) or `D` (Declined) followed by a four-digit code that provides specific details about the transaction result. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
    V2ResponseReason:
      type: string
      description: Human-readable reason corresponding to the response code.
    V2ResponseExplanation:
      type: string
      description: Detailed description of the response code.
    V2ResponseAction:
      type: string
      description: Recommended resolution approach or next steps based on the response.
    CustomerVaultId:
      type: string
      x-fern-availability: in-development
    V2TransactionDetailResponseData:
      type: object
      description: Response data from payment processor
      required:
        - resultCode
        - resultCodeText
        - response
        - responsetext
        - authcode
        - transactionid
        - avsresponse
        - avsresponse_text
        - cvvresponse
        - cvvresponse_text
        - orderid
        - type
        - response_code
        - response_code_text
        - customer_vault_id
        - emv_auth_response_data
      properties:
        resultCode:
          $ref: '#/components/schemas/ResultCodev2'
        resultCodeText:
          $ref: '#/components/schemas/ResultCodeText'
        response:
          type:
            - string
            - 'null'
        responsetext:
          $ref: '#/components/schemas/Resulttext'
        authcode:
          oneOf:
            - $ref: '#/components/schemas/Authcode'
            - type: 'null'
        transactionid:
          type: string
          description: Unique identifier for the transaction assigned by the payment processor.
        avsresponse:
          oneOf:
            - $ref: '#/components/schemas/AvsResponse'
            - type: 'null'
        avsresponse_text:
          oneOf:
            - $ref: '#/components/schemas/AvsResponseText'
            - type: 'null'
        cvvresponse:
          oneOf:
            - $ref: '#/components/schemas/CvvResponse'
            - type: 'null'
        cvvresponse_text:
          oneOf:
            - $ref: '#/components/schemas/CvvResponseText'
            - type: 'null'
        orderid:
          oneOf:
            - $ref: '#/components/schemas/OrderId'
            - type: 'null'
        type:
          type:
            - string
            - 'null'
          x-fern-availability: in-development
        response_code:
          type: string
          description: Processor-specific response code.
        response_code_text:
          type: string
          description: Description of the response code.
        customer_vault_id:
          oneOf:
            - $ref: '#/components/schemas/CustomerVaultId'
            - type: 'null'
        emv_auth_response_data:
          oneOf:
            - $ref: '#/components/schemas/EmvAuthResponseData'
            - type: 'null'
    V2TransactionDetails:
      type: object
      description: Complete transaction details returned by v2 Money In endpoints. This matches the structure of the transaction details previously returned by the v1 details endpoint.
      required:
        - parentOrgName
        - paypointDbaname
        - paypointLegalname
        - paypointEntryname
        - paymentTransId
        - connectorName
        - externalProcessorInformation
        - gatewayTransId
        - orderId
        - method
        - batchNumber
        - batchAmount
        - payorId
        - paymentData
        - transStatus
        - paypointId
        - totalAmount
        - netAmount
        - feeAmount
        - settlementStatus
        - operation
        - responseData
        - source
        - scheduleReference
        - orgId
        - refundId
        - returnedId
        - chargebackId
        - retrievalId
        - transAdditionalData
        - invoiceData
        - entrypageId
        - externalPaypointID
        - isValidatedACH
        - transactionTime
        - customer
        - splitFundingInstructions
        - cfeeTransactions
        - transactionEvents
        - riskStatus
        - riskReason
        - riskAction
        - deviceId
        - achSecCode
        - achHolderType
        - ipAddress
        - isSameDayACH
        - walletType
      properties:
        parentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        paypointDbaname:
          $ref: '#/components/schemas/Dbaname'
        paypointLegalname:
          $ref: '#/components/schemas/Legalname'
        paypointEntryname:
          $ref: '#/components/schemas/Entrypointfield'
        paymentTransId:
          type: string
          description: Unique transaction identifier.
        connectorName:
          type: string
          description: Name of the payment connector used.
        externalProcessorInformation:
          $ref: '#/components/schemas/ExternalProcessorInformation'
        gatewayTransId:
          type: string
          description: Gateway transaction identifier.
        orderId:
          oneOf:
            - $ref: '#/components/schemas/OrderId'
            - type: 'null'
        method:
          type: string
          description: Payment method used for the transaction.
        batchNumber:
          $ref: '#/components/schemas/BatchNumber'
        batchAmount:
          type: number
          format: double
          description: Total amount in the batch.
        payorId:
          $ref: '#/components/schemas/PayorId'
        paymentData:
          $ref: '#/components/schemas/TransactionDetailPaymentData'
        transStatus:
          $ref: '#/components/schemas/TransStatus'
        paypointId:
          $ref: '#/components/schemas/PaypointId'
        totalAmount:
          type: number
          format: double
          description: Total transaction amount including fees.
        netAmount:
          type: number
          format: double
          description: Net transaction amount excluding fees.
        feeAmount:
          $ref: '#/components/schemas/FeeAmount'
        settlementStatus:
          $ref: '#/components/schemas/SettlementStatus'
        operation:
          $ref: '#/components/schemas/Operation'
        responseData:
          $ref: '#/components/schemas/V2TransactionDetailResponseData'
        source:
          $ref: '#/components/schemas/Source'
        scheduleReference:
          type: integer
          format: int64
          description: Reference to associated payment schedule if applicable.
        orgId:
          $ref: '#/components/schemas/Orgid'
        refundId:
          $ref: '#/components/schemas/RefundId'
        returnedId:
          $ref: '#/components/schemas/ReturnedId'
        chargebackId:
          $ref: '#/components/schemas/ChargebackId'
        retrievalId:
          $ref: '#/components/schemas/RetrievalId'
        transAdditionalData:
          oneOf:
            - {}
            - type: 'null'
        invoiceData:
          $ref: '#/components/schemas/TransactionDetailInvoiceData'
        entrypageId:
          $ref: '#/components/schemas/EntrypageId'
        externalPaypointID:
          oneOf:
            - $ref: '#/components/schemas/ExternalPaypointId'
            - type: 'null'
        isValidatedACH:
          type: boolean
          description: Indicates if ACH account was validated in real-time.
        transactionTime:
          type: string
          description: Timestamp when transaction was created.
        customer:
          $ref: '#/components/schemas/TransactionDetailCustomer'
        splitFundingInstructions:
          oneOf:
            - $ref: '#/components/schemas/SplitFunding'
            - type: 'null'
        cfeeTransactions:
          type: array
          items:
            $ref: '#/components/schemas/QueryCFeeTransaction'
        transactionEvents:
          type: array
          items:
            $ref: '#/components/schemas/TransactionDetailEvent'
        pendingFeeAmount:
          $ref: '#/components/schemas/PendingFeeAmount'
        riskFlagged:
          $ref: '#/components/schemas/RiskFlagged'
        riskFlaggedOn:
          $ref: '#/components/schemas/RiskFlaggedOn'
        riskStatus:
          $ref: '#/components/schemas/RiskStatus'
        riskReason:
          $ref: '#/components/schemas/RiskReason'
        riskAction:
          $ref: '#/components/schemas/RiskAction'
        riskActionCode:
          $ref: '#/components/schemas/RiskActionCode'
        deviceId:
          $ref: '#/components/schemas/Device'
        achSecCode:
          $ref: '#/components/schemas/AchSecCode'
        achHolderType:
          oneOf:
            - $ref: '#/components/schemas/AchHolderType'
            - type: 'null'
        ipAddress:
          $ref: '#/components/schemas/IpAddress'
        isSameDayACH:
          type: boolean
          description: Indicates if ACH transaction uses same-day processing.
        walletType:
          type:
            - string
            - 'null'
          description: Digital wallet type if applicable.
    V2TransactionResponseWrapper:
      type: object
      description: Standard response wrapper for v2 Money In transaction endpoints. All v2 transaction endpoints return responses in this format with consistent `code`, `reason`, `explanation`, and `action` fields. The `data` field contains transaction details.
      required:
        - code
        - reason
        - explanation
        - action
        - data
        - token
      properties:
        code:
          $ref: '#/components/schemas/V2ResponseCode'
        reason:
          $ref: '#/components/schemas/V2ResponseReason'
        explanation:
          $ref: '#/components/schemas/V2ResponseExplanation'
        action:
          $ref: '#/components/schemas/V2ResponseAction'
        data:
          $ref: '#/components/schemas/V2TransactionDetails'
        token:
          type:
            - string
            - 'null'
          description: Pagination token (equivalent to `pageIdentifier` in v1 APIs). Returns `null` when pagination is not applicable.
    V2BadRequestErrorDetail:
      type: object
      description: Individual field error detail for bad request responses.
      required:
        - message
        - suggestion
      properties:
        message:
          type: string
          description: Description of the validation error.
        suggestion:
          type: string
          description: Suggested action to fix the error.
    V2BadRequestError:
      type: object
      description: Bad request error response (HTTP 400) returned when request validation fails. Follows RFC 7807 Problem Details format with additional Payabli-specific fields.
      required:
        - type
        - title
        - status
        - detail
        - instance
        - code
        - errors
        - token
      properties:
        type:
          type: string
          description: A URI reference that identifies the problem type. Points to human-readable documentation for this error type.
        title:
          type: string
          description: Always "Bad Request" for 400 errors.
        status:
          type: integer
          description: HTTP status code, always 400 for bad requests.
        detail:
          type: string
          description: Short description of the error.
        instance:
          type: string
          description: Request URL that caused the error.
        code:
          type: string
          description: Payabli's unified response code for validation errors. Starts with 'E'. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/V2BadRequestErrorDetail'
          description: Dictionary of field-specific validation errors. Keys are field paths (e.g., "paymentMethod.cardnumber") and values are arrays of error details.
        token:
          type:
            - string
            - 'null'
          description: Pagination token (equivalent to pageIdentifier in v1 APIs). Usually null for errors.
    V2DeclinedTransactionResponseWrapper:
      type: object
      description: Response wrapper for declined v2 Money In transaction endpoints (HTTP 402). Returned when a transaction is declined by the card network or issuer. All decline responses use this format with unified response codes starting with 'D'. The `data` field contains transaction details.
      required:
        - code
        - reason
        - explanation
        - action
        - data
        - token
      properties:
        code:
          $ref: '#/components/schemas/V2ResponseCode'
        reason:
          $ref: '#/components/schemas/V2ResponseReason'
        explanation:
          $ref: '#/components/schemas/V2ResponseExplanation'
        action:
          $ref: '#/components/schemas/V2ResponseAction'
        data:
          $ref: '#/components/schemas/V2TransactionDetails'
        token:
          type:
            - string
            - 'null'
          description: Pagination token (equivalent to `pageIdentifier` in v1 APIs). Returns `null` when pagination is not applicable.
    V2InternalServerError:
      type: object
      description: Internal server error response (HTTP 500) returned when an unexpected error occurs. Follows RFC 7807 Problem Details format.
      required:
        - title
        - status
        - detail
        - instance
      properties:
        title:
          type: string
          description: Always "Internal Server Error" for 500 errors.
        status:
          type: integer
          description: HTTP status code, always 500 for internal errors.
        detail:
          type: string
          description: Additional details about the internal error.
        instance:
          type: string
          description: Request URL that caused the error.
    ScheduleDetail:
      type: object
      properties:
        endDate:
          type: string
          description: |
            Subscription end date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY or the value `untilcancelled` to indicate a scheduled payment with infinite cycle.

            Not applicable for `BalanceDriven` subscriptions, which run until cancelled.
        frequency:
          description: |
            Frequency of the subscription.

            `BalanceDriven` subscriptions only accept the monthly cadences `firstofmonth`, `fifteenthofmonth`, and `endofmonth`.
          $ref: '#/components/schemas/Frequency'
        planId:
          type: integer
          description: This field is for future development, leave null. Identifier of subscription plan applied in the scheduled payment/subscription.
        startDate:
          type: string
          description: |
            Subscription start date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. This must be a future date.

            Not applicable for `BalanceDriven` subscriptions, where the start date is calculated automatically from `frequency`.
    SetPause:
      type: boolean
      description: Flag indicating if subscription is paused. When a subscription is paused, no payments are processed until the subscription is unpaused, and the next payment date isn't calculated automatically. If you want to skip a payment instead, set the `totalAmount` to 0 in the `paymentDetails` object.
    RequestUpdateSchedule:
      type: object
      properties:
        paymentDetails:
          description: Object describing details of the payment. For Regular subscriptions, skip a payment by setting `totalAmount` to 0; payments pause until you update it to a non-zero value, and `serviceFee` must also be 0 when `totalAmount` is 0. For BalanceDriven subscriptions, any `totalAmount` you send is accepted but ignored at run time. Each run charges the payor's live balance, and a zero balance is skipped.
          $ref: '#/components/schemas/PaymentDetail'
        scheduleDetails:
          description: Object describing the schedule for subscription
          $ref: '#/components/schemas/ScheduleDetail'
        setPause:
          $ref: '#/components/schemas/SetPause'
    UpdateSubscriptionResponse:
      type: object
      description: Success response
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          type: string
          description: |-
            If `isSuccess` = true, this contains the identifier of the subscription, and sometimes extra information, depending on what was updated.

            If `isSuccess` = false, this contains the reason for the failure.
        responseText:
          $ref: '#/components/schemas/ResponseText'
        customerId:
          $ref: '#/components/schemas/CustomerId'
    RemoveSubscriptionResponse:
      type: object
      description: Success response
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          type: string
          description: |-
            If `isSuccess` = true, this contains the identifier of the subscription.

            If `isSuccess` = false, this contains the reason for the failure.
        responseText:
          $ref: '#/components/schemas/ResponseText'
    RequestSchedulePaymentMethodInitiator:
      type: object
      description: The required and recommended fields for a payment made with a stored payment method.
      properties:
        initiator:
          $ref: '#/components/schemas/Initiator'
        storedMethodId:
          description: Payabli identifier of a tokenized payment method.
          $ref: '#/components/schemas/Storedmethodid'
        storedMethodUsageType:
          $ref: '#/components/schemas/StoredMethodUsageType'
    RequestSchedulePaymentMethod:
      description: Information about the payment method for the transaction. Required and recommended fields for each payment method type are described in each schema below.
      oneOf:
        - $ref: '#/components/schemas/PayMethodCredit'
        - $ref: '#/components/schemas/PayMethodACH'
        - $ref: '#/components/schemas/RequestSchedulePaymentMethodInitiator'
    SubscriptionRequestBody:
      type: object
      properties:
        customerData:
          description: Object describing the customer/payor.
          $ref: '#/components/schemas/PayorDataRequest'
        entryPoint:
          $ref: '#/components/schemas/Entrypointfield'
        invoiceData:
          description: Object describing an Invoice linked to the subscription.
          $ref: '#/components/schemas/BillData'
        paymentDetails:
          description: Object describing details of the payment. For Regular subscriptions, skip a payment by setting `totalAmount` to 0; payments pause until you update it to a non-zero value, and `serviceFee` must also be 0 when `totalAmount` is 0. For BalanceDriven subscriptions, any `totalAmount` you send is accepted but ignored at run time. Each run charges the payor's live balance, and a zero balance is skipped.
          $ref: '#/components/schemas/PaymentDetail'
        paymentMethod:
          description: Information about the payment method for the transaction. Required and recommended fields for each payment method type are described in each schema below.
          $ref: '#/components/schemas/RequestSchedulePaymentMethod'
        scheduleDetails:
          description: Object describing the schedule for subscription.
          $ref: '#/components/schemas/ScheduleDetail'
        setPause:
          $ref: '#/components/schemas/SetPause'
        source:
          $ref: '#/components/schemas/Source'
        subdomain:
          $ref: '#/components/schemas/Subdomain'
        subscriptionType:
          description: |
            Subscription type. Defaults to `Regular` when omitted. Can't be changed after the subscription is created. If you send it to the update endpoint, it's ignored.
          $ref: '#/components/schemas/SubscriptionType'
    AddSubscriptionResponse:
      type: object
      description: Success response
      required:
        - responseText
        - responseData
      properties:
        customerId:
          $ref: '#/components/schemas/CustomerId'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          type: integer
          description: The identifier of the newly created subscription.
    BillOptions:
      type: object
      properties:
        includePaylink:
          type: boolean
          description: Flag to indicate if the scheduled invoice includes a payment link.
        includePdf:
          type: boolean
          description: Flag to indicate if the scheduled invoice includes a PDF version of invoice
    InvoiceDataRequest:
      type: object
      properties:
        customerData:
          description: Object describing the customer/payor. Required for POST requests. Which fields are required depends on the paypoint's custom identifier settings.
          $ref: '#/components/schemas/PayorDataRequest'
        invoiceData:
          description: Object describing the invoice. Required for POST requests.
          $ref: '#/components/schemas/BillData'
        scheduledOptions:
          description: Object with options for scheduled invoices.
          $ref: '#/components/schemas/BillOptions'
    InvoiceResponseWithoutData:
      type: object
      description: Response schema for invoice operations.
      required:
        - isSuccess
        - responseCode
        - responseData
        - responseText
        - pageidentifier
        - roomId
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          description: If `isSuccess` = true, this contains the identifier of the invoice. If `isSuccess` = false, this contains the reason for the failure.
          $ref: '#/components/schemas/Responsedatanonobject'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        pageidentifier:
          oneOf:
            - $ref: '#/components/schemas/PageIdentifier'
            - type: 'null'
        roomId:
          $ref: '#/components/schemas/RoomIdNotInUse'
    InvoiceId:
      type: integer
      format: int64
      description: Identifier of invoice.
    InvoicePaidAmount:
      type: number
      format: double
      description: Amount partially paid to the invoice.
    PayorDataResponse:
      type: object
      description: Customer information.
      required:
        - AdditionalData
        - BillingAddress1
        - BillingAddress2
        - BillingCity
        - BillingCountry
        - BillingEmail
        - BillingPhone
        - BillingState
        - BillingZip
        - CompanyName
        - customerId
        - CustomerNumber
        - customerStatus
        - FirstName
        - Identifiers
        - LastName
        - ShippingAddress1
        - ShippingAddress2
        - ShippingCity
        - ShippingCountry
        - ShippingState
        - ShippingZip
      properties:
        AdditionalData:
          oneOf:
            - $ref: '#/components/schemas/AdditionalDataMap'
            - type: 'null'
        BillingAddress1:
          oneOf:
            - $ref: '#/components/schemas/BillingAddressNullable'
            - type: 'null'
        BillingAddress2:
          oneOf:
            - $ref: '#/components/schemas/BillingAddressAddtlNullable'
            - type: 'null'
        BillingCity:
          oneOf:
            - $ref: '#/components/schemas/BillingCityNullable'
            - type: 'null'
        BillingCountry:
          oneOf:
            - $ref: '#/components/schemas/BillingCountryNullable'
            - type: 'null'
        BillingEmail:
          oneOf:
            - $ref: '#/components/schemas/Email'
            - type: 'null'
        BillingPhone:
          oneOf:
            - $ref: '#/components/schemas/PhoneNumber'
            - type: 'null'
        BillingState:
          oneOf:
            - $ref: '#/components/schemas/BillingStateNullable'
            - type: 'null'
        BillingZip:
          description: 'Customer''s billing ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: "37615-1234" or "37615".'
          oneOf:
            - $ref: '#/components/schemas/BillingZip'
            - type: 'null'
        CompanyName:
          type:
            - string
            - 'null'
          description: Customer's company name.
          maxLength: 250
        customerId:
          oneOf:
            - $ref: '#/components/schemas/CustomerId'
            - type: 'null'
        CustomerNumber:
          oneOf:
            - $ref: '#/components/schemas/CustomerNumberNullable'
            - type: 'null'
        customerStatus:
          description: Customer status. This is used to determine if the customer is active or inactive.
          oneOf:
            - $ref: '#/components/schemas/CustomerStatus'
            - type: 'null'
        FirstName:
          type:
            - string
            - 'null'
          description: Customer/Payor first name.
          maxLength: 250
        Identifiers:
          oneOf:
            - $ref: '#/components/schemas/Identifierfields'
            - type: 'null'
        LastName:
          type:
            - string
            - 'null'
          description: Customer/Payor last name.
          maxLength: 250
        ShippingAddress1:
          oneOf:
            - $ref: '#/components/schemas/Shippingaddress'
            - type: 'null'
        ShippingAddress2:
          oneOf:
            - $ref: '#/components/schemas/Shippingaddressadditional'
            - type: 'null'
        ShippingCity:
          oneOf:
            - $ref: '#/components/schemas/Shippingcity'
            - type: 'null'
        ShippingCountry:
          oneOf:
            - $ref: '#/components/schemas/Shippingcountry'
            - type: 'null'
        ShippingState:
          oneOf:
            - $ref: '#/components/schemas/Shippingstate'
            - type: 'null'
        ShippingZip:
          oneOf:
            - $ref: '#/components/schemas/Shippingzip'
            - type: 'null'
    GetInvoiceRecord:
      type: object
      required:
        - invoiceId
        - customerId
        - paypointId
        - invoiceNumber
        - invoiceDate
        - invoiceDueDate
        - invoiceSentDate
        - invoiceEndDate
        - lastPaymentDate
        - createdAt
        - invoiceStatus
        - invoiceType
        - frequency
        - paymentTerms
        - termsConditions
        - notes
        - invoiceAmount
        - invoicePaidAmount
        - purchaseOrder
        - shippingAddress1
        - shippingAddress2
        - shippingCity
        - shippingState
        - shippingZip
        - shippingFromZip
        - shippingCountry
        - shippingEmail
        - shippingPhone
        - summaryCommodityCode
        - items
        - Customer
        - paylinkId
        - scheduledOptions
        - PaypointLegalname
        - PaypointDbaname
        - PaypointEntryname
        - ParentOrgName
        - DocumentsRef
      properties:
        invoiceId:
          $ref: '#/components/schemas/InvoiceId'
        customerId:
          $ref: '#/components/schemas/CustomerId'
        paypointId:
          $ref: '#/components/schemas/PaypointId'
        invoiceNumber:
          $ref: '#/components/schemas/InvoiceNumber'
        invoiceDate:
          type:
            - string
            - 'null'
          format: date
        invoiceDueDate:
          type:
            - string
            - 'null'
          format: date
        invoiceSentDate:
          type:
            - string
            - 'null'
          format: date-time
        invoiceEndDate:
          type:
            - string
            - 'null'
          format: date
        lastPaymentDate:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        invoiceStatus:
          $ref: '#/components/schemas/Invoicestatus'
        invoiceType:
          $ref: '#/components/schemas/InvoiceType'
        frequency:
          $ref: '#/components/schemas/Frequency'
        paymentTerms:
          $ref: '#/components/schemas/Terms'
        termsConditions:
          oneOf:
            - $ref: '#/components/schemas/TermsConditions'
            - type: 'null'
        notes:
          type:
            - string
            - 'null'
        tax:
          $ref: '#/components/schemas/Tax'
        discount:
          $ref: '#/components/schemas/Discount'
        invoiceAmount:
          $ref: '#/components/schemas/InvoiceAmount'
        invoicePaidAmount:
          $ref: '#/components/schemas/InvoicePaidAmount'
        freightAmount:
          $ref: '#/components/schemas/FreightAmount'
        dutyAmount:
          $ref: '#/components/schemas/DutyAmount'
        purchaseOrder:
          $ref: '#/components/schemas/PurchaseOrder'
        firstName:
          type: string
          description: First name of the recipient of the invoice.
        lastName:
          type: string
          description: Last name of the recipient of the invoice.
        company:
          type: string
          description: Company name of the recipient of the invoice.
        shippingAddress1:
          $ref: '#/components/schemas/Shippingaddress'
        shippingAddress2:
          $ref: '#/components/schemas/Shippingaddressadditional'
        shippingCity:
          $ref: '#/components/schemas/Shippingcity'
        shippingState:
          $ref: '#/components/schemas/Shippingstate'
        shippingZip:
          $ref: '#/components/schemas/Shippingzip'
        shippingFromZip:
          $ref: '#/components/schemas/ShippingFromZip'
        shippingCountry:
          $ref: '#/components/schemas/Shippingcountry'
        shippingEmail:
          $ref: '#/components/schemas/Email'
        shippingPhone:
          type: string
        summaryCommodityCode:
          $ref: '#/components/schemas/SummaryCommodityCode'
        items:
          type: array
          items:
            $ref: '#/components/schemas/BillItem'
        Customer:
          $ref: '#/components/schemas/PayorDataResponse'
        paylinkId:
          $ref: '#/components/schemas/PaylinkId'
        billEvents:
          $ref: '#/components/schemas/BillEvents'
        scheduledOptions:
          $ref: '#/components/schemas/BillOptions'
        PaypointLegalname:
          type: string
        PaypointDbaname:
          $ref: '#/components/schemas/Dbaname'
        PaypointEntryname:
          $ref: '#/components/schemas/Entrypointfield'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        AdditionalData:
          $ref: '#/components/schemas/AdditionalDataMap'
        DocumentsRef:
          $ref: '#/components/schemas/DocumentsRef'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
    InvoiceNumberResponse:
      type: object
      description: Response schema for operations for sending invoices or getting next invoice number.
      required:
        - isSuccess
        - responseText
        - responseData
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          type: string
          description: If `isSuccess` = true, this contains the next available invoice number in the format defined by paypoint settings. If `isSuccess` = false, this contains the reason for the error.
    QueryInvoiceResponseRecordsItem:
      type: object
      required:
        - invoiceId
        - customerId
        - paypointId
        - invoiceNumber
        - invoiceDate
        - invoiceDueDate
        - invoiceSentDate
        - invoiceEndDate
        - lastPaymentDate
        - createdAt
        - invoiceStatus
        - invoiceType
        - frequency
        - paymentTerms
        - termsConditions
        - notes
        - invoiceAmount
        - invoicePaidAmount
        - purchaseOrder
        - firstName
        - lastName
        - company
        - shippingAddress1
        - shippingAddress2
        - shippingCity
        - shippingState
        - shippingZip
        - shippingFromZip
        - shippingCountry
        - shippingEmail
        - shippingPhone
        - summaryCommodityCode
        - items
        - Customer
        - paylinkId
        - scheduledOptions
        - PaypointLegalname
        - PaypointDbaname
        - PaypointEntryname
        - ParentOrgId
        - ParentOrgName
        - AdditionalData
        - DocumentsRef
        - externalPaypointID
        - pageIdentifier
      properties:
        invoiceId:
          $ref: '#/components/schemas/InvoiceId'
        customerId:
          $ref: '#/components/schemas/CustomerId'
        paypointId:
          $ref: '#/components/schemas/PaypointId'
        invoiceNumber:
          $ref: '#/components/schemas/InvoiceNumber'
        invoiceDate:
          type:
            - string
            - 'null'
          format: date
          description: 'Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
        invoiceDueDate:
          type:
            - string
            - 'null'
          format: date
          description: 'Invoice due date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
        invoiceSentDate:
          type:
            - string
            - 'null'
          format: date
          description: 'Invoice sent date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
        invoiceEndDate:
          type:
            - string
            - 'null'
          format: date
          description: The end date for a scheduled invoice cycle (`invoiceType` = 1).
        lastPaymentDate:
          type:
            - string
            - 'null'
          format: date-time
          description: Timestamp of last payment.
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        invoiceStatus:
          $ref: '#/components/schemas/Invoicestatus'
        invoiceType:
          $ref: '#/components/schemas/InvoiceType'
        frequency:
          description: Frequency of scheduled invoice.
          $ref: '#/components/schemas/Frequency'
        paymentTerms:
          $ref: '#/components/schemas/Terms'
        termsConditions:
          oneOf:
            - $ref: '#/components/schemas/TermsConditions'
            - type: 'null'
        notes:
          type:
            - string
            - 'null'
          description: Invoice notes.
        tax:
          $ref: '#/components/schemas/Tax'
        discount:
          $ref: '#/components/schemas/Discount'
        invoiceAmount:
          $ref: '#/components/schemas/InvoiceAmount'
        invoicePaidAmount:
          $ref: '#/components/schemas/InvoicePaidAmount'
        freightAmount:
          $ref: '#/components/schemas/FreightAmount'
        dutyAmount:
          $ref: '#/components/schemas/DutyAmount'
        purchaseOrder:
          oneOf:
            - $ref: '#/components/schemas/PurchaseOrder'
            - type: 'null'
        firstName:
          type: string
          description: First name of the recipient of the invoice.
        lastName:
          type: string
          description: Last name of the recipient of the invoice.
        company:
          type:
            - string
            - 'null'
          description: Company name of the recipient of the invoice.
        shippingAddress1:
          $ref: '#/components/schemas/Shippingaddress'
        shippingAddress2:
          $ref: '#/components/schemas/Shippingaddressadditional'
        shippingCity:
          $ref: '#/components/schemas/Shippingcity'
        shippingState:
          $ref: '#/components/schemas/Shippingstate'
        shippingZip:
          $ref: '#/components/schemas/Shippingzip'
        shippingFromZip:
          $ref: '#/components/schemas/ShippingFromZip'
        shippingCountry:
          $ref: '#/components/schemas/Shippingcountry'
        shippingEmail:
          description: Shipping recipient's contact email address.
          $ref: '#/components/schemas/Email'
        shippingPhone:
          type: string
          description: Recipient phone number.
        summaryCommodityCode:
          oneOf:
            - $ref: '#/components/schemas/SummaryCommodityCode'
            - type: 'null'
        items:
          type: array
          items:
            $ref: '#/components/schemas/BillItem'
          description: Array of line items included in the invoice.
        Customer:
          $ref: '#/components/schemas/PayorDataResponse'
        paylinkId:
          type: string
        billEvents:
          $ref: '#/components/schemas/BillEvents'
        scheduledOptions:
          description: Object with options for scheduled invoices.
          oneOf:
            - $ref: '#/components/schemas/BillOptions'
            - type: 'null'
        PaypointLegalname:
          description: Paypoint's legal name.
          $ref: '#/components/schemas/Legalname'
        PaypointDbaname:
          description: Paypoint's DBA name.
          $ref: '#/components/schemas/Dbaname'
        PaypointEntryname:
          description: Paypoint's entryname.
          $ref: '#/components/schemas/Entrypointfield'
        ParentOrgId:
          $ref: '#/components/schemas/Orgid'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        AdditionalData:
          type:
            - object
            - 'null'
          additionalProperties: {}
          description: Custom list of key:value pairs. This field is used to store any data related to the invoice or for your system.
        DocumentsRef:
          description: Object containing attachments associated to the invoice.
          oneOf:
            - $ref: '#/components/schemas/DocumentsRef'
            - type: 'null'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        pageIdentifier:
          oneOf:
            - $ref: '#/components/schemas/PageIdentifier'
            - type: 'null'
    QuerySummary:
      type: object
      properties:
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        pageSize:
          $ref: '#/components/schemas/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/Totalrecords'
        totalRecords:
          $ref: '#/components/schemas/Totalrecords'
    QueryInvoiceResponse:
      type: object
      required:
        - Records
        - Summary
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/QueryInvoiceResponseRecordsItem'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    SendInvoiceResponse:
      type: object
      required:
        - isSuccess
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    File:
      type: object
      additionalProperties: {}
      description: A file containing the response data, in the format specified in the request.
    Enabled:
      type: boolean
      description: Toggles whether the section or element is enabled.
    Order:
      type: integer
      minimum: 0
      description: Order of element or section in container.
    ContactElement:
      type: object
      properties:
        emailLabel:
          type: string
          description: Custom content for email
        enabled:
          $ref: '#/components/schemas/Enabled'
        header:
          type: string
          description: Header text for section
        order:
          $ref: '#/components/schemas/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
    LabelElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/Enabled'
        label:
          type: string
          description: Label to display for section or element
        order:
          $ref: '#/components/schemas/Order'
    InvoiceElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/Enabled'
        invoiceLink:
          description: Link to invoice
          $ref: '#/components/schemas/LabelElement'
        order:
          $ref: '#/components/schemas/Order'
        viewInvoiceDetails:
          description: Link to view invoice details
          $ref: '#/components/schemas/LabelElement'
    Element:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/Enabled'
        order:
          $ref: '#/components/schemas/Order'
    NoteElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/Enabled'
        header:
          type: string
          description: Header text for section
        order:
          $ref: '#/components/schemas/Order'
        placeholder:
          type: string
          description: Placeholder text for input field
        value:
          type: string
          description: Pre-populated value for input field
    PageElement:
      type: object
      properties:
        description:
          type: string
          description: Page description in header
        enabled:
          $ref: '#/components/schemas/Enabled'
        header:
          type: string
          description: Page header
        order:
          $ref: '#/components/schemas/Order'
    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.
    MethodElementSettingsApplePayButtonStyle:
      type: string
      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.
      enum:
        - black
        - white-outline
        - white
      x-fern-enum:
        white-outline:
          name: WhiteOutline
    MethodElementSettingsApplePayButtonType:
      type: string
      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.
      enum:
        - plain
        - buy
        - donate
        - check-out
        - book
        - continue
        - top-up
        - order
        - rent
        - support
        - contribute
        - tip
        - pay
      x-fern-enum:
        check-out:
          name: CheckOut
        top-up:
          name: TopUp
    MethodElementSettingsApplePayLanguage:
      type: string
      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.
      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
      x-fern-enum:
        en-US:
          name: EnUs
        ar-AB:
          name: ArAb
        ca-ES:
          name: CaEs
        zh-CN:
          name: ZhCn
        zh-HK:
          name: ZhHk
        zh-TW:
          name: ZhTw
        hr-HR:
          name: HrHr
        cs-CZ:
          name: CsCz
        da-DK:
          name: DaDk
        de-DE:
          name: DeDe
        nl-NL:
          name: NlNl
        en-AU:
          name: EnAu
        en-GB:
          name: EnGb
        fi-FI:
          name: FiFi
        fr-CA:
          name: FrCa
        fr-FR:
          name: FrFr
        el-GR:
          name: ElGr
        he-IL:
          name: HeIl
        hi-IN:
          name: HiIn
        hu-HU:
          name: HuHu
        id-ID:
          name: IdId
        it-IT:
          name: ItIt
        ja-JP:
          name: JaJp
        ko-KR:
          name: KoKr
        ms-MY:
          name: MsMy
        nb-NO:
          name: NbNo
        pl-PL:
          name: PlPl
        pt-BR:
          name: PtBr
        pt-PT:
          name: PtPt
        ro-RO:
          name: RoRo
        ru-RU:
          name: RuRu
        sk-SK:
          name: SkSk
        es-MX:
          name: EsMx
        es-ES:
          name: EsEs
        sv-SE:
          name: SvSe
        th-TH:
          name: ThTh
        tr-TR:
          name: TrTr
        uk-UA:
          name: UkUa
        vi-VN:
          name: ViVn
    MethodElementSettingsApplePay:
      type: object
      properties:
        buttonStyle:
          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.
          $ref: '#/components/schemas/MethodElementSettingsApplePayButtonStyle'
          default: black
        buttonType:
          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.
          $ref: '#/components/schemas/MethodElementSettingsApplePayButtonType'
          default: pay
        language:
          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.
          $ref: '#/components/schemas/MethodElementSettingsApplePayLanguage'
          default: en-US
    MethodElementSettings:
      type: object
      description: Settings for wallet payment methods.
      properties:
        applePay:
          $ref: '#/components/schemas/MethodElementSettingsApplePay'
    MethodElement:
      type: object
      properties:
        allMethodsChecked:
          type: boolean
          description: Flag indicating if all allowed payment methods will be pre-selected.
        enabled:
          $ref: '#/components/schemas/Enabled'
        header:
          type: string
          description: Header text for section
        methods:
          $ref: '#/components/schemas/MethodsList'
        order:
          $ref: '#/components/schemas/Order'
        settings:
          description: Settings for wallet payment methods.
          $ref: '#/components/schemas/MethodElementSettings'
    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/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
    PayorElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/Enabled'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/PayorFields'
          description: Array of Customer/Payor fields to show in section
        header:
          type: string
          description: Custom header text for section
        order:
          $ref: '#/components/schemas/Order'
    HeaderElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/Enabled'
        header:
          type: string
          description: Header text for section
        order:
          $ref: '#/components/schemas/Order'
    PagelinkSetting:
      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:
          description: Object containing logo file to upload/ use in page
          $ref: '#/components/schemas/FileContent'
        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
    PaymentPageRequestBody:
      type: object
      properties:
        contactUs:
          description: ContactUs section of payment link page
          $ref: '#/components/schemas/ContactElement'
        invoices:
          description: Invoices section of payment link page
          $ref: '#/components/schemas/InvoiceElement'
        logo:
          description: Logo section of payment link page
          $ref: '#/components/schemas/Element'
        messageBeforePaying:
          description: Message section of payment link page
          $ref: '#/components/schemas/LabelElement'
        notes:
          description: Notes section of payment link page
          $ref: '#/components/schemas/NoteElement'
        page:
          description: Page header section of payment link page
          $ref: '#/components/schemas/PageElement'
        paymentButton:
          description: Payment button section of payment link page
          $ref: '#/components/schemas/LabelElement'
        paymentMethods:
          description: Payment methods section of payment link page
          $ref: '#/components/schemas/MethodElement'
        payor:
          description: Customer/Payor section of payment link page
          $ref: '#/components/schemas/PayorElement'
        review:
          description: Review section of payment link page
          $ref: '#/components/schemas/HeaderElement'
        settings:
          description: Settings section of payment link page
          $ref: '#/components/schemas/PagelinkSetting'
    PayabliApiResponsePaymentLinks:
      type: object
      required:
        - isSuccess
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          type: string
          description: If `isSuccess` = true, this contains the payment link identifier. If `isSuccess` = false, this contains the reason of the error.
        responseText:
          $ref: '#/components/schemas/ResponseText'
    MethodsListOut:
      type: object
      description: Payment methods available for Pay Out payment links. Controls which payout options are offered to the vendor.
      properties:
        ach:
          type: boolean
          description: When `true`, ACH bank transfer is offered as a payout method.
        check:
          type: boolean
          description: When `true`, physical check is offered as a payout method.
        vcard:
          type: boolean
          description: When `true`, virtual card (vCard) is offered as a payout method.
    MethodElementOut:
      type: object
      description: Configuration for payment method selection on Pay Out payment links.
      properties:
        allMethodsChecked:
          type: boolean
          description: Flag indicating if all allowed payment methods will be pre-selected.
        allowMultipleMethods:
          type: boolean
          description: When `true`, the vendor can select from multiple payment methods. When `false`, only the default method is shown.
        defaultMethod:
          type: string
          description: The default payment method to highlight on the payment link page. For example, `"vcard"`, `"ach"`, or `"check"`.
        enabled:
          type: boolean
          description: When `true`, the payment methods section is displayed on the payment link page.
        header:
          type: string
          description: Header text for the payment methods section.
        methods:
          $ref: '#/components/schemas/MethodsListOut'
        order:
          type: integer
          description: Display order of the payment methods section on the page.
        showPreviewVirtualCard:
          type: boolean
          description: When `true`, a preview of the virtual card is shown on the payment link page.
    PaymentPageRequestBodyOut:
      type: object
      description: Configuration for the Pay Out payment link page. Controls branding, messaging, vendor fields, and which payout methods are offered to the vendor.
      properties:
        contactUs:
          description: ContactUs section of payment link page.
          $ref: '#/components/schemas/ContactElement'
        logo:
          description: Logo section of payment link page.
          $ref: '#/components/schemas/Element'
        messageBeforePaying:
          description: Message section of payment link page.
          $ref: '#/components/schemas/LabelElement'
        notes:
          description: Notes section of payment link page.
          $ref: '#/components/schemas/NoteElement'
        page:
          description: Page header section of payment link page.
          $ref: '#/components/schemas/PageElement'
        paymentButton:
          description: Payment button section of payment link page.
          $ref: '#/components/schemas/LabelElement'
        paymentMethods:
          description: Payment methods section of payment link page. Use this to configure which payout methods (ACH, vCard, check) are offered to the vendor.
          $ref: '#/components/schemas/MethodElementOut'
        review:
          description: Review section of payment link page.
          $ref: '#/components/schemas/HeaderElement'
        bills:
          description: Bills section of payment link page.
          $ref: '#/components/schemas/Element'
        settings:
          description: Settings section of payment link page.
          $ref: '#/components/schemas/PagelinkSetting'
    GreaterValueAllowed:
      type: boolean
      description: |
        When `true`, the customer can pay an amount greater than the invoice or
        bill amount.
    AbsorbDifference:
      type: boolean
      description: |
        Whether the paypoint absorbs the difference between the configured service
        fee and the actual fee charged to the customer.
    AllowOverride:
      type: boolean
      description: |
        Whether the configured service fee can be overridden at the transaction
        level.
    PayabliCredentials:
      type: object
      properties:
        accountId:
          description: The identifier for the payment connector, matching the `accountId` of the linked bank account.
          $ref: '#/components/schemas/AccountId'
        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/GreaterValueAllowed'
        absorbDifference:
          $ref: '#/components/schemas/AbsorbDifference'
        allowOverride:
          $ref: '#/components/schemas/AllowOverride'
    PayCategory:
      type: object
      properties:
        description:
          type: string
        label:
          type: string
        name:
          type: string
        optionalPay:
          type: boolean
        order:
          $ref: '#/components/schemas/Order'
        quantity:
          type: integer
        showDescription:
          type: boolean
        type:
          type: string
        value:
          type: string
    AmountElement:
      type: object
      properties:
        categories:
          type: array
          items:
            $ref: '#/components/schemas/PayCategory'
        enabled:
          $ref: '#/components/schemas/Enabled'
        order:
          $ref: '#/components/schemas/Order'
    Finishtype:
      type: object
      properties:
        calendar:
          type: boolean
          description: Flag to enable the 'calendar' option.
        untilCancelled:
          type: boolean
          description: Flag to enable the 'untilCancelled' option.
    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.
    AutoElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/Enabled'
        finish:
          description: Type of end date
          $ref: '#/components/schemas/Finishtype'
        frequency:
          description: accepted frequencies for autopay
          $ref: '#/components/schemas/FrequencyList'
        frequencySelected:
          type: string
          description: Value of pre-selected frequency
        header:
          type: string
          description: Header text for section
        order:
          $ref: '#/components/schemas/Order'
        startDate:
          type: string
          description: Range of days enabled in calendar. Leave empty to enable all days.
    PageContent:
      type: object
      properties:
        amount:
          description: Amount section of payment page
          $ref: '#/components/schemas/AmountElement'
        autopay:
          description: Autopay section of payment page
          $ref: '#/components/schemas/AutoElement'
        contactUs:
          description: ContactUs section of payment page
          $ref: '#/components/schemas/ContactElement'
        entry:
          type: string
          description: Identifier of entry point owner of page
        invoices:
          description: Invoices section of payment page
          $ref: '#/components/schemas/InvoiceElement'
        logo:
          description: Logo section of payment page
          $ref: '#/components/schemas/Element'
        messageBeforePaying:
          description: Message section of payment page
          $ref: '#/components/schemas/LabelElement'
        name:
          type: string
          description: Descriptor of page
        notes:
          description: Notes section of payment page
          $ref: '#/components/schemas/NoteElement'
        page:
          description: Page header section of payment page
          $ref: '#/components/schemas/PageElement'
        paymentButton:
          description: Payment button section of payment page
          $ref: '#/components/schemas/LabelElement'
        paymentMethods:
          description: Payment methods section of payment page
          $ref: '#/components/schemas/MethodElement'
        payor:
          description: Customer/Payor section of payment page
          $ref: '#/components/schemas/PayorElement'
        review:
          description: Review section of payment page
          $ref: '#/components/schemas/HeaderElement'
        subdomain:
          description: Unique identifier assigned to the page.
          $ref: '#/components/schemas/Subdomain'
    ButtonElementSize:
      type: string
      description: Specify the size of the custom payment button.
      enum:
        - sm
        - md
        - lg
    ButtonElement:
      type: object
      required:
        - label
      properties:
        label:
          type: string
          description: Label for custom payment button
        size:
          description: Specify size of custom payment button
          $ref: '#/components/schemas/ButtonElementSize'
    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:
          description: Object containing logo file to upload/ use in page
          $ref: '#/components/schemas/FileContent'
        paymentButton:
          $ref: '#/components/schemas/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
    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.
    SettingElement:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/Enabled'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/DisplayProperty'
          description: Fields to display on the reciept.
        order:
          $ref: '#/components/schemas/Order'
        sendAuto:
          type: boolean
          description: When `true`, Payabli automatically sends the receipt to the payor email address.
          default: true
        sendManual:
          type: boolean
          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.
          default: false
    ReceiptContent:
      type: object
      description: Object containing receipt body configuration
      properties:
        amount:
          description: Section amount of payment receipt
          $ref: '#/components/schemas/Element'
        contactUs:
          description: Section contactUs of payment receipt
          $ref: '#/components/schemas/Element'
        details:
          description: Section payment details of payment receipt
          $ref: '#/components/schemas/Element'
        logo:
          description: Section logo of payment receipt
          $ref: '#/components/schemas/Element'
        messageBeforeButton:
          description: Section message of payment receipt
          $ref: '#/components/schemas/LabelElement'
        page:
          description: Section page of payment receipt
          $ref: '#/components/schemas/PageElement'
        paymentButton:
          description: Section payment button of payment receipt
          $ref: '#/components/schemas/LabelElement'
        paymentInformation:
          description: Section payment information of payment receipt
          $ref: '#/components/schemas/Element'
        settings:
          description: The receipt's settings.
          $ref: '#/components/schemas/SettingElement'
    PayabliPages:
      type: object
      properties:
        AdditionalData:
          $ref: '#/components/schemas/AdditionalData'
        Credentials:
          type: array
          items:
            $ref: '#/components/schemas/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:
          description: Sections of page
          $ref: '#/components/schemas/PageContent'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        PageSettings:
          description: Settings of page
          $ref: '#/components/schemas/PageSetting'
        published:
          type: integer
          description: Flag indicating if page is active to accept payments. `0` for false, `1` for true.
        ReceiptContent:
          description: Sections of payment receipt
          $ref: '#/components/schemas/ReceiptContent'
        Subdomain:
          description: Page identifier. Must be unique in platform.
          $ref: '#/components/schemas/Subdomain'
        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
    GetPayLinkFromIdResponseResponseData:
      allOf:
        - $ref: '#/components/schemas/PayabliPages'
    GetPayLinkFromIdResponse:
      allOf:
        - $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
        - type: object
          properties:
            responseData:
              $ref: '#/components/schemas/GetPayLinkFromIdResponseResponseData'
    PushPayLinkRequestEmail:
      type: object
      properties:
        additionalEmails:
          type: array
          items:
            type: string
          description: |-
            List of additional email addresses you want to send the paylink to, formatted as an array.
            Payment links and opt-in requests are sent to the customer email address on file, and additional
            recipients can be specified here.
        attachFile:
          type: boolean
          description: When `true`, attaches a PDF version of the invoice to the email.
    PushPayLinkRequestSms:
      type: object
      properties: {}
    PushPayLinkRequest:
      description: Request body for the push paylink operation.
      oneOf:
        - $ref: '#/components/schemas/PushPayLinkRequestEmail'
        - $ref: '#/components/schemas/PushPayLinkRequestSms'
      discriminator:
        propertyName: channel
        mapping:
          email: '#/components/schemas/PushPayLinkRequestEmail'
          sms: '#/components/schemas/PushPayLinkRequestSms'
    PayLinkUpdateData:
      type: object
      properties:
        contactUs:
          description: ContactUs section of payment link page
          $ref: '#/components/schemas/ContactElement'
        logo:
          description: Logo section of payment link page
          $ref: '#/components/schemas/Element'
        messageBeforePaying:
          description: Message section of payment link page
          $ref: '#/components/schemas/LabelElement'
        notes:
          description: Notes section of payment link page
          $ref: '#/components/schemas/NoteElement'
        page:
          description: Page header section of payment link page
          $ref: '#/components/schemas/PageElement'
        paymentButton:
          description: Payment button section of payment link page
          $ref: '#/components/schemas/LabelElement'
        paymentMethods:
          description: Payment methods section of payment link page
          $ref: '#/components/schemas/MethodElement'
        review:
          description: Review section of payment link page
          $ref: '#/components/schemas/HeaderElement'
        settings:
          description: Settings section of payment link page
          $ref: '#/components/schemas/PagelinkSetting'
    PaymentLinkStatus:
      type: string
      description: The status of a payment link.
      enum:
        - Active
        - Expired
        - Canceled
        - Deleted
    PatchOutPaymentLinkRequest:
      type: object
      description: Request body for partially updating a Pay Out payment link.
      properties:
        billPageData:
          description: Updated payment link page configuration.
          $ref: '#/components/schemas/PaymentPageRequestBodyOut'
        expirationDate:
          type: string
          description: New expiration date for the payment link. Must be a future date. If null and the link is expired, uses the default expiration from settings. Updating the expiration date reactivates an expired payment link to Active status.
        status:
          description: Updated status for the payment link.
          $ref: '#/components/schemas/PaymentLinkStatus'
    CreateAnonymous:
      type: boolean
      description: When `true`, creates a saved method with no associated customer information. The token will be associated with customer information the first time it's used to make a payment. Defaults to `false`.
    Temporary:
      type: boolean
      description: Creates a temporary, one-time-use token for the payment method that expires in 12 hours. Defaults to `false`.
    TokenizeCard:
      type: object
      required:
        - method
        - cardexp
        - cardHolder
        - cardnumber
      properties:
        method:
          type: string
          description: The type of payment method to tokenize. For cards, this is always `card`.
        cardcvv:
          $ref: '#/components/schemas/Cardcvv'
        cardexp:
          $ref: '#/components/schemas/Cardexp'
        cardHolder:
          $ref: '#/components/schemas/Cardholder'
        cardnumber:
          $ref: '#/components/schemas/Cardnumber'
        cardzip:
          $ref: '#/components/schemas/Cardzip'
    TokenizeACH:
      type: object
      required:
        - method
        - achAccount
        - achAccountType
        - achHolder
        - achRouting
      properties:
        method:
          type: string
          description: The type of payment method to tokenize. For ACH, this is always `ach`.
        achAccount:
          $ref: '#/components/schemas/Achaccount'
        achAccountType:
          $ref: '#/components/schemas/Achaccounttype'
        achCode:
          $ref: '#/components/schemas/AchSecCode'
        achHolder:
          type: string
          description: Bank account holder. This field is **required** when `method` is `ach`. Only letters, numbers, spaces, hyphens, apostrophes, and periods are allowed.
          minLength: 2
          maxLength: 100
          pattern: ^[A-Za-z0-9\s\-'.]+$
        achHolderType:
          $ref: '#/components/schemas/AchHolderType'
        achRouting:
          $ref: '#/components/schemas/Achrouting'
        device:
          $ref: '#/components/schemas/Device'
    ConvertToken:
      type: object
      description: Object containing the information needed to convert a temporary token to a permanent token.
      required:
        - method
        - tokenId
      properties:
        method:
          type: string
          description: The type of payment method to tokenize. When converting a temp token to a permanent token, this should match the `method` set for the temporary token, either `ach` or `card`.
        tokenId:
          type: string
          description: A temporary stored token ID to be converted to permanent.
    RequestTokenStoragePaymentMethod:
      description: Information about the payment method for the transaction.
      oneOf:
        - $ref: '#/components/schemas/TokenizeCard'
        - $ref: '#/components/schemas/TokenizeACH'
        - $ref: '#/components/schemas/ConvertToken'
    VendorDataRequest:
      type: object
      description: Object describing the vendor owner of payment method. Required when saving an ACH payment method on behalf of a vendor (for Pay Out transactions).
      properties:
        vendorId:
          type: integer
          format: int64
          description: The unique numeric ID assigned to the vendor in Payabli. Either `vendorId` or `vendorNumber` is required.
        vendorNumber:
          type: string
          description: Custom vendor number assigned by the business. Either `vendorId` or `vendorNumber` is required.
    RequestTokenStorage:
      type: object
      properties:
        customerData:
          description: Object describing the Customer/Payor owner of payment method. Required for POST requests. Which fields are required depends on the paypoint's custom identifier settings.
          $ref: '#/components/schemas/PayorDataRequest'
        entryPoint:
          description: Entrypoint identifier. Required for POST requests.
          $ref: '#/components/schemas/Entrypointfield'
        fallbackAuth:
          type: boolean
          description: When `true`, if tokenization fails, Payabli will attempt an authorization transaction to request a permanent token for the card. If the authorization is successful, the card will be tokenized and the authorization will be voided automatically.
          default: false
        fallbackAuthAmount:
          type: integer
          description: The amount for the `fallbackAuth` transaction. Defaults to one dollar (`100`).
          default: 100
        methodDescription:
          type: string
          description: Custom description for stored payment method.
        paymentMethod:
          description: Information about the payment method for the transaction.
          $ref: '#/components/schemas/RequestTokenStoragePaymentMethod'
        vendorData:
          $ref: '#/components/schemas/VendorDataRequest'
        source:
          description: Custom identifier to indicate the source for the request
          $ref: '#/components/schemas/Source'
        subdomain:
          $ref: '#/components/schemas/Subdomain'
    AddMethodResponseResponseData:
      type: object
      properties:
        referenceId:
          description: Stored method identifier in Payabli platform. This ID is used to manage the stored method.
          $ref: '#/components/schemas/MethodReferenceId'
        resultCode:
          $ref: '#/components/schemas/ResultCode'
        resultText:
          $ref: '#/components/schemas/Resulttext'
        customerId:
          description: |-
            Internal unique ID of customer owner of the stored method.

            Returns `0` if the method wasn't assigned to an existing customer or no customer was created.
          $ref: '#/components/schemas/CustomerId'
        methodReferenceId:
          $ref: '#/components/schemas/MethodReferenceId'
    AddMethodResponse:
      allOf:
        - $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
        - type: object
          properties:
            responseData:
              $ref: '#/components/schemas/AddMethodResponseResponseData'
    GetMethodResponseResponseDataCustomersItem:
      allOf:
        - $ref: '#/components/schemas/PayorDataRequest'
        - type: object
          properties:
            balance:
              type: number
              format: float
              description: Customer's current balance
            created:
              type: string
              format: date-time
              description: Creation timestamp
            customerConsent:
              type: object
              additionalProperties: {}
              description: Customer consent information
            customerStatus:
              type: integer
              description: Status code for the customer
            customerSummary:
              $ref: '#/components/schemas/CustomerSummaryRecord'
            customerUsername:
              type: string
              description: Username of the customer
            externalPaypointID:
              $ref: '#/components/schemas/ExternalPaypointId'
            lastUpdated:
              type: string
              format: date-time
              description: Last update timestamp
            mfa:
              type: boolean
              description: Multi-factor authentication status
            mfaMode:
              type: integer
              description: MFA mode setting
            pageindentifier:
              $ref: '#/components/schemas/PageIdentifier'
            parentOrgId:
              type: integer
              description: Parent organization ID
            parentOrgName:
              $ref: '#/components/schemas/OrgParentName'
            paypointDbaname:
              $ref: '#/components/schemas/Dbaname'
            paypointEntryname:
              type: string
              description: The paypoint entryname the customer is associated with
            paypointLegalname:
              $ref: '#/components/schemas/Legalname'
            snData:
              type: object
              additionalProperties: {}
              description: Social network data
            snIdentifier:
              type: string
              description: Social network identifier
            snProvider:
              type: string
              description: Social network provider
            storedMethods:
              type: array
              items:
                $ref: '#/components/schemas/MethodQueryRecords'
              description: List of payment methods associated to the customer
            subscriptions:
              type: array
              items:
                $ref: '#/components/schemas/SubscriptionQueryRecords'
              description: List of subscriptions associated to the customer
            timeZone:
              type: integer
              description: Customer's timezone
    GetMethodResponseResponseDataVendorsItem:
      type: object
      properties:
        additionalData:
          description: Additional data for vendor
          $ref: '#/components/schemas/AdditionalDataMap'
        address1:
          type: string
          description: Vendor's address
        address2:
          type: string
          description: Additional line for vendor's address
        billingData:
          description: Object containing vendor's bank information
          $ref: '#/components/schemas/VendorResponseBillingData'
        city:
          type: string
          description: Vendor's city
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/Contacts'
          description: Array of objects describing the vendor's contacts
        country:
          type: string
          description: Vendor's country
        createdDate:
          type: string
          format: date-time
          description: Date when vendor was created
        customField1:
          type: string
          description: Custom field 1 for vendor
        customField2:
          type: string
          description: Custom field 2 for vendor
        customerVendorAccount:
          type: string
          description: Account number of paypoint in the vendor's side
        ein:
          type: string
          description: EIN/Tax ID for vendor. In responses, this field is masked.
        email:
          description: Vendor's email address
          $ref: '#/components/schemas/Email'
        enrollmentStatus:
          type: string
          description: Vendor enrollment status
        externalPaypointID:
          type: string
          description: External paypoint identifier
        internalReferenceId:
          description: Internal reference ID for vendor
          $ref: '#/components/schemas/InternalReferenceId'
        lastUpdated:
          type: string
          format: date-time
          description: Date when vendor was last updated
        locationCode:
          description: Location code for vendor
          $ref: '#/components/schemas/LocationCode'
        mcc:
          description: Merchant category code
          $ref: '#/components/schemas/Mcc'
        name1:
          type: string
          description: Primary name for vendor
        name2:
          type: string
          description: Secondary name for vendor
        parentOrgId:
          type: integer
          description: ID of the parent organization
        parentOrgName:
          type: string
          description: Name of the parent organization
        payeeName1:
          description: Primary payee name
          $ref: '#/components/schemas/PayeeName'
        payeeName2:
          description: Secondary payee name
          $ref: '#/components/schemas/PayeeName'
        paymentMethod:
          type: string
          description: Preferred payment method for vendor
        paypointDbaname:
          type: string
          description: DBA name of the paypoint
        paypointEntryname:
          type: string
          description: Entry name of the paypoint
        paypointId:
          type: string
          description: Paypoint ID
        paypointLegalname:
          type: string
          description: Legal name of the paypoint
        phone:
          type: string
          description: Vendor's phone number
        remitAddress1:
          description: Remittance address line 1
          $ref: '#/components/schemas/Remitaddress1'
        remitAddress2:
          description: Remittance address line 2
          $ref: '#/components/schemas/Remitaddress2'
        remitCity:
          description: Remittance city
          $ref: '#/components/schemas/Remitcity'
        remitCountry:
          description: Remittance country
          $ref: '#/components/schemas/Remitcountry'
        remitEmail:
          type: string
          description: Email address for remittance
        remitState:
          description: Remittance state
          $ref: '#/components/schemas/Remitstate'
        remitZip:
          description: Remittance ZIP code
          $ref: '#/components/schemas/Remitzip'
        state:
          type: string
          description: Vendor's state
        storedMethods:
          type: array
          items:
            $ref: '#/components/schemas/VendorResponseStoredMethod'
          description: Array of stored payment methods for vendor
        summary:
          description: Vendor bill summary statistics
          $ref: '#/components/schemas/VendorResponseSummary'
        vendorId:
          description: The unique numeric ID assigned to the vendor in Payabli
          $ref: '#/components/schemas/Vendorid'
        vendorNumber:
          description: Custom vendor number assigned by the business
          $ref: '#/components/schemas/VendorNumber'
        vendorStatus:
          description: Status code for the vendor
          $ref: '#/components/schemas/Vendorstatus'
        zip:
          type: string
          description: Vendor's ZIP code
    GetMethodResponseResponseData:
      type: object
      properties:
        aba:
          type: string
          description: Bank routing number
        achHolderType:
          $ref: '#/components/schemas/AchHolderType'
        achSecCode:
          $ref: '#/components/schemas/AchSecCode'
        bin:
          type: string
          description: The bank identification number (BIN)
        binData:
          $ref: '#/components/schemas/BinData'
        cardUpdatedOn:
          type: string
          format: date-time
          description: Timestamp for when card was last updated
        customers:
          type: array
          items:
            $ref: '#/components/schemas/GetMethodResponseResponseDataCustomersItem'
        descriptor:
          $ref: '#/components/schemas/Descriptor'
        expDate:
          type: string
          description: Expiration date for card in stored method in format MM/YY
        holderName:
          description: Account holder name in stored method
          $ref: '#/components/schemas/Holdername'
        idPmethod:
          type: string
          description: The stored payment method's identifier in Payabli
        isValidatedACH:
          type: boolean
          description: Whether the ACH account has been validated
        lastUpdated:
          type: string
          format: date-time
          description: Timestamp for last update of stored method, in UTC
        maskedAccount:
          $ref: '#/components/schemas/Maskedaccount'
        method:
          type: string
          description: 'The saved method''s type: `card` or `ach`.'
        methodType:
          type: string
          description: The payment method's token type
        postalCode:
          type: string
          description: The payment method postal code
        vendors:
          type: array
          items:
            $ref: '#/components/schemas/GetMethodResponseResponseDataVendorsItem'
    GetMethodResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          $ref: '#/components/schemas/GetMethodResponseResponseData'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    PayabliApiResponsePaymethodDeleteResponseData:
      type: object
      properties:
        referenceId:
          description: The method's reference ID.
          $ref: '#/components/schemas/MethodReferenceId'
        resultCode:
          $ref: '#/components/schemas/ResultCode'
        resultText:
          $ref: '#/components/schemas/Resulttext'
    PayabliApiResponsePaymethodDelete:
      type: object
      description: Response body for payment method deletion.
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          $ref: '#/components/schemas/PayabliApiResponsePaymethodDeleteResponseData'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    BankNickname:
      type: string
      description: User-defined name for the bank account.
    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).
    Bank:
      type: object
      description: Object that contains bank account details.
      properties:
        default:
          type: boolean
        country:
          type: string
        id:
          type: integer
          description: The Payabli-assigned internal identifier for the bank account.
        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.
          $ref: '#/components/schemas/AccountId'
        nickname:
          $ref: '#/components/schemas/BankNickname'
        bankName:
          $ref: '#/components/schemas/BankName'
        routingAccount:
          $ref: '#/components/schemas/RoutingAccount'
        accountNumber:
          $ref: '#/components/schemas/AccountNumber'
        typeAccount:
          $ref: '#/components/schemas/TypeAccount'
        bankAccountHolderName:
          $ref: '#/components/schemas/BankAccountHolderName'
        bankAccountHolderType:
          $ref: '#/components/schemas/BankAccountHolderType'
        bankAccountFunction:
          $ref: '#/components/schemas/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
    BankData:
      type: array
      items:
        $ref: '#/components/schemas/Bank'
      description: Information about associated bank accounts.
    BoardingId:
      type: integer
      format: int64
      description: |
        The Payabli-assigned ID of the boarding application linked to this paypoint.
    CountryNullable:
      type: string
      description: |
        The country in ISO-3166-1 alpha 2 format. See
        [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) for reference.
    MinTicket:
      type: number
      format: double
      description: |
        Minimum ticket amount for transactions within the paypoint. Contact
        Payabli support to request a change to this value.
    MaxTicket:
      type: number
      format: double
      description: |
        Maximum ticket amount for transactions within the paypoint. Contact
        Payabli support to request a change to this value.
    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/MinTicket'
        MaxTicket:
          $ref: '#/components/schemas/MaxTicket'
        CfeeFix:
          type: number
          format: double
        CfeeFloat:
          type: number
          format: double
        CfeeMin:
          type: number
          format: double
        CfeeMax:
          type: number
          format: double
        AccountId:
          description: The identifier for the payment connector, matching the `accountId` of the linked bank account.
          $ref: '#/components/schemas/AccountId'
        ReferenceId:
          type: integer
          format: int64
        acceptSameDayACH:
          type: boolean
          x-fern-availability: in-development
        Currency:
          type: array
          items:
            type: string
          description: The default currency for the paypoint, either `USD` or `CAD`.
        GreaterValueAllowed:
          $ref: '#/components/schemas/GreaterValueAllowed'
        AbsorbDifference:
          $ref: '#/components/schemas/AbsorbDifference'
        AllowOverride:
          $ref: '#/components/schemas/AllowOverride'
    Idpaypoint:
      type: integer
      format: int64
      description: The paypoint's ID in Payabli.
    Orgaddress:
      type: string
      description: The organization's address.
    Orgname:
      type: string
      description: The name of the organization.
    Orgtype:
      type: integer
      description: The organization type. Currently, this must be `0`.
    OrgData:
      type: object
      properties:
        idOrg:
          $ref: '#/components/schemas/Orgid'
        orgAddress:
          $ref: '#/components/schemas/Orgaddress'
        orgLogo:
          $ref: '#/components/schemas/FileContent'
        orgName:
          $ref: '#/components/schemas/Orgname'
        orgStatus:
          type: integer
          description: |-
            The paypoint's status.
            Active - `1`
            Inactive - 0
        orgType:
          $ref: '#/components/schemas/Orgtype'
    Paypointstatus:
      type: integer
      description: |
        The paypoint's status.

        - `1` — Active
        - `0` — Inactive
    AchSetup:
      type: object
      additionalProperties: true
      description: |
        Configuration for which ACH SEC codes the user is allowed to use.
      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.
        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 an Internet-Initiated/Mobile
            Entry.
    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.
    OdpSetupProcessingRegion:
      type: string
      description: Region where payment processing occurs.
      enum:
        - US
        - CA
    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:
          description: Region where payment processing occurs
          $ref: '#/components/schemas/OdpSetupProcessingRegion'
        processor:
          type: string
          description: Payment processor identifier
        issuerNetworkSettingsId:
          type: string
          description: Reference ID for the program enabled for ODP issuance
    Services:
      type: object
      description: Controls which services will be enabled for the merchant.
      properties:
        ach:
          $ref: '#/components/schemas/AchSetup'
        card:
          $ref: '#/components/schemas/CardSetup'
        odp:
          $ref: '#/components/schemas/OdpSetup'
    PaypointSummary:
      type: object
      properties:
        amountSubs:
          type: number
          format: double
        amountTx:
          type: number
          format: double
        countSubs:
          type: integer
        countTx:
          type: integer
        customers:
          type: integer
    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.
    StatementEmailConfig:
      type: object
      description: Configuration for statement email recipients and the sender address.
      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.
    PaypointData:
      type: object
      properties:
        Address1:
          $ref: '#/components/schemas/AddressNullable'
        Address2:
          $ref: '#/components/schemas/AddressAddtlNullable'
        BankData:
          $ref: '#/components/schemas/BankData'
        BoardingId:
          $ref: '#/components/schemas/BoardingId'
        City:
          $ref: '#/components/schemas/CityNullable'
        Contacts:
          $ref: '#/components/schemas/ContactsField'
        Country:
          $ref: '#/components/schemas/CountryNullable'
        Credentials:
          type: array
          items:
            $ref: '#/components/schemas/PayabliCredentialsPascal'
        DbaName:
          $ref: '#/components/schemas/Dbaname'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        Fax:
          description: Fax number
          $ref: '#/components/schemas/PhoneNumber'
        IdPaypoint:
          $ref: '#/components/schemas/Idpaypoint'
        LegalName:
          $ref: '#/components/schemas/Legalname'
        ParentOrg:
          $ref: '#/components/schemas/OrgData'
        PaypointStatus:
          $ref: '#/components/schemas/Paypointstatus'
        Phone:
          $ref: '#/components/schemas/PhoneNumber'
        ServiceData:
          $ref: '#/components/schemas/Services'
        State:
          $ref: '#/components/schemas/StateNullable'
        summary:
          $ref: '#/components/schemas/PaypointSummary'
        TimeZone:
          $ref: '#/components/schemas/Timezone'
        WebsiteAddress:
          $ref: '#/components/schemas/Website'
        Zip:
          $ref: '#/components/schemas/Zip'
        StatementEmail:
          description: Configuration for billing statement email recipients and sender address. `null` if not configured.
          $ref: '#/components/schemas/StatementEmailConfig'
    PaypointEntryConfig:
      type: object
      properties:
        EntryComment:
          type: string
        EntryLogo:
          type: string
        EntryName:
          type: string
        EntryPages:
          type: array
          items:
            $ref: '#/components/schemas/PayabliPages'
        EntrySubtitle:
          type: string
        EntryTitle:
          type: string
        IdEntry:
          type: integer
          format: int64
        Paypoint:
          $ref: '#/components/schemas/PaypointData'
    GetBasicEntryResponse:
      type: object
      required:
        - isSuccess
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          $ref: '#/components/schemas/PaypointEntryConfig'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    GetBasicEntryByIdResponse:
      type: object
      required:
        - isSuccess
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          $ref: '#/components/schemas/PaypointEntryConfig'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    WebHeaderParameter:
      type: object
      required:
        - key
        - value
      properties:
        key:
          type: string
        value:
          type: string
    NotificationRequest:
      type: object
      required:
        - notificationUrl
      properties:
        notificationUrl:
          type: string
          description: Complete HTTP URL receiving the notification
        webHeaderParameters:
          type: array
          items:
            $ref: '#/components/schemas/WebHeaderParameter'
          description: List of key-value header parameters to include in the notification request
    PaypointMoveRequest:
      type: object
      required:
        - entryPoint
        - newParentOrganizationId
      properties:
        entryPoint:
          $ref: '#/components/schemas/Entrypointfield'
        newParentOrganizationId:
          type: integer
          description: The ID for the paypoint's new parent organization.
        notificationRequest:
          description: Optional notification request object for a webhook
          $ref: '#/components/schemas/NotificationRequest'
    MigratePaypointResponse:
      type: object
      required:
        - isSuccess
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    ReadOnly:
      type: boolean
      description: When `true`, the element is read-only.
    KeyValue:
      type: object
      properties:
        key:
          type: string
          description: Key name.
        readOnly:
          $ref: '#/components/schemas/ReadOnly'
        value:
          type: string
          description: Key value.
    SettingsQueryRecord:
      type: object
      properties:
        customFields:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
          description: Any custom fields defined for the org.
        forInvoices:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        forPayOuts:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        forWallets:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
          description: Information about digital wallet settings for the entity. Available values are `isApplePayEnabled` and `isGooglePayEnabled`.
        general:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
          description: ''
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
    GetEntryConfigResponse:
      type: object
      required:
        - isSuccess
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          $ref: '#/components/schemas/PaypointEntryConfig'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    IsEnabled:
      type: boolean
      description: When `true`, the service is enabled.
    AddPaymentMethodDomainRequestApplePay:
      type: object
      description: Apple Pay configuration information.
      properties:
        isEnabled:
          $ref: '#/components/schemas/IsEnabled'
    AddPaymentMethodDomainRequestGooglePay:
      type: object
      description: Google Pay configuration information.
      properties:
        isEnabled:
          $ref: '#/components/schemas/IsEnabled'
    DomainName:
      type: string
      description: |
        The domain. For example: `subdomain.domain.com` or `domain.com`. Must be
        public. Can't be `localhost`, hidden by a VPN, or protected by a password.
    EntityType:
      type: string
      description: |
        The entity type. Available values:

        - `paypoint`
        - `organization`
        - `psp` (payment service provider)
    AddPaymentMethodDomainRequest:
      type: object
      properties:
        applePay:
          description: Apple Pay configuration information.
          $ref: '#/components/schemas/AddPaymentMethodDomainRequestApplePay'
        googlePay:
          description: Google Pay configuration information.
          $ref: '#/components/schemas/AddPaymentMethodDomainRequestGooglePay'
        domainName:
          $ref: '#/components/schemas/DomainName'
        entityId:
          $ref: '#/components/schemas/EntityId'
        entityType:
          $ref: '#/components/schemas/EntityType'
    ApplePayMetadata:
      type: object
      description: |
        This metadata appears only when the domain verification check fails. It
        gives more information about why the check failed.
      properties:
        isFileAvailable:
          type: boolean
          description: |
            When `true`, indicates whether the domain verification file is
            available at the expected path. When `false`, Payabli was unable to
            find the file at the expected path. If the file is missing, make
            sure it's hosted at the correct path:
            `/.well-known/apple-developer-merchantid-domain-association`.
        isFileContentValid:
          type: boolean
          description: |
            Indicates whether the domain verification file content is valid. If
            the file is invalid, try downloading it and hosting it again.
        redirectDomainName:
          type: string
          description: The domain name if the domain verification URL returns a redirect.
        redirectUrl:
          type: string
          description: |
            If the domain verification URL is redirected, this is the URL it's
            redirected to. For example, `www.partner.com` could redirect to
            `www.partners-new-home-page.com`. In this case, you should add
            `www.partners-new-home-page.com` as a domain instead of
            `www.partner.com`.
        statusCode:
          type: integer
          description: The status code returned by the domain verification URL.
    ApplePayStatusData:
      type: object
      description: Details about the Apple Pay service status.
      properties:
        errorMessage:
          type: string
          description: Any error message related to Apple Pay's activation status.
        metadata:
          $ref: '#/components/schemas/ApplePayMetadata'
    ApplePayData:
      type: object
      description: Details about the status of the Apple Pay service.
      properties:
        data:
          $ref: '#/components/schemas/ApplePayStatusData'
          description: |
            This object is only returned when the domain verification check
            fails. If a domain has failed validation, this object contains
            information about the failure.
        isEnabled:
          $ref: '#/components/schemas/IsEnabled'
    GooglePayMetadata:
      type: object
      description: |
        This metadata appears only when the domain verification check fails. It
        gives more information about why the check failed.
      properties:
        statusCode:
          type: integer
          description: The status code returned by the domain verification URL.
        redirectUrl:
          type: string
          description: |
            If the domain verification URL is redirected, this is the URL it's
            redirected to. For example, `www.partner.com` could redirect to
            `www.partners-new-home-page.com`. In this case, you should add
            `www.partners-new-home-page.com` as a domain instead of
            `www.partner.com`.
        redirectDomainName:
          type: string
          description: The domain name if the domain verification URL returns a redirect.
    GooglePayStatusData:
      type: object
      description: Details about the Google Pay service status.
      properties:
        errorMessage:
          type: string
          description: Any error message related to Google Pay's activation status.
        metadata:
          $ref: '#/components/schemas/GooglePayMetadata'
    GooglePayData:
      type: object
      description: Details about the status of the Google Pay service.
      properties:
        data:
          $ref: '#/components/schemas/GooglePayStatusData'
          description: |
            This object is only returned when the domain verification check
            fails. If a domain has failed validation, this object contains
            information about the failure.
        isEnabled:
          $ref: '#/components/schemas/IsEnabled'
    JobId:
      type: string
      description: The cascade process ID.
    JobStatus:
      type: string
      description: The cascade process status.
      enum:
        - in_progress
        - completed
        - failed
    CascadeJobDetails:
      type: object
      description: Details about the cascade process.
      properties:
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        jobErrorMessage:
          type: string
          description: Error message for a failed cascade process.
        jobId:
          $ref: '#/components/schemas/JobId'
        jobStatus:
          $ref: '#/components/schemas/JobStatus'
        updatedAt:
          $ref: '#/components/schemas/LastModified'
    PaymentMethodDomainId:
      type: string
      description: The payment method domain's ID in Payabli.
    OwnerEntityId:
      type: integer
      format: int64
      description: |
        The domain's owning entity's ID in Payabli. This value might be different
        than the `entityId`, depending on whether the domain is cascaded and
        whether it's inherited.
    OwnerEntityType:
      type: string
      description: |
        The domain's owner's entity type. Available values:

        - `paypoint`
        - `organization`
        - `psp` (payment service provider)
    PaymentMethodDomainApiResponse:
      type: object
      description: Data related to the payment method domain.
      required:
        - type
        - applePay
        - googlePay
        - createdAt
        - domainName
        - entityId
        - entityType
        - id
        - ownerEntityId
        - ownerEntityType
      properties:
        type:
          type:
            - string
            - 'null'
          description: The record type. For payment method domains, this is always `PaymentMethodDomain`.
        applePay:
          $ref: '#/components/schemas/ApplePayData'
        googlePay:
          $ref: '#/components/schemas/GooglePayData'
        cascades:
          type: array
          items:
            $ref: '#/components/schemas/CascadeJobDetails'
          description: Data about the domain's cascade status.
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        domainName:
          $ref: '#/components/schemas/DomainName'
        entityId:
          $ref: '#/components/schemas/EntityId'
        entityType:
          $ref: '#/components/schemas/EntityType'
        id:
          $ref: '#/components/schemas/PaymentMethodDomainId'
        ownerEntityId:
          $ref: '#/components/schemas/OwnerEntityId'
        ownerEntityType:
          $ref: '#/components/schemas/OwnerEntityType'
        updatedAt:
          $ref: '#/components/schemas/LastModified'
    AddPaymentMethodDomainApiResponse:
      type: object
      description: Response for the add payment method domain operation.
      required:
        - isSuccess
        - pageidentifier
        - responseData
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseData:
          $ref: '#/components/schemas/PaymentMethodDomainApiResponse'
        responseText:
          type: string
    PaymentMethodDomainGeneralResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseData:
          $ref: '#/components/schemas/PaymentMethodDomainApiResponse'
        responseText:
          type: string
    DeletePaymentMethodDomainResponse:
      type: object
      required:
        - isSuccess
        - pageIdentifier
        - responseData
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseData:
          description: The deleted domain's domain ID.
          $ref: '#/components/schemas/Responsedatanonobject'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    UpdatePaymentMethodDomainRequestWallet:
      type: object
      properties:
        isEnabled:
          $ref: '#/components/schemas/IsEnabled'
    UpdatePaymentMethodDomainRequest:
      type: object
      properties:
        applePay:
          $ref: '#/components/schemas/UpdatePaymentMethodDomainRequestWallet'
        googlePay:
          $ref: '#/components/schemas/UpdatePaymentMethodDomainRequestWallet'
    QuerySummaryNoAmt:
      type: object
      properties:
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        pageSize:
          $ref: '#/components/schemas/Pagesize'
        totalPages:
          $ref: '#/components/schemas/Totalrecords'
        totalRecords:
          $ref: '#/components/schemas/Totalrecords'
    ListPaymentMethodDomainsResponse:
      type: object
      required:
        - records
        - summary
      properties:
        records:
          type: array
          items:
            $ref: '#/components/schemas/PaymentMethodDomainApiResponse'
        summary:
          $ref: '#/components/schemas/QuerySummaryNoAmt'
    ImportBillsRequest:
      type: object
      required:
        - file
      properties:
        file:
          type: string
          format: binary
          description: The file to be imported. The file must be a CSV file with the correct format. See the [Import Guide](/developers/developer-guides/bills-add#import-bills) for more help and example files.
    PayabliApiResponseImportResponseData:
      type: object
      description: The response data containing the result of the import operation.
      properties:
        added:
          type: integer
          description: The number of records successfully added.
        errors:
          type: array
          items:
            type: string
          description: List of errors, if any.
        rejected:
          type: integer
          description: The number of records that were rejected.
    PayabliApiResponseImport:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          description: The response data containing the result of the import operation.
          $ref: '#/components/schemas/PayabliApiResponseImportResponseData'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    ImportCustomerRequest:
      type: object
      required:
        - file
      properties:
        file:
          type: string
          format: binary
    ImportVendorRequest:
      type: object
      required:
        - file
      properties:
        file:
          type: string
          format: binary
    Category:
      type: string
      description: |
        A field used internally by Payabli to categorize the transaction details.
        Values are:

        - `auth`: Any payment
        - `refund`: ACH return or Refund
        - `adj`: Adjustments
        - `cb`: Chargeback
        - `split`: Split amount
    DepositDate:
      type: string
      format: date-time
      description: The date the funds were deposited.
    ExpectedDepositDate:
      type: string
      format: date-time
      description: The date the funds are expected to be deposited.
    BatchDetailResponseRecord:
      type: object
      required:
        - Id
        - Method
        - WalletType
        - SettledAmount
        - Type
        - BatchNumber
        - BatchAmount
        - PaymentTransId
        - PaymentTransStatus
        - ScheduleReference
        - GatewayTransId
        - OrderId
        - TransMethod
        - PaymentData
        - Operation
        - Category
        - Source
        - Status
        - TransactionTime
        - Customer
        - SettlementDate
        - PaymentSettlementStatus
        - BatchStatus
        - DepositDate
        - ExpectedDepositDate
        - MaskedAccount
        - CreatedAt
        - PaypointLegalname
        - ResponseData
        - PaypointDbaname
        - ParentOrgName
        - ParentOrgId
        - PaypointEntryname
        - DeviceId
        - RetrievalId
        - ChargebackId
        - AchHolderType
        - AchSecCode
        - ConnectorName
        - EntrypageId
        - FeeAmount
        - OrgId
        - PayorId
        - PaypointId
        - RefundId
        - ReturnedId
        - TotalAmount
        - CfeeTransactions
        - invoiceData
        - TransactionEvents
        - externalPaypointID
        - isHold
      properties:
        Id:
          type: integer
        Method:
          type: string
        WalletType:
          type:
            - string
            - 'null'
        SettledAmount:
          type: number
          format: double
        Type:
          type: string
        BatchNumber:
          $ref: '#/components/schemas/BatchNumber'
        BatchAmount:
          type: number
          format: double
        PaymentTransId:
          type: string
        PaymentTransStatus:
          type: integer
        ScheduleReference:
          type: integer
        GatewayTransId:
          type: string
        OrderId:
          $ref: '#/components/schemas/OrderId'
        TransMethod:
          type: string
        PaymentData:
          oneOf:
            - $ref: '#/components/schemas/QueryPaymentData'
            - type: 'null'
        NetAmount:
          $ref: '#/components/schemas/Netamountnullable'
        Operation:
          $ref: '#/components/schemas/Operation'
        Category:
          $ref: '#/components/schemas/Category'
        Source:
          oneOf:
            - $ref: '#/components/schemas/Source'
            - type: 'null'
        Status:
          type: integer
        TransactionTime:
          $ref: '#/components/schemas/TransactionTime'
        Customer:
          oneOf:
            - $ref: '#/components/schemas/QueryTransactionPayorData'
            - type: 'null'
        SettlementDate:
          type: string
          format: date-time
        PaymentSettlementStatus:
          type: integer
        BatchStatus:
          type: integer
        DepositDate:
          $ref: '#/components/schemas/DepositDate'
        ExpectedDepositDate:
          $ref: '#/components/schemas/ExpectedDepositDate'
        MaskedAccount:
          $ref: '#/components/schemas/Maskedaccount'
        CreatedAt:
          $ref: '#/components/schemas/CreatedAt'
        PaypointLegalname:
          $ref: '#/components/schemas/Legalname'
        ResponseData:
          oneOf:
            - $ref: '#/components/schemas/QueryResponseData'
            - type: 'null'
        PaypointDbaname:
          $ref: '#/components/schemas/Dbaname'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        ParentOrgId:
          type: integer
        PaypointEntryname:
          $ref: '#/components/schemas/Entrypointfield'
        DeviceId:
          oneOf:
            - $ref: '#/components/schemas/Device'
            - type: 'null'
        RetrievalId:
          $ref: '#/components/schemas/RetrievalId'
        ChargebackId:
          $ref: '#/components/schemas/ChargebackId'
        AchHolderType:
          $ref: '#/components/schemas/AchHolderType'
        AchSecCode:
          $ref: '#/components/schemas/AchSecCode'
        ConnectorName:
          type: string
        EntrypageId:
          $ref: '#/components/schemas/EntrypageId'
        FeeAmount:
          $ref: '#/components/schemas/FeeAmount'
        OrgId:
          $ref: '#/components/schemas/Orgid'
        PayorId:
          $ref: '#/components/schemas/PayorId'
        PaypointId:
          $ref: '#/components/schemas/PaypointId'
        PendingFeeAmount:
          $ref: '#/components/schemas/PendingFeeAmount'
        RefundId:
          $ref: '#/components/schemas/RefundId'
        ReturnedId:
          $ref: '#/components/schemas/ReturnedId'
        splitFundingInstructions:
          $ref: '#/components/schemas/SplitFunding'
        TotalAmount:
          type: number
          format: double
        CfeeTransactions:
          type: array
          items:
            $ref: '#/components/schemas/QueryCFeeTransaction'
        invoiceData:
          oneOf:
            - $ref: '#/components/schemas/BillData'
            - type: 'null'
        TransactionEvents:
          type: array
          items:
            $ref: '#/components/schemas/QueryTransactionEvents'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        isHold:
          type: integer
    BatchDetailResponseSummary:
      type: object
      required:
        - serviceFees
        - transferAmount
        - refunds
        - heldAmount
        - totalRecords
        - totalAmount
        - totalNetAmount
        - totalPages
        - pageSize
        - pageidentifier
      properties:
        serviceFees:
          type: number
          format: double
        transferAmount:
          type: number
          format: double
        refunds:
          type: number
          format: double
        heldAmount:
          type: number
          format: double
        totalRecords:
          $ref: '#/components/schemas/Totalrecords'
        totalAmount:
          type: number
          format: double
        totalNetAmount:
          type: number
          format: double
        totalPages:
          $ref: '#/components/schemas/Totalpages'
        pageSize:
          $ref: '#/components/schemas/Pagesize'
        pageidentifier:
          oneOf:
            - $ref: '#/components/schemas/PageIdentifier'
            - type: 'null'
    QueryBatchesDetailResponse:
      type: object
      description: Response body for queries about batch details.
      required:
        - Records
        - Summary
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/BatchDetailResponseRecord'
        Summary:
          $ref: '#/components/schemas/BatchDetailResponseSummary'
    TransferIdentifier:
      type: string
      description: Unique identifier for the transfer.
    PaypointName:
      type: string
      description: The paypoint name.
    QueryBatchesTransfer:
      type: object
      description: Transfer details within a batch response.
      required:
        - TransferId
        - TransferDate
        - Processor
        - TransferStatus
        - GrossAmount
        - ChargeBackAmount
        - ReturnedAmount
        - RefundAmount
        - HoldAmount
        - ReleasedAmount
        - BillingFeesAmount
        - ThirdPartyPaidAmount
        - AdjustmentsAmount
        - NetFundedAmount
      properties:
        TransferId:
          type:
            - integer
            - 'null'
          description: The transfer ID.
        TransferDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The transfer date.
        Processor:
          type:
            - string
            - 'null'
          description: The processor used for the transfer.
        TransferStatus:
          type:
            - integer
            - 'null'
          description: The transfer status.
        GrossAmount:
          type:
            - number
            - 'null'
          format: double
          description: The gross amount of the transfer.
        ChargeBackAmount:
          type:
            - number
            - 'null'
          format: double
          description: The chargeback amount.
        ReturnedAmount:
          type:
            - number
            - 'null'
          format: double
          description: The returned amount.
        RefundAmount:
          type:
            - number
            - 'null'
          format: double
          description: The refund amount.
        HoldAmount:
          type:
            - number
            - 'null'
          format: double
          description: The amount being held.
        ReleasedAmount:
          type:
            - number
            - 'null'
          format: double
          description: The amount that has been released.
        BillingFeesAmount:
          type:
            - number
            - 'null'
          format: double
          description: The billing fees amount.
        ThirdPartyPaidAmount:
          type:
            - number
            - 'null'
          format: double
          description: The third party paid amount.
        AdjustmentsAmount:
          type:
            - number
            - 'null'
          format: double
          description: The adjustments amount.
        NetFundedAmount:
          type:
            - number
            - 'null'
          format: double
          description: The net funded amount.
    QueryBatchesResponseRecordsItem:
      type: object
      required:
        - IdBatch
        - BatchNumber
        - TransferIdentifier
        - EventsData
        - ConnectorName
        - BatchDate
        - BatchAmount
        - BatchFeesAmount
        - BatchAuthAmount
        - BatchReleasedAmount
        - BatchHoldAmount
        - BatchReturnedAmount
        - BatchRefundAmount
        - BatchSplitAmount
        - BatchStatus
        - BatchRecords
        - PaypointId
        - PaypointName
        - PaypointDba
        - ParentOrgName
        - ParentOrgId
        - externalPaypointID
        - EntryName
        - BankName
        - BatchType
        - Method
        - ExpectedDepositDate
        - DepositDate
        - TransferDate
        - Transfer
      properties:
        IdBatch:
          type:
            - integer
            - 'null'
          description: The batch ID.
        BatchNumber:
          oneOf:
            - $ref: '#/components/schemas/BatchNumber'
            - type: 'null'
        TransferIdentifier:
          oneOf:
            - $ref: '#/components/schemas/TransferIdentifier'
            - type: 'null'
        EventsData:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/GeneralEvents'
          description: Events associated with the batch.
        ConnectorName:
          type:
            - string
            - 'null'
          description: ''
        BatchDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The batch date.
        BatchAmount:
          type:
            - number
            - 'null'
          format: double
          description: The amount of the batch.
        BatchFeesAmount:
          type:
            - number
            - 'null'
          format: double
          description: The total of fees in the batch.
        BatchAuthAmount:
          type:
            - number
            - 'null'
          format: double
          description: ''
        BatchReleasedAmount:
          type:
            - number
            - 'null'
          format: double
          description: Previously held funds that have been released after a risk review.
        BatchHoldAmount:
          type:
            - number
            - 'null'
          format: double
          description: The total amount of the batch that's being held for fraud or risk concerns.
        BatchReturnedAmount:
          type:
            - number
            - 'null'
          format: double
          description: Total amount of ACH returns deducted from batch.
        BatchRefundAmount:
          type:
            - number
            - 'null'
          format: double
          description: The total amount of refunds deducted from batch.
        BatchSplitAmount:
          type:
            - number
            - 'null'
          format: double
          description: Total of split transactions that included split funding instructions at the time of authorization.
        BatchStatus:
          type: integer
          description: The batch status. See [Batch Status](/developers/references/money-in-statuses#batch-status) for more.
        BatchRecords:
          type: integer
          description: The number of records in the batch.
        PaypointId:
          oneOf:
            - $ref: '#/components/schemas/PaypointId'
            - type: 'null'
        PaypointName:
          oneOf:
            - $ref: '#/components/schemas/PaypointName'
            - type: 'null'
        PaypointDba:
          oneOf:
            - $ref: '#/components/schemas/Dbaname'
            - type: 'null'
        ParentOrgName:
          description: The entrypoint's parent org.
          $ref: '#/components/schemas/OrgParentName'
        ParentOrgId:
          type: integer
          description: The parent organization ID.
        externalPaypointID:
          oneOf:
            - $ref: '#/components/schemas/ExternalPaypointId'
            - type: 'null'
        EntryName:
          $ref: '#/components/schemas/Entrypointfield'
        BankName:
          type:
            - string
            - 'null'
          description: The bank name.
        BatchType:
          type:
            - integer
            - 'null'
          description: The batch type.
        Method:
          type:
            - string
            - 'null'
          description: The payment method used.
        ExpectedDepositDate:
          oneOf:
            - $ref: '#/components/schemas/ExpectedDepositDate'
            - type: 'null'
        DepositDate:
          oneOf:
            - $ref: '#/components/schemas/DepositDate'
            - type: 'null'
        TransferDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The batch transfer date.
        Transfer:
          description: Transfer details for the batch.
          oneOf:
            - $ref: '#/components/schemas/QueryBatchesTransfer'
            - type: 'null'
    BatchSummary:
      type: object
      properties:
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
        pageSize:
          type: integer
          description: Number of records on each response page.
        totalAmount:
          type: number
          format: double
          description: Total amount for the records.
        totalNetAmount:
          type: number
          format: double
          description: Total net amount for the records.
        totalPages:
          type: integer
          description: Total number of pages in response.
        totalRecords:
          type: integer
          description: Total number of records in response.
    QueryBatchesResponse:
      type: object
      description: Response body for queries about batches.
      required:
        - Records
        - Summary
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/QueryBatchesResponseRecordsItem'
        Summary:
          $ref: '#/components/schemas/BatchSummary'
    QueryBatchesOutResponseRecordsItem:
      type: object
      properties:
        AchAmount:
          type: number
          format: double
          description: ''
        AchRecords:
          type: integer
          description: ''
        AchStatus:
          type: integer
          description: ''
        AchStatusText:
          type: string
          description: ''
        BatchAmount:
          type: number
          format: double
          description: The amount of the batch.
        BatchCancelledAmount:
          type: number
          format: double
          description: ''
        BatchCancelledRecords:
          type: integer
          description: ''
        BatchDate:
          type: string
          format: date-time
          description: The batch date.
        BatchNumber:
          $ref: '#/components/schemas/BatchNumber'
        BatchPaidAmount:
          type: number
          format: double
          description: ''
        BatchPaidRecords:
          type: integer
          description: ''
        BatchProcessedAmount:
          type: number
          format: double
          description: ''
        BatchProcessedRecords:
          type: integer
          description: ''
        BatchProcessingAmount:
          type: number
          format: double
          description: ''
        BatchProcessingRecords:
          type: integer
          description: ''
        BatchRecords:
          type: integer
          description: The number of records in the batch.
        BatchStatus:
          type: integer
          description: The batch status. See [Batch Status](/developers/references/money-out-statuses#batch-statuses) for more.
        BatchStatusText:
          type: string
          description: A text description of the batch status.
        CardAmount:
          type: number
          format: double
          description: ''
        CardRecords:
          type: integer
          description: ''
        CardStatus:
          type: integer
          description: ''
        CardStatusText:
          type: string
          description: ''
        CheckAmount:
          type: number
          format: double
          description: ''
        CheckRecords:
          type: integer
          description: ''
        CheckStatus:
          type: integer
          description: ''
        CheckStatusText:
          type: string
          description: ''
        EntryName:
          $ref: '#/components/schemas/Entrypointfield'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        IdBatch:
          type: integer
          description: The batch ID.
        ParentOrgName:
          type: string
          description: The entrypoint's parent org.
        PaypointDba:
          type: string
          description: Paypoint DBA name.
        PaypointId:
          type: integer
          description: Paypoint ID.
        PaypointName:
          type: string
          description: Paypoint legal name.
        VcardAmount:
          type: number
          format: double
          description: ''
        VcardRecords:
          type: integer
          description: ''
        VcardStatus:
          type: integer
          description: ''
        VcardStatusText:
          type: string
          description: ''
        WireAmount:
          type: number
          format: double
          description: ''
        WireRecords:
          type: integer
          description: ''
        WireStatus:
          type: integer
          description: ''
        WireStatusText:
          type: string
          description: ''
    QueryBatchesOutResponse:
      type: object
      description: Response body for queries about money out batches.
      required:
        - Records
        - Summary
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/QueryBatchesOutResponseRecordsItem'
        Summary:
          $ref: '#/components/schemas/BatchSummary'
    Replyby:
      type: string
      format: date-time
      description: Time that a response to a chargeback is due, in UTC.
    QueryChargebacksResponseRecordsItem:
      type: object
      properties:
        AccountType:
          type: string
          description: Type of account.
        CaseNumber:
          type: string
          description: Case number of the chargeback.
        ChargebackDate:
          type: string
          format: date-time
          description: Date of the chargeback.
        CreatedAt:
          $ref: '#/components/schemas/CreatedAt'
        Customer:
          $ref: '#/components/schemas/QueryTransactionPayorData'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        Id:
          type: integer
          description: Unique identifier of the record.
        LastFour:
          type: string
          description: Last four digits of the account number.
        Method:
          type: string
          description: Method of payment.
        NetAmount:
          type: number
          format: float
          description: Net amount after deductions.
        OrderId:
          $ref: '#/components/schemas/OrderId'
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        PaymentData:
          description: Payment data associated with the transaction.
          $ref: '#/components/schemas/QueryPaymentData'
        PaymentTransId:
          type: string
          description: Transaction ID for the payment.
        PaypointDbaname:
          description: The 'Doing Business As' (DBA) name of the paypoint.
          $ref: '#/components/schemas/Dbaname'
        PaypointEntryname:
          description: Entryname for the paypoint.
          $ref: '#/components/schemas/Entrypointfield'
        PaypointLegalname:
          description: Legal name of the paypoint.
          $ref: '#/components/schemas/Legalname'
        Reason:
          type: string
          description: Description of the reason for chargeback.
        ReasonCode:
          type: string
          description: Code representing the reason for chargeback.
        ReferenceNumber:
          type: string
          description: Reference number for the transaction.
        ReplyBy:
          $ref: '#/components/schemas/Replyby'
        Responses:
          type: string
          description: Responses related to the transaction.
        ScheduleReference:
          type: integer
          description: Reference for any scheduled transactions.
        Status:
          type: integer
          description: |-
            Status of the chargeback or ACH return.

            - 0: Open (chargebacks only)
            - 1: Pending (chargebacks only)
            - 2: ClosedWon (chargebacks only)
            - 3: ClosedLost (chargebacks only)
            - 4: ACH return (any Nacha return code except R29)
            - 5: AchDispute (R29 only — debit block)
        Transaction:
          $ref: '#/components/schemas/TransactionQueryRecords'
        TransactionTime:
          $ref: '#/components/schemas/TransactionTime'
    QueryChargebacksResponse:
      type: object
      description: Response body for queries about chargebacks.
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/QueryChargebacksResponseRecordsItem'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    QueryCustomerResponse:
      type: object
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/CustomerQueryRecords'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    DeviceQueryRecord:
      type: object
      required:
        - deviceId
        - idCloud
        - description
        - serialNumber
        - friendlyName
        - make
        - model
        - deviceType
        - deviceStatus
        - deviceOs
        - macAddress
        - lastHealthCheck
        - registrationCode
        - activationAttempts
        - activationCodeExpiry
        - createdAt
        - updatedAt
        - paypointId
        - paypointDba
        - paypointLegal
        - paypointEntry
        - externalPaypointId
        - parentOrgId
        - parentOrgName
      properties:
        deviceId:
          type:
            - string
            - 'null'
          description: Unique identifier for the cloud device.
        idCloud:
          type:
            - integer
            - 'null'
          description: Internal cloud device record ID.
        description:
          type:
            - string
            - 'null'
          description: Description of the device.
        serialNumber:
          type:
            - string
            - 'null'
          description: Serial number of the device.
        friendlyName:
          type:
            - string
            - 'null'
          description: Human-readable name for the device.
        make:
          type:
            - string
            - 'null'
          description: Manufacturer of the device.
        model:
          type:
            - string
            - 'null'
          description: Model name of the device.
        deviceType:
          type:
            - integer
            - 'null'
          description: Type of device.
        deviceStatus:
          type:
            - integer
            - 'null'
          description: Current status of the device.
        deviceOs:
          type:
            - integer
            - 'null'
          description: Operating system of the device.
        macAddress:
          type:
            - string
            - 'null'
          description: MAC address of the device.
        lastHealthCheck:
          type:
            - string
            - 'null'
          description: Timestamp of the last health check from the device.
        registrationCode:
          type:
            - string
            - 'null'
          description: Registration code used to activate the device.
        activationAttempts:
          type:
            - integer
            - 'null'
          description: Number of activation attempts for the device.
        activationCodeExpiry:
          type:
            - string
            - 'null'
          description: Expiration timestamp for the device activation code.
        createdAt:
          type:
            - string
            - 'null'
          description: Timestamp when the device record was created.
        updatedAt:
          type:
            - string
            - 'null'
          description: Timestamp when the device record was last updated.
        paypointId:
          type:
            - integer
            - 'null'
          description: Numeric identifier for the paypoint.
        paypointDba:
          type:
            - string
            - 'null'
          description: DBA name for the paypoint.
        paypointLegal:
          type:
            - string
            - 'null'
          description: Legal name for the paypoint.
        paypointEntry:
          type:
            - string
            - 'null'
          description: Entry identifier for the paypoint.
        externalPaypointId:
          type:
            - string
            - 'null'
          description: External identifier for the paypoint.
        parentOrgId:
          type:
            - integer
            - 'null'
          description: Numeric identifier for the parent organization.
        parentOrgName:
          type:
            - string
            - 'null'
          description: Name of the parent organization.
    QueryDeviceResponse:
      type: object
      description: Response body for queries about cloud devices.
      required:
        - Summary
        - Records
      properties:
        Summary:
          $ref: '#/components/schemas/QuerySummary'
        Records:
          type: array
          items:
            $ref: '#/components/schemas/DeviceQueryRecord'
    QueryResponseNotificationReportsRecordsItem:
      type: object
      properties:
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        id:
          type: integer
          description: Unique identifier for the report.
        isDownloadable:
          type: boolean
          description: Indicator of whether the report can be downloaded.
        reportName:
          type: string
          description: Name of the report.
    QueryResponseNotificationReports:
      type: object
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/QueryResponseNotificationReportsRecordsItem'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    NotificationContentEventType:
      type: string
      description: The notification's event name.
      enum:
        - ApprovedPayment
        - AuthorizedPayment
        - DeclinedPayment
        - OriginatedPayment
        - SettledPayment
        - SubscriptionCreated
        - SubscriptionUpdated
        - SubscriptionCanceled
        - SubscriptionCompleted
        - FundedPayment
        - VoidedPayment
        - RefundedPayment
        - HoldTransaction
        - ReleasedTransaction
        - HoldBatch
        - ReleasedBatch
        - TransferDisabledCreditFund
        - TransferDisabledDebitFund
        - TransferNotAvailableBalance
        - TransferReturn
        - TransferSuccess
        - TransferSuspended
        - TransferError
        - SendReceipt
        - RecoveredTransaction
        - CreatedApplication
        - ApprovedApplication
        - FailedBoardingApplication
        - SubmittedApplication
        - ActivatedMerchant
        - ReceivedChargeBack
        - ChargebackUpdated
        - ReceivedRetrieval
        - RetrievalUpdated
        - ReceivedAchReturn
        - HoldingApplication
        - DeclinedApplication
        - BoardingApplication
        - FraudAlert
        - InvoiceSent
        - InvoicePaid
        - InvoiceCreated
        - BillPaid
        - BillApproved
        - BillDisApproved
        - BillCanceled
        - BillProcessing
        - CardCreated
        - CardActivated
        - CardDeactivated
        - CardExpired
        - CardExpiring
        - CardLimitUpdated
        - BatchClosed
        - BatchNotClosed
        - PayOutFunded
        - PayOutProcessed
        - PayOutCanceled
        - PayOutPaid
        - PayOutReturned
        - PayoutSubscriptionCreated
        - PayoutSubscriptionUpdated
        - PayoutSubscriptionCanceled
        - PayoutSubscriptionCompleted
        - PayoutSubscriptionReminder
        - importFileReceived
        - importFileProcessed
        - importFileError
        - exportFileSent
        - exportFileError
        - FailedEmailNotification
        - FailedWebNotification
        - FailedSMSNotification
        - UserPasswordExpiring
        - UserPasswordExpired
        - TransactionNotFound
        - SystemAlert
        - Report
    NotificationContentFileFormat:
      type: string
      description: |
        Indicate the format of report file to be generated by the engine.
        Used for `method` = `report-email` and `report-web`.
      enum:
        - json
        - csv
        - xlsx
    KeyValueDuo:
      type: object
      properties:
        key:
          type: string
          description: Key name.
        value:
          type: string
          description: Key value.
    NotificationContentReportName:
      type: string
      description: |
        The kind of report to generate. For
        [automated reports](/developers/developer-guides/notifications-and-webhooks-overview#automated-reports)
        only.
      enum:
        - Transaction
        - Settlement
        - Boarding
        - Returned
    NotificationContent:
      type: object
      properties:
        eventType:
          description: The notification's event name.
          $ref: '#/components/schemas/NotificationContentEventType'
        fileFormat:
          description: |-
            Indicate the format of report file to be generated by the engine.
            Used for `method` = *report-email* and *report-web*.
          $ref: '#/components/schemas/NotificationContentFileFormat'
        internalData:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueDuo'
          description: Array of pairs key:value to insert in request body to target in **method** = *web* or *report-web*.
        reportName:
          description: The kind report to generate. For [automated reports](/developers/developer-guides/notifications-and-webhooks-overview#automated-reports) only.
          $ref: '#/components/schemas/NotificationContentReportName'
        timeZone:
          $ref: '#/components/schemas/Timezone'
        transactionId:
          type: string
          description: Used internally to reference the entity or object generating the event.
          default: '0'
        webHeaderParameters:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueDuo'
          description: Array of pairs key:value to insert in header of request to target in **method** = *web* or *report-web*.
    Frequencynotification:
      type: string
      description: Frequency for notifications.
      enum:
        - one-time
        - daily
        - weekly
        - biweekly
        - monthly
        - quarterly
        - semiannually
        - annually
        - untilcancelled
      x-fern-enum:
        one-time:
          name: OneTime
    Methodnotification:
      type: string
      description: Method to use to send the notification to the target.
      enum:
        - email
        - sms
        - web
        - report-email
        - report-web
      x-fern-enum:
        report-email:
          name: ReportEmail
        report-web:
          name: ReportWeb
    NotificationId:
      type: integer
      format: int64
      description: |
        The notification's Payabli identifier. This is the ID used to manage the
        notification.
    Ownerid:
      type: integer
      description: |
        ID for the paypoint or organization that owns the notification.

        If the `ownerType` field is `0`, this field is the same as the `orgId`
        for the organization that owns this notification.

        If the `ownerType` field is `2`, this field is the same as the
        `paypointId` for the paypoint that owns this notification.
    Ownertype:
      type: integer
      description: |
        Entity owner type. Accepted values:

        - `0`: Organization/partner
        - `2`: Paypoint
    Statusnotification:
      type: integer
      description: |
        Status of notification:

        - `0`: Inactive
        - `1`: Active
    Target:
      type: string
      description: |
        Specify the notification target.

        For `method`=`email` the expected value is a list of email addresses
        separated by semicolon.

        For `method`=`sms` the expected value is a list of phone numbers
        separated by semicolon.

        For `method`=`web` the expected value is a valid and complete URL.
        Webhooks support only standard HTTP ports: 80, 443, 8080, or 4443.
    QueryResponseNotificationsRecordsItem:
      type: object
      properties:
        content:
          description: Notification content.
          $ref: '#/components/schemas/NotificationContent'
        createdAt:
          description: Timestamp of when notification was created, in UTC.
          $ref: '#/components/schemas/CreatedAt'
        frequency:
          $ref: '#/components/schemas/Frequencynotification'
        lastUpdated:
          description: Timestamp of when notification was last updated, in UTC.
          $ref: '#/components/schemas/LastModified'
        method:
          $ref: '#/components/schemas/Methodnotification'
        notificationId:
          $ref: '#/components/schemas/NotificationId'
        ownerId:
          $ref: '#/components/schemas/Ownerid'
        ownerName:
          type: string
          description: Name of entity owner of notification.
        ownerType:
          $ref: '#/components/schemas/Ownertype'
        source:
          description: Custom descriptor of source of notification.
          $ref: '#/components/schemas/Source'
        status:
          $ref: '#/components/schemas/Statusnotification'
        target:
          $ref: '#/components/schemas/Target'
    QueryResponseNotifications:
      type: object
      description: Response payload for queries related to notifications
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/QueryResponseNotificationsRecordsItem'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    OrganizationQueryRecordServicesItem:
      type: object
      properties:
        description:
          type: string
        enabled:
          type: boolean
        monthlyCost:
          type: number
          format: double
        name:
          type: string
        reseller:
          type: boolean
        setupCost:
          type: number
          format: double
        txCost:
          type: number
          format: double
        txPercentCost:
          type: number
          format: double
    Instrument:
      type: object
      required:
        - achAccount
        - achRouting
      properties:
        achAccount:
          $ref: '#/components/schemas/Achaccount'
        achRouting:
          $ref: '#/components/schemas/Achrouting'
        billingAddress:
          $ref: '#/components/schemas/BillingAddressNullable'
        billingCity:
          $ref: '#/components/schemas/BillingCityNullable'
        billingCountry:
          $ref: '#/components/schemas/BillingCountryNullable'
        billingState:
          $ref: '#/components/schemas/BillingStateNullable'
        billingZip:
          $ref: '#/components/schemas/BillingZip'
    IsRoot:
      type: boolean
      description: When `true`, indicates that this is the organization's root template.
    Orgcity:
      type: string
      description: The organization's city.
    Orgcountry:
      type: string
      description: The organization's country.
    Orgentryname:
      type: string
      description: |
        The entryname for the org, in string format. If you leave this blank,
        Payabli uses the DBA name.
    Orgidstring:
      type: string
      description: |
        An alternate ID for the organization, in string format. This can be your
        internal identifier for an org, and is typically a name, like "My
        Suborganization".
    Orgstate:
      type: string
      description: The organization's state.
    Orgtimezone:
      type: integer
      description: |
        The org's timezone, in UTC offset. For example, -5 is Eastern time.
    Orgwebsite:
      type: string
      description: The organization's website.
    Orgzip:
      type: string
      description: The organization's ZIP code.
    RecipientEmailNotification:
      type: boolean
      description: |
        When `true`, Payabli will send the applicant a boarding link. Set this
        value to `false` if you are sending pre-filled applications via the API
        and don't want Payabli to send the applicant an email to complete the
        boarding application.
    ReplyToEmail:
      type: string
      format: email
      description: |
        Email address for organization-level communications, such as messages
        about why an application was declined. This is required by commerce
        laws in the US.
    Resumable:
      type: boolean
      description: |
        When `true`, the applicant can save an incomplete application and
        resume it later. When `false`, the applicant won't have an option to
        save their progress, and must complete the application in one session.
    SummaryOrg:
      type: object
      properties:
        amountSubs:
          type: number
          format: double
        amountTx:
          type: number
          format: double
        childOrgs:
          type: integer
        childPaypoints:
          type: integer
        countSubs:
          type: integer
        countTx:
          type: integer
    UsrAccess:
      type: object
      properties:
        roleLabel:
          type: string
        roleValue:
          type: boolean
    Language:
      type: string
      description: The language code.
    NameUser:
      type: string
    OrgXScope:
      type: object
      properties:
        orgEntry:
          $ref: '#/components/schemas/Orgentryname'
        orgId:
          $ref: '#/components/schemas/Orgid'
        orgType:
          $ref: '#/components/schemas/Orgtype'
    UsrStatus:
      type: integer
      description: |
        The user's status:

        - Inactive: `0`
        - Active: `1`
        - Deleted: `-99`
        - Locked: `85`
    UserQueryRecord:
      type: object
      properties:
        Access:
          type: array
          items:
            $ref: '#/components/schemas/UsrAccess'
        AdditionalData:
          $ref: '#/components/schemas/AdditionalDataString'
        createdAt:
          description: The timestamp for the user's creation, in UTC.
          $ref: '#/components/schemas/CreatedAt'
        Email:
          description: The user's email address.
          $ref: '#/components/schemas/Email'
        language:
          $ref: '#/components/schemas/Language'
        lastAccess:
          type: string
          format: date-time
          description: The timestamp for the user's last activity, in UTC.
        Name:
          $ref: '#/components/schemas/NameUser'
        Phone:
          description: The user's phone number.
          $ref: '#/components/schemas/PhoneNumber'
        Scope:
          type: array
          items:
            $ref: '#/components/schemas/OrgXScope'
        snData:
          type: string
          description: Additional data provided by the social network related to the customer.
        snIdentifier:
          type: string
          description: Identifier or token for customer in linked social network.
        snProvider:
          type: string
          description: 'Social network linked to customer. Possible values: facebook, google, twitter, microsoft.'
        timeZone:
          $ref: '#/components/schemas/Timezone'
        userId:
          type: integer
          format: int64
          description: The user's ID in Payabli.
        UsrMFA:
          $ref: '#/components/schemas/Mfa'
        UsrMFAMode:
          $ref: '#/components/schemas/MfaMode'
        UsrStatus:
          $ref: '#/components/schemas/UsrStatus'
    OrganizationQueryRecord:
      type: object
      properties:
        services:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationQueryRecordServicesItem'
        billingInfo:
          $ref: '#/components/schemas/Instrument'
        contacts:
          $ref: '#/components/schemas/ContactsField'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        hasBilling:
          type: boolean
        hasResidual:
          type: boolean
        idOrg:
          $ref: '#/components/schemas/Orgid'
        isRoot:
          $ref: '#/components/schemas/IsRoot'
        orgAddress:
          $ref: '#/components/schemas/Orgaddress'
        orgCity:
          $ref: '#/components/schemas/Orgcity'
        orgCountry:
          $ref: '#/components/schemas/Orgcountry'
        orgEntryName:
          $ref: '#/components/schemas/Orgentryname'
        orgId:
          $ref: '#/components/schemas/Orgidstring'
        orgLogo:
          $ref: '#/components/schemas/FileContent'
        orgName:
          $ref: '#/components/schemas/Orgname'
        orgParentId:
          $ref: '#/components/schemas/OrgParentId'
        orgParentName:
          $ref: '#/components/schemas/OrgParentName'
        orgState:
          $ref: '#/components/schemas/Orgstate'
        orgTimezone:
          $ref: '#/components/schemas/Orgtimezone'
        orgType:
          $ref: '#/components/schemas/Orgtype'
        orgWebsite:
          $ref: '#/components/schemas/Orgwebsite'
        orgZip:
          $ref: '#/components/schemas/Orgzip'
        recipientEmailNotification:
          $ref: '#/components/schemas/RecipientEmailNotification'
        replyToEmail:
          $ref: '#/components/schemas/ReplyToEmail'
        resumable:
          $ref: '#/components/schemas/Resumable'
        summary:
          $ref: '#/components/schemas/SummaryOrg'
        users:
          type: array
          items:
            $ref: '#/components/schemas/UserQueryRecord'
    ListOrganizationsResponse:
      type: object
      required:
        - Records
        - Summary
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationQueryRecord'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    PayoutGatewayConnector:
      type: object
      x-fern-availability: in-development
      properties:
        configuration:
          type: string
        Name:
          type: string
        Mode:
          type: integer
        Bank:
          type: string
        Descriptor:
          type: string
        gatewayID:
          type: integer
        Enabled:
          type: boolean
        EnableACHValidation:
          type: boolean
        TestMode:
          type: boolean
    QueryPayoutTransactionRecordsItemPaymentData:
      type: object
      properties:
        AccountExp:
          $ref: '#/components/schemas/Accountexp'
        accountId:
          $ref: '#/components/schemas/AccountId'
        AccountType:
          $ref: '#/components/schemas/Accounttype'
        AccountZip:
          $ref: '#/components/schemas/Accountzip'
        bankAccount:
          type: string
        binData:
          $ref: '#/components/schemas/BinData'
        cloudSignatureData:
          type: string
        cloudSignatureFormat:
          type: string
        gatewayConnector:
          $ref: '#/components/schemas/PayoutGatewayConnector'
        HolderName:
          description: Card or bank account holder name.
          $ref: '#/components/schemas/Holdername'
        Initiator:
          $ref: '#/components/schemas/Initiator'
        MaskedAccount:
          $ref: '#/components/schemas/Maskedaccount'
        orderDescription:
          $ref: '#/components/schemas/Orderdescription'
        paymentDetails:
          $ref: '#/components/schemas/PaymentDetail'
        payorData:
          type: string
        Sequence:
          $ref: '#/components/schemas/Sequence'
        StoredId:
          description: Identifier of stored payment method used in transaction.
          $ref: '#/components/schemas/Storedmethodid'
        StoredMethodUsageType:
          $ref: '#/components/schemas/StoredMethodUsageType'
    QueryPayoutTransactionRecordsItem:
      type: object
      properties:
        BatchNumber:
          $ref: '#/components/schemas/BatchNumber'
        BatchId:
          type: integer
          description: Identifier of the batch associated with payout transaction.
        Bills:
          type: array
          items:
            $ref: '#/components/schemas/BillPayOutData'
          description: Bills associated with this transaction.
        CardToken:
          type: string
          x-fern-availability: in-development
        CheckData:
          description: Object referencing paper check image.
          $ref: '#/components/schemas/FileContent'
        CheckNumber:
          type: string
          description: Paper check number related to payout transaction.
        Comments:
          description: Any comment or description for payout transaction.
          $ref: '#/components/schemas/Comments'
        CreatedAt:
          description: Timestamp when the payment was created, in UTC.
          $ref: '#/components/schemas/CreatedAt'
        EntryName:
          $ref: '#/components/schemas/Entrypointfield'
        Events:
          type: array
          items:
            $ref: '#/components/schemas/QueryTransactionEvents'
          description: Events associated with this transaction.
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        FeeAmount:
          $ref: '#/components/schemas/FeeAmount'
        Gateway:
          $ref: '#/components/schemas/Gatewayfield'
        HasVcardTransactions:
          $ref: '#/components/schemas/HasVcardTransactions'
          x-fern-availability: in-development
        IdOut:
          type: integer
          format: int64
          description: Identifier of payout transaction.
        IsSameDayACH:
          $ref: '#/components/schemas/IsSameDayACH'
          x-fern-availability: in-development
        LastUpdated:
          description: Timestamp when payment record was updated.
          $ref: '#/components/schemas/LastModified'
        NetAmount:
          description: Net amount paid.
          $ref: '#/components/schemas/Netamountnullable'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        ParentOrgId:
          $ref: '#/components/schemas/OrgParentId'
        PaymentData:
          $ref: '#/components/schemas/QueryPayoutTransactionRecordsItemPaymentData'
        PaymentId:
          $ref: '#/components/schemas/PaymentIdString'
        PaymentMethod:
          type: string
          description: The payment method for the transaction.
        PaymentStatus:
          type: string
          description: Status of payout transaction. See [Payout Transaction Statuses](guides/money-out-statuses#payout-transaction-statuses) for a full reference.
        PayoutProgram:
          $ref: '#/components/schemas/PayoutProgram'
          x-fern-availability: in-development
        PaypointDbaname:
          $ref: '#/components/schemas/Dbaname'
        PaypointLegalname:
          description: Paypoint legal name.
          $ref: '#/components/schemas/Legalname'
        RiskAction:
          $ref: '#/components/schemas/RiskAction'
        RiskActionCode:
          $ref: '#/components/schemas/RiskActionCode'
        RiskFlagged:
          $ref: '#/components/schemas/RiskFlagged'
        RiskFlaggedOn:
          $ref: '#/components/schemas/RiskFlaggedOn'
        RiskReason:
          $ref: '#/components/schemas/RiskReason'
        RiskStatus:
          $ref: '#/components/schemas/RiskStatus'
        ScheduleId:
          $ref: '#/components/schemas/ScheduleId'
          x-fern-availability: in-development
        SettlementStatus:
          $ref: '#/components/schemas/SettlementStatusPayout'
        Source:
          $ref: '#/components/schemas/Source'
        Status:
          type: integer
          description: Internal status of transaction.
        TotalAmount:
          type: number
          format: double
          description: Transaction total amount (including service fee or sub-charge).
        Vendor:
          description: Vendor related to the payout transaction.
          $ref: '#/components/schemas/VendorQueryRecord'
    QueryPayoutTransactionSummary:
      type: object
      properties:
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        pageSize:
          $ref: '#/components/schemas/Pagesize'
        totalAmount:
          type: number
          format: double
        totalAuthorized:
          type: integer
        totalAuthorizedAmount:
          type: number
          format: double
        totalCanceled:
          type: integer
        totalCanceledAmount:
          type: number
          format: double
        totalCaptured:
          type: integer
        totalCapturedAmount:
          type: number
          format: double
        totalNetAmount:
          type: number
          format: double
        totalOpen:
          type: integer
        totalOpenAmount:
          type: number
          format: double
        totalPages:
          type: integer
        totalPaid:
          type: integer
        totalPaidAmount:
          type: number
          format: double
        totalOnHold:
          type: integer
          description: Total number of transactions that are currently on hold.
        totalOnHoldAmount:
          type: number
          format: double
          description: Total amount of transactions that are currently on hold.
        totalProcessing:
          type: integer
        totalProcessingAmount:
          type: number
          format: double
        totalRecords:
          type: integer
    QueryPayoutTransaction:
      type: object
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/QueryPayoutTransactionRecordsItem'
        Summary:
          $ref: '#/components/schemas/QueryPayoutTransactionSummary'
    Avgmonthly:
      type: number
      format: double
      description: |
        Average total amount of transactions in your local currency that are
        processed each month.
    Avgticketamt:
      type: number
      format: double
      description: Average ticket amount.
    Baddress1:
      type: string
      description: |
        Business address. This must be a physical address, not a P.O. box.
    Baddress2:
      type: string
      description: |
        Business address additional line. If used, this must be the physical
        address of the business, not a P.O. box.
    Bcity:
      type: string
      description: Business city.
    Bcountry:
      type: string
      description: |
        Business country in ISO-3166-1 alpha 2 format.
        See [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) for more
        information.
    Bphone:
      type: string
      description: Business phone number.
    Binperson:
      type: integer
      description: |
        Numeric percent of volume processed in person. To pass validation,
        `binperson`, `binweb`, and `binphone` must total 100 together.
    Binphone:
      type: integer
      description: |
        Numeric percent of volume processed by phone. To pass validation,
        `binperson`, `binweb`, and `binphone` must total 100 together.
    Binweb:
      type: integer
      description: |
        Numeric percent of volume processed on web. To pass validation,
        `binperson`, `binweb`, and `binphone` must total 100 together.
    Busstartdate:
      type: string
      description: |
        Business start date. Accepted formats:

        - YYYY-MM-DD
        - MM/DD/YYYY
    Bstate:
      type: string
      description: Business state.
    Bsummary:
      type: string
      description: A summary of what the business sells in terms of goods or services.
    Bzip:
      type: string
      description: Business ZIP.
    Highticketamt:
      type: number
      format: double
      description: Highest ticket amount.
    License:
      type: string
      description: Business license ID or state ID number.
    Licensestate:
      type: string
      description: Business license issuing state or province.
    Maddress:
      type: string
      description: The business's mailing address.
    Maddress1:
      type: string
      description: Additional line for the business's mailing address.
    Mcity:
      type: string
      description: The business's mail city.
    Mcountry:
      type: string
      description: Business mailing country.
    Mstate:
      type: string
      description: The business's mailing address state.
    Mzip:
      type: string
      description: Business mailing ZIP.
    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:
          description: Owner email.
          $ref: '#/components/schemas/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/AdditionalDataString'
    Ownership:
      type: array
      items:
        $ref: '#/components/schemas/Owners'
      description: List of Owners with at least a 25% ownership.
    OwnType:
      type: string
      description: The business ownership type.
      enum:
        - Limited Liability Company
        - Non-Profit Org
        - Partnership
        - Private Corp
        - Public Corp
        - Tax Exempt
        - Government
        - Sole Proprietor
      x-fern-enum:
        Limited Liability Company:
          name: LimitedLiabilityCompany
        Non-Profit Org:
          name: NonProfitOrg
        Private Corp:
          name: PrivateCorp
        Public Corp:
          name: PublicCorp
        Tax Exempt:
          name: TaxExempt
        Sole Proprietor:
          name: SoleProprietor
    SalesCode:
      type: string
    Taxfillname:
      type: string
      description: |
        Business name in tax document. This is only relevant if a government
        entity has given you an alternative name to file tax documents with.
    TemplateId:
      type: integer
      format: int64
      description: The associated boarding template's ID in Payabli.
    Whencharged:
      type: string
      description: |
        Describes when customers are charged for goods or services.
      enum:
        - When Service Provided
        - In Advance
      x-fern-enum:
        When Service Provided:
          name: WhenServiceProvided
        In Advance:
          name: InAdvance
    Whendelivered:
      type: string
      description: When goods and services are delivered.
      enum:
        - 0-7 Days
        - 8-14 Days
        - 15-30 Days
        - Over 30 Days
      x-fern-enum:
        0-7 Days:
          name: Zero7Days
        8-14 Days:
          name: Eight14Days
        15-30 Days:
          name: Fifteen30Days
        Over 30 Days:
          name: Over30Days
    Whenprovided:
      type: string
      description: |
        Describes when goods or services are provided, from time of transaction.
      enum:
        - 30 Days or Less
        - 31 to 60 Days
      x-fern-enum:
        30 Days or Less:
          name: ThirtyDaysOrLess
        31 to 60 Days:
          name: ThirtyOneTo60Days
    Whenrefunded:
      type: string
      description: Describes the business refund policy.
      enum:
        - Exchange Only
        - No Refund or Exchange
        - More than 30 days
        - 30 Days or Less
      x-fern-enum:
        Exchange Only:
          name: ExchangeOnly
        No Refund or Exchange:
          name: NoRefundOrExchange
        More than 30 days:
          name: MoreThan30Days
        30 Days or Less:
          name: ThirtyDaysOrLess
    QueryEntrypointResponseRecordsItem:
      type: object
      properties:
        AverageMonthlyVolume:
          $ref: '#/components/schemas/Avgmonthly'
        AverageTicketAmount:
          $ref: '#/components/schemas/Avgticketamt'
        BAddress1:
          $ref: '#/components/schemas/Baddress1'
        BAddress2:
          $ref: '#/components/schemas/Baddress2'
        BankData:
          $ref: '#/components/schemas/BankData'
        BCity:
          $ref: '#/components/schemas/Bcity'
        BCountry:
          $ref: '#/components/schemas/Bcountry'
        BFax:
          description: The business's fax number.
          $ref: '#/components/schemas/Bphone'
        BinPerson:
          $ref: '#/components/schemas/Binperson'
        BinPhone:
          $ref: '#/components/schemas/Binphone'
        BinWeb:
          $ref: '#/components/schemas/Binweb'
        BoardingId:
          $ref: '#/components/schemas/BoardingId'
        BPhone:
          $ref: '#/components/schemas/Bphone'
        BStartdate:
          $ref: '#/components/schemas/Busstartdate'
        BState:
          $ref: '#/components/schemas/Bstate'
        BSummary:
          $ref: '#/components/schemas/Bsummary'
        BTimeZone:
          $ref: '#/components/schemas/Timezone'
        BZip:
          $ref: '#/components/schemas/Bzip'
        ContactData:
          $ref: '#/components/schemas/ContactsField'
        CreatedAt:
          $ref: '#/components/schemas/CreatedAt'
        DbaName:
          $ref: '#/components/schemas/Dbaname'
        DocumentsRef:
          type: string
        Ein:
          $ref: '#/components/schemas/Ein'
        EntryPoints:
          type: array
          items:
            $ref: '#/components/schemas/PaypointEntryConfig'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        ExternalProcessorInformation:
          $ref: '#/components/schemas/ExternalProcessorInformation'
        HighTicketAmount:
          $ref: '#/components/schemas/Highticketamt'
        IdPaypoint:
          $ref: '#/components/schemas/Idpaypoint'
        LastModified:
          $ref: '#/components/schemas/LastModified'
        LegalName:
          $ref: '#/components/schemas/Legalname'
        License:
          $ref: '#/components/schemas/License'
        LicenseState:
          $ref: '#/components/schemas/Licensestate'
        MAddress1:
          $ref: '#/components/schemas/Maddress'
        MAddress2:
          $ref: '#/components/schemas/Maddress1'
        Mccid:
          type: string
        MCity:
          $ref: '#/components/schemas/Mcity'
        MCountry:
          $ref: '#/components/schemas/Mcountry'
        MState:
          $ref: '#/components/schemas/Mstate'
        MZip:
          $ref: '#/components/schemas/Mzip'
        OrgId:
          $ref: '#/components/schemas/Orgid'
        OrgParentName:
          $ref: '#/components/schemas/OrgParentName'
        OwnerData:
          $ref: '#/components/schemas/Ownership'
        OwnType:
          $ref: '#/components/schemas/OwnType'
        PaypointStatus:
          $ref: '#/components/schemas/Paypointstatus'
        SalesCode:
          $ref: '#/components/schemas/SalesCode'
        ServiceData:
          $ref: '#/components/schemas/Services'
        summary:
          $ref: '#/components/schemas/PaypointSummary'
        Taxfillname:
          $ref: '#/components/schemas/Taxfillname'
        TemplateId:
          $ref: '#/components/schemas/TemplateId'
        WebsiteAddress:
          description: Business website.
          $ref: '#/components/schemas/Website'
        Whencharged:
          $ref: '#/components/schemas/Whencharged'
        Whendelivered:
          $ref: '#/components/schemas/Whendelivered'
        Whenprovided:
          $ref: '#/components/schemas/Whenprovided'
        Whenrefund:
          $ref: '#/components/schemas/Whenrefunded'
    QueryEntrypointResponse:
      type: object
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/QueryEntrypointResponseRecordsItem'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    QueryResponseSettlementsRecordsItem:
      type: object
      properties:
        BatchAmount:
          type: number
          format: double
          description: The batch amount.
        BatchNumber:
          $ref: '#/components/schemas/BatchNumber'
        Category:
          $ref: '#/components/schemas/Category'
        CreatedAt:
          $ref: '#/components/schemas/CreatedAt'
        Customer:
          $ref: '#/components/schemas/QueryTransactionPayorData'
        DepositDate:
          $ref: '#/components/schemas/DepositDate'
        ExpectedDepositDate:
          $ref: '#/components/schemas/ExpectedDepositDate'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        GatewayTransId:
          type: string
          description: Internal identifier used for processing.
        Id:
          type: integer
        invoiceData:
          $ref: '#/components/schemas/BillData'
        isHold:
          type: integer
          description: |-
            Describes whether the transaction is being held or not.
            1 - Transaction is held
            0 - Transaction isn't being held
        MaskedAccount:
          $ref: '#/components/schemas/Maskedaccount'
        Method:
          type: string
          description: The payment method.
        NetAmount:
          description: Net amount paid.
          $ref: '#/components/schemas/Netamountnullable'
        Operation:
          type: string
          description: The operation performed.
        OrderId:
          $ref: '#/components/schemas/OrderId'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        PaymentData:
          $ref: '#/components/schemas/QueryPaymentData'
        PaymentTransId:
          type: string
          description: The transaction ID for the payment.
        PaymentTransStatus:
          $ref: '#/components/schemas/TransStatus'
        PaypointDbaname:
          type: string
          description: Paypoint DBA name.
        PaypointEntryname:
          type: string
          description: Paypoint entryname.
        PaypointLegalname:
          type: string
          description: Paypoint legal name.
        ResponseData:
          $ref: '#/components/schemas/QueryResponseData'
        ScheduleReference:
          type: integer
          description: Reference to the subscription originating the transaction.
        SettledAmount:
          type: number
          format: double
          description: The transaction amount.
        SettlementDate:
          type: string
          format: date-time
          description: The date and time when the transaction was settled. This field is null when the transaction's `SettlementStatus` is -1, -5, or -6 (Exception, Held, or Released).
        Source:
          $ref: '#/components/schemas/Source'
        Status:
          $ref: '#/components/schemas/SettlementStatus'
        TransactionEvents:
          type: array
          items:
            $ref: '#/components/schemas/QueryTransactionEvents'
          description: Events associated with this transaction.
        TransactionTime:
          $ref: '#/components/schemas/TransactionTime'
        TransMethod:
          type: string
          description: 'Payment method used: card or ach.'
        Type:
          type: string
          description: 'The transaction type: credit or debit.'
    QueryResponseSettlementsSummary:
      type: object
      properties:
        heldAmount:
          type: number
          format: double
          description: Funds being held for fraud or risk concerns.
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
        pageSize:
          type: integer
          description: Number of records per page.
        refunds:
          type: number
          format: double
          description: Total refunds deducted from the transfer.
        serviceFees:
          type: number
          format: double
          description: Service fees are any pass-through fees charged to the customer at the time of payment. These aren't transferred to the merchant when the batch is transferred and funded.
        totalAmount:
          type: number
          format: double
          description: The total sum of the settlements in the response.
        totalNetAmount:
          type: number
          format: double
          description: The total sum of the settlements in the response.
        totalPages:
          type: integer
          description: Number of pages in the response.
        totalRecords:
          type: integer
          description: Number of records in the response.
        transferAmount:
          type: number
          format: double
          description: The transfer amount is the net batch amount plus or minus any returns, refunds, billing and fees items, chargebacks, adjustments, and third party payments. This is the amount from the batch that's transferred to the merchant bank account.
    QueryResponseSettlements:
      type: object
      description: Describes the response for settlement queries.
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/QueryResponseSettlementsRecordsItem'
        Summary:
          $ref: '#/components/schemas/QueryResponseSettlementsSummary'
    QuerySubscriptionResponse:
      type: object
      description: Subscription query response body.
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionQueryRecords'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    PayoutSubscriptionQueryRecordPascal:
      type: object
      required:
        - StartDate
        - EndDate
        - NextDate
        - LastRun
      properties:
        IdOutSubscription:
          type: integer
          format: int64
          description: The payout subscription's ID.
        Status:
          type: integer
          description: |-
            The payout subscription's status.
            - 0: Paused
            - 1: Active
        Events:
          type: array
          items:
            $ref: '#/components/schemas/GeneralEvents'
          description: Events associated with the payout subscription.
        Vendor:
          $ref: '#/components/schemas/VendorQueryRecord'
        BillData:
          type: array
          items:
            $ref: '#/components/schemas/BillPayOutData'
          description: Bills associated with the payout subscription.
        ExternalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        Method:
          type: string
          description: The payout subscription's payment method.
        PaypointId:
          $ref: '#/components/schemas/PaypointId'
        TotalAmount:
          type: number
          format: double
          description: The payout subscription amount, including any fees.
        NetAmount:
          description: The payout subscription amount, minus any fees.
          $ref: '#/components/schemas/Netamountnullable'
        FeeAmount:
          type: number
          format: double
          description: Fee applied to the payout subscription.
        PaymentData:
          $ref: '#/components/schemas/QueryPaymentData'
        StartDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The payout subscription start date.
        EndDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The payout subscription's end date.
        NextDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The next date the payout subscription will be processed.
        Frequency:
          type: string
          description: The payout subscription's frequency.
        TotalCycles:
          type: integer
          description: The total number of cycles the payout subscription is set to run.
        LeftCycles:
          type: integer
          description: The number of cycles the payout subscription has left.
        LastRun:
          type:
            - string
            - 'null'
          format: date-time
          description: The last time the payout subscription was processed.
        EntrypageId:
          $ref: '#/components/schemas/EntrypageId'
        UntilCancelled:
          type: boolean
          description: When `true`, the payout subscription has no explicit end date and runs until canceled.
        LastUpdated:
          description: The last date and time the payout subscription was updated.
          $ref: '#/components/schemas/LastModified'
        CreatedAt:
          description: Timestamp of when the payout subscription was created, in UTC.
          $ref: '#/components/schemas/CreatedAt'
        PaypointLegalname:
          description: The paypoint's legal name.
          $ref: '#/components/schemas/Legalname'
        PaypointDbaname:
          description: The paypoint's DBA name.
          $ref: '#/components/schemas/Dbaname'
        PaypointEntryname:
          description: The paypoint's entryname.
          $ref: '#/components/schemas/Entrypointfield'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        ParentOrgId:
          $ref: '#/components/schemas/OrgParentId'
        Source:
          $ref: '#/components/schemas/Source'
    QueryPayoutSubscriptionResponse:
      type: object
      description: Payout subscription query response body.
      properties:
        Summary:
          $ref: '#/components/schemas/QuerySummary'
        Records:
          type: array
          items:
            $ref: '#/components/schemas/PayoutSubscriptionQueryRecordPascal'
    QueryResponseTransactions:
      type: object
      description: Response payload for queries related to transactions
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/TransactionQueryRecords'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    limitRecord:
      type: integer
      description: Max number of records to return for the query. Use `0` or negative value to return all records. Defaults to 20.
    BillingFeeDetail:
      type: object
      properties:
        billableEvent:
          type: string
        service:
          type: string
        eventId:
          type: string
        description:
          type: string
          description: Description of the billing fee
        category:
          type: string
          description: Category of the billing fee
        fixPrice:
          type: number
          format: double
          description: Fixed price component of the fee
        floatPrice:
          type: number
          format: double
          description: Percentage component of the fee
        billableAmount:
          type: number
          format: double
          description: Amount eligible for the fee
        billAmount:
          type: number
          format: double
          description: Total fee amount charged
        frequency:
          type: string
        serviceGroup:
          type: string
    TransferDetailRecord:
      type: object
      required:
        - transferDetailId
        - transferId
        - transactionId
        - transactionNumber
        - type
        - category
        - grossAmount
        - chargeBackAmount
        - returnedAmount
        - refundAmount
        - holdAmount
        - releasedAmount
        - billingFeesAmount
        - thirdPartyPaidAmount
        - adjustmentsAmount
        - netTransferAmount
        - splitFundingAmount
        - cardRejectedAmount
        - billingFeesDetails
        - ParentOrgName
        - PaypointDbaname
        - PaypointLegalname
        - PaypointEntryname
        - PaymentTransId
        - ConnectorName
        - ExternalProcessorInformation
        - GatewayTransId
        - OrderId
        - Method
        - BatchNumber
        - BatchAmount
        - PayorId
        - PaymentData
        - TransStatus
        - PaypointId
        - TotalAmount
        - NetAmount
        - FeeAmount
        - SettlementStatus
        - Operation
        - ResponseData
        - Source
        - ScheduleReference
        - OrgId
        - RefundId
        - ReturnedId
        - ChargebackId
        - RetrievalId
        - TransAdditionalData
        - invoiceData
        - EntrypageId
        - externalPaypointID
        - IsValidatedACH
        - TransactionTime
        - Customer
        - splitFundingInstructions
        - CfeeTransactions
        - TransactionEvents
        - PendingFeeAmount
        - RiskFlagged
        - RiskFlaggedOn
        - RiskStatus
        - RiskReason
        - RiskAction
        - RiskActionCode
        - DeviceId
        - AchSecCode
        - AchHolderType
        - IpAddress
        - IsSameDayACH
        - WalletType
      properties:
        transferDetailId:
          type:
            - integer
            - 'null'
          description: Unique identifier for the transfer detail record
        transferId:
          type:
            - integer
            - 'null'
          description: The ID of the transfer this detail belongs to
        transactionId:
          type:
            - string
            - 'null'
          description: The transaction ID in Payabli's system
        transactionNumber:
          type:
            - string
            - 'null'
          description: External transaction reference number
        type:
          type:
            - string
            - 'null'
          description: The transaction type (credit or debit)
        category:
          type:
            - string
            - 'null'
          description: 'A field used to categorize the transaction details. Values include: auth, decline, refund, adj, cb, split'
        grossAmount:
          type:
            - number
            - 'null'
          format: double
          description: The gross amount of the transaction
        chargeBackAmount:
          type:
            - number
            - 'null'
          format: double
          description: Chargeback amount deducted from transaction
        returnedAmount:
          type:
            - number
            - 'null'
          format: double
          description: ACH return amount deducted from transaction
        refundAmount:
          type:
            - number
            - 'null'
          format: double
          description: Refund amount deducted from transaction
        holdAmount:
          type:
            - number
            - 'null'
          format: double
          description: Amount being held for fraud or risk concerns
        releasedAmount:
          type:
            - number
            - 'null'
          format: double
          description: Previously held funds that have been released after a risk review
        billingFeesAmount:
          type:
            - number
            - 'null'
          format: double
          description: Charges applied for transactions and services
        thirdPartyPaidAmount:
          type:
            - number
            - 'null'
          format: double
          description: Payments captured in the batch cycle that are deposited separately. For example,  checks or cash payments recorded in the batch but not deposited via Payabli,  or card brands making a direct transfer in certain situations.
        adjustmentsAmount:
          type:
            - number
            - 'null'
          format: double
          description: Corrections applied to Billing & Fees charges
        netTransferAmount:
          type:
            - number
            - 'null'
          format: double
          description: The net amount after all deductions
        splitFundingAmount:
          type:
            - number
            - 'null'
          format: double
          description: Total amount directed to split funding destinations
        cardRejectedAmount:
          type:
            - number
            - 'null'
          format: double
          description: Total amount rejected by card networks or issuing banks after authorization or settling in this transaction
        billingFeesDetails:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/BillingFeeDetail'
        ParentOrgName:
          oneOf:
            - $ref: '#/components/schemas/OrgParentName'
            - type: 'null'
        PaypointDbaname:
          oneOf:
            - $ref: '#/components/schemas/Dbaname'
            - type: 'null'
        PaypointLegalname:
          oneOf:
            - $ref: '#/components/schemas/Legalname'
            - type: 'null'
        PaypointEntryname:
          type:
            - string
            - 'null'
          description: The paypoint's entryname
        PaymentTransId:
          type:
            - string
            - 'null'
          description: The transaction ID for the payment
        ConnectorName:
          type:
            - string
            - 'null'
          description: The payment connector used to process the transaction
        ExternalProcessorInformation:
          oneOf:
            - $ref: '#/components/schemas/ExternalProcessorInformation'
            - type: 'null'
        GatewayTransId:
          type:
            - string
            - 'null'
          description: Internal identifier used for processing
        OrderId:
          oneOf:
            - $ref: '#/components/schemas/OrderId'
            - type: 'null'
        Method:
          type:
            - string
            - 'null'
          description: 'Payment method used: card, ach, or wallet'
        BatchNumber:
          oneOf:
            - $ref: '#/components/schemas/BatchNumber'
            - type: 'null'
        BatchAmount:
          type:
            - number
            - 'null'
          format: double
          description: The amount of the batch
        PayorId:
          description: Unique ID for customer linked to the transaction
          oneOf:
            - $ref: '#/components/schemas/PayorId'
            - type: 'null'
        PaymentData:
          oneOf:
            - $ref: '#/components/schemas/QueryPaymentData'
            - type: 'null'
        TransStatus:
          type:
            - integer
            - 'null'
          description: |-
            Status of transaction. See [the
            docs](/developers/references/money-in-statuses#money-in-transaction-status) for a
            full reference.
        PaypointId:
          oneOf:
            - $ref: '#/components/schemas/PaypointId'
            - type: 'null'
        TotalAmount:
          type:
            - number
            - 'null'
          format: double
          description: Transaction total amount (including service fee or sub-charge)
        NetAmount:
          description: Net amount paid
          oneOf:
            - $ref: '#/components/schemas/Netamountnullable'
            - type: 'null'
        FeeAmount:
          oneOf:
            - $ref: '#/components/schemas/FeeAmount'
            - type: 'null'
        SettlementStatus:
          type:
            - integer
            - 'null'
          description: Settlement status for transaction. See [the docs](/developers/references/money-in-statuses#payment-funding-status) for a full reference.
        Operation:
          oneOf:
            - $ref: '#/components/schemas/Operation'
            - type: 'null'
        ResponseData:
          oneOf:
            - $ref: '#/components/schemas/QueryResponseData'
            - type: 'null'
        Source:
          oneOf:
            - $ref: '#/components/schemas/Source'
            - type: 'null'
        ScheduleReference:
          type:
            - integer
            - 'null'
          description: Reference to the subscription or schedule that originated the transaction
        OrgId:
          oneOf:
            - $ref: '#/components/schemas/Orgid'
            - type: 'null'
        RefundId:
          oneOf:
            - $ref: '#/components/schemas/RefundId'
            - type: 'null'
        ReturnedId:
          oneOf:
            - $ref: '#/components/schemas/ReturnedId'
            - type: 'null'
        ChargebackId:
          oneOf:
            - $ref: '#/components/schemas/ChargebackId'
            - type: 'null'
        RetrievalId:
          oneOf:
            - $ref: '#/components/schemas/RetrievalId'
            - type: 'null'
        TransAdditionalData:
          description: Additional transaction data
          oneOf:
            - {}
            - type: 'null'
        invoiceData:
          description: Associated invoice data
          oneOf:
            - $ref: '#/components/schemas/BillData'
            - type: 'null'
        EntrypageId:
          oneOf:
            - $ref: '#/components/schemas/EntrypageId'
            - type: 'null'
        externalPaypointID:
          oneOf:
            - $ref: '#/components/schemas/ExternalPaypointId'
            - type: 'null'
        IsValidatedACH:
          type:
            - boolean
            - 'null'
          description: Indicates whether the ACH account has been validated
        TransactionTime:
          type:
            - string
            - 'null'
          format: date-time
          description: Transaction date and time, in UTC
        Customer:
          oneOf:
            - $ref: '#/components/schemas/QueryTransactionPayorData'
            - type: 'null'
        splitFundingInstructions:
          oneOf:
            - $ref: '#/components/schemas/SplitFunding'
            - type: 'null'
        CfeeTransactions:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/QueryCFeeTransaction'
        TransactionEvents:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/QueryTransactionEvents'
        PendingFeeAmount:
          oneOf:
            - $ref: '#/components/schemas/PendingFeeAmount'
            - type: 'null'
        RiskFlagged:
          oneOf:
            - $ref: '#/components/schemas/RiskFlagged'
            - type: 'null'
        RiskFlaggedOn:
          oneOf:
            - $ref: '#/components/schemas/RiskFlaggedOn'
            - type: 'null'
        RiskStatus:
          oneOf:
            - $ref: '#/components/schemas/RiskStatus'
            - type: 'null'
        RiskReason:
          oneOf:
            - $ref: '#/components/schemas/RiskReason'
            - type: 'null'
        RiskAction:
          oneOf:
            - $ref: '#/components/schemas/RiskAction'
            - type: 'null'
        RiskActionCode:
          oneOf:
            - $ref: '#/components/schemas/RiskActionCode'
            - type: 'null'
        DeviceId:
          oneOf:
            - $ref: '#/components/schemas/Device'
            - type: 'null'
        AchSecCode:
          oneOf:
            - $ref: '#/components/schemas/AchSecCode'
            - type: 'null'
        AchHolderType:
          oneOf:
            - $ref: '#/components/schemas/AchHolderType'
            - type: 'null'
        IpAddress:
          oneOf:
            - $ref: '#/components/schemas/IpAddress'
            - type: 'null'
        IsSameDayACH:
          type:
            - boolean
            - 'null'
          description: Indicates if this was a same-day ACH transaction.
          x-fern-availability: in-development
        WalletType:
          type:
            - string
            - 'null'
          description: Type of wallet used for the transaction (if applicable)
    QueryTransferSummary:
      type: object
      required:
        - achReturns
        - adjustments
        - billingFees
        - chargebacks
        - grossTransferAmount
        - releaseAmount
        - thirdPartyPaid
        - totalNetAmountTransfer
        - splitAmount
        - serviceFees
        - netBatchAmount
        - transferAmount
        - refunds
        - heldAmount
        - cardRejectedAmount
        - totalRecords
        - totalAmount
        - totalNetAmount
        - totalPages
        - pageSize
        - pageidentifier
      properties:
        achReturns:
          type:
            - number
            - 'null'
          format: double
          description: ACH returns deducted from the batch.
        adjustments:
          type:
            - number
            - 'null'
          format: double
          description: Corrections applied to Billing & Fees charges.
        billingFees:
          type:
            - number
            - 'null'
          format: double
          description: Charges applied for transactions and services.
        chargebacks:
          type:
            - number
            - 'null'
          format: double
          description: Chargebacks deducted from batch.
        grossTransferAmount:
          type:
            - number
            - 'null'
          format: double
          description: The gross batch amount before deductions.
        releaseAmount:
          type:
            - number
            - 'null'
          format: double
          description: Previously held funds that have been released after a risk review.
        thirdPartyPaid:
          type:
            - number
            - 'null'
          format: double
          description: Payments captured in the batch cycle that are deposited separately. For example,  checks or cash payments recorded in the batch but not deposited via Payabli,  or card brands making a direct transfer in certain situations.
        totalNetAmountTransfer:
          type:
            - number
            - 'null'
          format: double
          description: The gross batch amount minus service fees.
        splitAmount:
          type:
            - number
            - 'null'
          format: double
          description: The sum of each splitFundingAmount of each record in the transfer.
        serviceFees:
          type:
            - number
            - 'null'
          format: double
          description: Service fees are any pass-through fees charged to the customer at the time of payment.  These aren't transferred to the merchant when the batch is transferred and funded.
        netBatchAmount:
          type:
            - number
            - 'null'
          format: double
          description: |-
            The net batch amount is the gross batch amount minus any returns, refunds,
            billing and fees items, chargebacks, adjustments, and third party payments.
        transferAmount:
          type:
            - number
            - 'null'
          format: double
          description: The transfer amount is the net batch amount plus or minus any returns, refunds,  billing and fees items, chargebacks, adjustments, and third party payments.  This is the amount from the batch that is transferred to the merchant bank account.
        refunds:
          type:
            - number
            - 'null'
          format: double
          description: Refunds deducted from batch.
        heldAmount:
          type:
            - number
            - 'null'
          format: double
          description: Funds being held for fraud or risk concerns.
        cardRejectedAmount:
          type:
            - number
            - 'null'
          format: double
          description: Total amount rejected by card networks or issuing banks after authorization or settling. This value is the sum of all rejected amounts for transactions in the transfer.
        totalRecords:
          description: Number of records in the response.
          oneOf:
            - $ref: '#/components/schemas/Totalrecords'
            - type: 'null'
        totalAmount:
          type:
            - number
            - 'null'
          format: double
          description: The total sum of the transfers in the response.
        totalNetAmount:
          type:
            - number
            - 'null'
          format: double
          description: The total sum of the transfers in the response.
        totalPages:
          description: Number of pages in the response.
          oneOf:
            - $ref: '#/components/schemas/Totalpages'
            - type: 'null'
        pageSize:
          description: Number of records per page.
          oneOf:
            - $ref: '#/components/schemas/Pagesize'
            - type: 'null'
        pageidentifier:
          description: Auxiliary validation used internally by payment pages and components.
          oneOf:
            - $ref: '#/components/schemas/PageIdentifier'
            - type: 'null'
    QueryTransferDetailResponse:
      type: object
      required:
        - Records
        - Summary
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/TransferDetailRecord'
          description: List of transfer detail records
        Summary:
          description: Summary of the transfer details query
          $ref: '#/components/schemas/QueryTransferSummary'
    TransferBankAccount:
      type: object
      required:
        - accountNumber
        - routingNumber
        - bankName
      properties:
        accountNumber:
          $ref: '#/components/schemas/AccountNumber'
        routingNumber:
          $ref: '#/components/schemas/RoutingAccount'
        bankName:
          $ref: '#/components/schemas/BankName'
    TransferMessageProperties:
      type: object
      required:
        - originalTransferStatus
        - currentTransferStatus
      properties:
        originalTransferStatus:
          type:
            - string
            - 'null'
        currentTransferStatus:
          type:
            - string
            - 'null'
    TransferMessage:
      type: object
      required:
        - Id
        - RoomId
        - UserId
        - UserName
        - Content
        - CreatedAt
        - MessageType
        - MessageProperties
      properties:
        Id:
          type:
            - integer
            - 'null'
        RoomId:
          type:
            - integer
            - 'null'
        UserId:
          type:
            - integer
            - 'null'
        UserName:
          type:
            - string
            - 'null'
        Content:
          type:
            - string
            - 'null'
        CreatedAt:
          type:
            - string
            - 'null'
        MessageType:
          type:
            - integer
            - 'null'
        MessageProperties:
          oneOf:
            - $ref: '#/components/schemas/TransferMessageProperties'
            - type: 'null'
    Transfer:
      type: object
      required:
        - transferId
        - paypointId
        - batchNumber
        - batchCurrency
        - batchRecords
        - transferIdentifier
        - batchId
        - paypointEntryName
        - paypointLegalName
        - paypointDbaName
        - paypointLogo
        - parentOrgName
        - parentOrgId
        - parentOrgEntryName
        - parentOrgLogo
        - externalPaypointID
        - bankAccount
        - transferDate
        - processor
        - transferStatus
        - grossAmount
        - chargeBackAmount
        - returnedAmount
        - holdAmount
        - releasedAmount
        - billingFeesAmount
        - thirdPartyPaidAmount
        - adjustmentsAmount
        - netTransferAmount
        - splitAmount
        - eventsData
        - messages
      properties:
        transferId:
          type: integer
          description: The transfer ID.
        paypointId:
          $ref: '#/components/schemas/PaypointId'
        batchNumber:
          $ref: '#/components/schemas/BatchNumber'
        batchCurrency:
          type:
            - string
            - 'null'
          description: The currency of the batch, either USD or CAD.
        batchRecords:
          type:
            - integer
            - 'null'
          description: Number of records in the batch.
        transferIdentifier:
          $ref: '#/components/schemas/TransferIdentifier'
        batchId:
          type: integer
          description: The ID of the batch the transfer belongs to.
        paypointEntryName:
          type:
            - string
            - 'null'
          description: The paypoint entryname.
        paypointLegalName:
          description: The paypoint legal name.
          oneOf:
            - $ref: '#/components/schemas/Legalname'
            - type: 'null'
        paypointDbaName:
          description: The paypoint DBA name.
          oneOf:
            - $ref: '#/components/schemas/Dbaname'
            - type: 'null'
        paypointLogo:
          type:
            - string
            - 'null'
          description: The paypoint logo URL.
        parentOrgName:
          type:
            - string
            - 'null'
          description: The parent organization name.
        parentOrgId:
          type:
            - integer
            - 'null'
          description: The parent organization ID.
        parentOrgEntryName:
          type:
            - string
            - 'null'
          description: The parent organization entryname.
        parentOrgLogo:
          type:
            - string
            - 'null'
          description: The parent organization logo URL.
        externalPaypointID:
          type:
            - string
            - 'null'
          description: The external paypoint ID.
        bankAccount:
          description: Bank account information for the transfer.
          oneOf:
            - $ref: '#/components/schemas/TransferBankAccount'
            - type: 'null'
        transferDate:
          type: string
          description: Date when the transfer occurred.
        processor:
          type: string
          description: The payment processor used for the transfer.
        transferStatus:
          type: integer
          description: The current status of the transfer.
        grossAmount:
          type: number
          format: double
          description: Gross batch is the total amount of the payments grouped in the batch. This amount includes service fees.
        chargeBackAmount:
          type: number
          format: double
          description: Amount of chargebacks to be deducted from batch.
        returnedAmount:
          type: number
          format: double
          description: Amount of ACH returns to be deducted from batch.
        holdAmount:
          type: number
          format: double
          description: Amount being held for fraud or risk concerns.
        releasedAmount:
          type: number
          format: double
          description: Amount of previously held funds that have been released after a risk review.
        billingFeesAmount:
          type: number
          format: double
          description: Amount of charges and fees applied for services and transactions.
        thirdPartyPaidAmount:
          type: number
          format: double
          description: Amount of payments captured in the batch cycle that are deposited separately. For example, checks or cash payments recorded in the batch but not deposited via Payabli, or card brands making a direct transfer in certain situations.
        adjustmentsAmount:
          type: number
          format: double
          description: Amount of corrections applied to Billing & Fees charges.
        netTransferAmount:
          type: number
          format: double
          description: The net transfer amount after all deductions and additions.
        splitAmount:
          type:
            - number
            - 'null'
          format: double
          description: The sum of each splitFundingAmount of each record in the transfer.
        eventsData:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/GeneralEvents'
          description: List of events associated with the transfer.
        messages:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/TransferMessage'
          description: List of messages related to the transfer.
    TransferSummary:
      type: object
      required:
        - totalPages
        - totalRecords
        - pageSize
      properties:
        totalPages:
          $ref: '#/components/schemas/Totalpages'
        totalRecords:
          $ref: '#/components/schemas/Totalrecords'
        pageSize:
          $ref: '#/components/schemas/Pagesize'
    TransferQueryResponse:
      type: object
      required:
        - Records
        - Summary
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/Transfer'
        Summary:
          $ref: '#/components/schemas/TransferSummary'
    TransferOutSummary:
      type: object
      description: Summary information for outbound transfer queries.
      required:
        - totalPages
        - totalRecords
        - pageSize
      properties:
        totalPages:
          type:
            - integer
            - 'null'
          description: Number of pages in the response.
        totalRecords:
          type:
            - integer
            - 'null'
          description: Number of records in the response.
        pageSize:
          type:
            - integer
            - 'null'
          description: Number of records per page.
    TransferOutBankAccount:
      type: object
      description: Bank account information for an outbound transfer.
      required:
        - accountNumber
        - routingNumber
        - bankName
      properties:
        accountNumber:
          type:
            - string
            - 'null'
          description: The masked bank account number.
        routingNumber:
          type:
            - string
            - 'null'
          description: The bank routing number.
        bankName:
          type:
            - string
            - 'null'
          description: The bank name.
    TransferOutEventData:
      type: object
      description: Event data associated with an outbound transfer.
      required:
        - description
        - eventTime
        - refData
        - extraData
        - source
      properties:
        description:
          type:
            - string
            - 'null'
          description: Description of the event.
        eventTime:
          type:
            - string
            - 'null'
          description: The time the event occurred.
        refData:
          type:
            - string
            - 'null'
          description: Reference data for the event.
        extraData:
          description: Additional event data, which may contain detailed transaction information.
          oneOf:
            - {}
            - type: 'null'
        source:
          type:
            - string
            - 'null'
          description: The source of the event.
    TransferOutMessageProperties:
      type: object
      description: Properties associated with a transfer message.
      required:
        - originalTransferStatus
        - currentTransferStatus
      properties:
        originalTransferStatus:
          type:
            - string
            - 'null'
          description: The original status of the transfer before the message.
        currentTransferStatus:
          type:
            - string
            - 'null'
          description: The current status of the transfer after the message.
    TransferOutMessage:
      type: object
      description: A message associated with an outbound transfer.
      required:
        - Id
        - RoomId
        - UserId
        - UserName
        - Content
        - CreatedAt
        - MessageType
        - MessageProperties
      properties:
        Id:
          type:
            - integer
            - 'null'
          description: Unique identifier for the message.
        RoomId:
          type:
            - integer
            - 'null'
          description: The ID of the room where the message was sent.
        UserId:
          type:
            - integer
            - 'null'
          description: The ID of the user who sent the message.
        UserName:
          type:
            - string
            - 'null'
          description: The name of the user who sent the message.
        Content:
          type:
            - string
            - 'null'
          description: The content of the message.
        CreatedAt:
          type:
            - string
            - 'null'
          description: The time the message was created.
        MessageType:
          type:
            - integer
            - 'null'
          description: The type of message.
        MessageProperties:
          description: Additional properties for the message.
          oneOf:
            - $ref: '#/components/schemas/TransferOutMessageProperties'
            - type: 'null'
    TransferOutRecord:
      type: object
      description: A record representing an outbound transfer.
      required:
        - transferId
        - paypointId
        - batchNumber
        - batchCurrency
        - batchRecords
        - transferIdentifier
        - batchId
        - batchNetAmount
        - batchStatus
        - paypointEntryName
        - paypointLegalName
        - paypointDbaName
        - paypointLogo
        - parentOrgName
        - parentOrgId
        - parentOrgLogo
        - parentOrgEntryName
        - externalPaypointID
        - bankAccount
        - transferDate
        - processor
        - transferStatus
        - grossAmount
        - chargeBackAmount
        - returnedAmount
        - holdAmount
        - releasedAmount
        - billingFeesAmount
        - thirdPartyPaidAmount
        - adjustmentsAmount
        - netTransferAmount
        - splitAmount
        - eventsData
        - messages
      properties:
        transferId:
          type:
            - integer
            - 'null'
          description: Unique identifier for the transfer.
        paypointId:
          type:
            - integer
            - 'null'
          description: The ID of the paypoint associated with the transfer.
        batchNumber:
          type:
            - string
            - 'null'
          description: The batch number for the transfer.
        batchCurrency:
          type:
            - string
            - 'null'
          description: The currency of the batch.
        batchRecords:
          type:
            - integer
            - 'null'
          description: The number of records in the batch.
        transferIdentifier:
          type:
            - string
            - 'null'
          description: An identifier for the transfer.
        batchId:
          type:
            - integer
            - 'null'
          description: The ID of the batch.
        batchNetAmount:
          type:
            - number
            - 'null'
          format: double
          description: The net amount of the batch.
        batchStatus:
          type:
            - integer
            - 'null'
          description: The status of the batch.
        paypointEntryName:
          type:
            - string
            - 'null'
          description: The entry name for the paypoint.
        paypointLegalName:
          type:
            - string
            - 'null'
          description: The legal name of the paypoint.
        paypointDbaName:
          type:
            - string
            - 'null'
          description: The DBA name of the paypoint.
        paypointLogo:
          type:
            - string
            - 'null'
          description: URL to the paypoint's logo.
        parentOrgName:
          type:
            - string
            - 'null'
          description: The name of the parent organization.
        parentOrgId:
          type:
            - integer
            - 'null'
          description: The ID of the parent organization.
        parentOrgLogo:
          type:
            - string
            - 'null'
          description: URL to the parent organization's logo.
        parentOrgEntryName:
          type:
            - string
            - 'null'
          description: The entry name for the parent organization.
        externalPaypointID:
          type:
            - string
            - 'null'
          description: External identifier for the paypoint.
        bankAccount:
          description: Bank account information for the transfer.
          oneOf:
            - $ref: '#/components/schemas/TransferOutBankAccount'
            - type: 'null'
        transferDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The date of the transfer.
        processor:
          type:
            - string
            - 'null'
          description: The processor used for the transfer.
        transferStatus:
          type:
            - integer
            - 'null'
          description: The status of the transfer.
        grossAmount:
          type:
            - number
            - 'null'
          format: double
          description: The gross amount of the transfer.
        chargeBackAmount:
          type:
            - number
            - 'null'
          format: double
          description: The chargeback amount deducted from the transfer.
        returnedAmount:
          type:
            - number
            - 'null'
          format: double
          description: The returned amount deducted from the transfer.
        holdAmount:
          type:
            - number
            - 'null'
          format: double
          description: The amount being held.
        releasedAmount:
          type:
            - number
            - 'null'
          format: double
          description: The amount that has been released.
        billingFeesAmount:
          type:
            - number
            - 'null'
          format: double
          description: The billing fees amount.
        thirdPartyPaidAmount:
          type:
            - number
            - 'null'
          format: double
          description: The third party paid amount.
        adjustmentsAmount:
          type:
            - number
            - 'null'
          format: double
          description: The adjustments amount.
        netTransferAmount:
          type:
            - number
            - 'null'
          format: double
          description: The net transfer amount after all deductions.
        splitAmount:
          type:
            - number
            - 'null'
          format: double
          description: The split funding amount.
        eventsData:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/TransferOutEventData'
          description: List of events associated with the transfer.
        messages:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/TransferOutMessage'
          description: List of messages associated with the transfer.
    TransferOutQueryResponse:
      type: object
      description: Response body for queries about outbound transfers.
      required:
        - Summary
        - Records
      properties:
        Summary:
          description: Summary information about the transfers.
          $ref: '#/components/schemas/TransferOutSummary'
        Records:
          type: array
          items:
            $ref: '#/components/schemas/TransferOutRecord'
          description: List of outbound transfer records.
    TransferOutDetailVendorBillingData:
      type: object
      description: Billing data for a vendor.
      required:
        - id
        - accountId
        - nickname
        - bankName
        - routingAccount
        - accountNumber
        - typeAccount
        - bankAccountHolderName
        - bankAccountHolderType
        - bankAccountFunction
        - verified
        - status
        - services
        - default
        - country
      properties:
        id:
          type:
            - integer
            - 'null'
          description: Unique identifier for the billing data.
        accountId:
          type:
            - string
            - 'null'
          description: The account ID.
        nickname:
          type:
            - string
            - 'null'
          description: A nickname for the account.
        bankName:
          type:
            - string
            - 'null'
          description: The name of the bank.
        routingAccount:
          type:
            - string
            - 'null'
          description: The routing number.
        accountNumber:
          type:
            - string
            - 'null'
          description: The account number.
        typeAccount:
          type:
            - string
            - 'null'
          description: The type of account.
        bankAccountHolderName:
          type:
            - string
            - 'null'
          description: The name of the account holder.
        bankAccountHolderType:
          type:
            - string
            - 'null'
          description: The type of account holder.
        bankAccountFunction:
          type:
            - integer
            - 'null'
          description: The function of the bank account.
        verified:
          type:
            - boolean
            - 'null'
          description: Whether the account is verified.
        status:
          type:
            - integer
            - 'null'
          description: The status of the billing data.
        services:
          type:
            - array
            - 'null'
          items: {}
          description: Services associated with the billing data.
        default:
          type:
            - boolean
            - 'null'
          description: Whether this is the default billing data.
        country:
          type:
            - string
            - 'null'
          description: The country of the bank account.
    TransferOutDetailVendor:
      type: object
      description: Vendor information for an outbound transfer detail.
      required:
        - VendorNumber
        - Name1
        - Name2
        - EIN
        - Phone
        - Email
        - RemitEmail
        - Address1
        - Address2
        - City
        - State
        - Zip
        - Country
        - Mcc
        - LocationCode
        - Contacts
        - BillingData
        - PaymentMethod
        - VendorStatus
        - VendorId
        - EnrollmentStatus
        - Summary
        - PaypointLegalname
        - PaypointId
        - PaypointDbaname
        - PaypointEntryname
        - ParentOrgName
        - ParentOrgId
        - CreatedDate
        - LastUpdated
        - remitAddress1
        - remitAddress2
        - remitCity
        - remitState
        - remitZip
        - remitCountry
        - payeeName1
        - payeeName2
        - customField1
        - customField2
        - customerVendorAccount
        - InternalReferenceId
        - additionalData
        - externalPaypointID
        - StoredMethods
      properties:
        VendorNumber:
          type:
            - string
            - 'null'
          description: The vendor's unique number.
        Name1:
          type:
            - string
            - 'null'
          description: Primary name of the vendor.
        Name2:
          type:
            - string
            - 'null'
          description: Secondary name of the vendor.
        EIN:
          type:
            - string
            - 'null'
          description: Employer Identification Number.
        Phone:
          type:
            - string
            - 'null'
          description: Vendor's phone number.
        Email:
          type:
            - string
            - 'null'
          description: Vendor's email address.
        RemitEmail:
          type:
            - string
            - 'null'
          description: Email for remittance notifications.
        Address1:
          type:
            - string
            - 'null'
          description: Primary address line.
        Address2:
          type:
            - string
            - 'null'
          description: Secondary address line.
        City:
          type:
            - string
            - 'null'
          description: City of the vendor.
        State:
          type:
            - string
            - 'null'
          description: State of the vendor.
        Zip:
          type:
            - string
            - 'null'
          description: ZIP code of the vendor.
        Country:
          type:
            - string
            - 'null'
          description: Country of the vendor.
        Mcc:
          type:
            - string
            - 'null'
          description: Merchant Category Code.
        LocationCode:
          type:
            - string
            - 'null'
          description: Location code for the vendor.
        Contacts:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/ContactsResponse'
          description: List of contacts for the vendor.
        BillingData:
          description: Billing data for the vendor.
          oneOf:
            - $ref: '#/components/schemas/TransferOutDetailVendorBillingData'
            - type: 'null'
        PaymentMethod:
          type:
            - string
            - 'null'
          description: Preferred payment method.
        VendorStatus:
          type:
            - integer
            - 'null'
          description: Status of the vendor.
        VendorId:
          type:
            - integer
            - 'null'
          description: Unique identifier for the vendor.
        EnrollmentStatus:
          type:
            - integer
            - 'null'
          description: Enrollment status of the vendor.
        Summary:
          type:
            - string
            - 'null'
          description: Summary information about the vendor.
        PaypointLegalname:
          type:
            - string
            - 'null'
          description: Legal name of the paypoint.
        PaypointId:
          type:
            - integer
            - 'null'
          description: ID of the paypoint.
        PaypointDbaname:
          type:
            - string
            - 'null'
          description: DBA name of the paypoint.
        PaypointEntryname:
          type:
            - string
            - 'null'
          description: Entry name of the paypoint.
        ParentOrgName:
          type:
            - string
            - 'null'
          description: Name of the parent organization.
        ParentOrgId:
          type:
            - integer
            - 'null'
          description: ID of the parent organization.
        CreatedDate:
          type:
            - string
            - 'null'
          description: Date the vendor was created.
        LastUpdated:
          type:
            - string
            - 'null'
          description: Date the vendor was last updated.
        remitAddress1:
          type:
            - string
            - 'null'
          description: Primary remittance address line.
        remitAddress2:
          type:
            - string
            - 'null'
          description: Secondary remittance address line.
        remitCity:
          type:
            - string
            - 'null'
          description: Remittance city.
        remitState:
          type:
            - string
            - 'null'
          description: Remittance state.
        remitZip:
          type:
            - string
            - 'null'
          description: Remittance ZIP code.
        remitCountry:
          type:
            - string
            - 'null'
          description: Remittance country.
        payeeName1:
          type:
            - string
            - 'null'
          description: Primary payee name.
        payeeName2:
          type:
            - string
            - 'null'
          description: Secondary payee name.
        customField1:
          type:
            - string
            - 'null'
          description: Custom field 1.
        customField2:
          type:
            - string
            - 'null'
          description: Custom field 2.
        customerVendorAccount:
          type:
            - string
            - 'null'
          description: Customer vendor account number.
        InternalReferenceId:
          type:
            - integer
            - 'null'
          description: Internal reference ID.
        additionalData:
          type:
            - object
            - 'null'
          additionalProperties: {}
          description: Additional data for the vendor.
        externalPaypointID:
          type:
            - string
            - 'null'
          description: External paypoint ID.
        StoredMethods:
          type:
            - array
            - 'null'
          items: {}
          description: Stored payment methods for the vendor.
    TransferOutDetailCheckData:
      type: object
      description: Check data for an outbound transfer detail.
      required:
        - CheckNumber
        - CheckData
      properties:
        CheckNumber:
          type:
            - string
            - 'null'
          description: The check number.
        CheckData:
          type:
            - string
            - 'null'
          description: Additional check data.
    TransferOutDetailPaymentData:
      type: object
      description: Payment data for an outbound transfer detail.
      required:
        - MaskedAccount
        - AccountType
        - AccountExp
        - AccountZip
        - HolderName
        - StoredId
        - Initiator
        - StoredMethodUsageType
        - Sequence
        - orderDescription
        - cloudSignatureData
        - cloudSignatureFormat
        - paymentDetails
        - payorData
        - accountId
        - bankAccount
        - gatewayConnector
        - binData
      properties:
        MaskedAccount:
          type:
            - string
            - 'null'
          description: Masked account number.
        AccountType:
          type:
            - string
            - 'null'
          description: Type of account.
        AccountExp:
          type:
            - string
            - 'null'
          description: Account expiration date.
        AccountZip:
          type:
            - string
            - 'null'
          description: ZIP code associated with the account.
        HolderName:
          type:
            - string
            - 'null'
          description: Name of the account holder.
        StoredId:
          type:
            - string
            - 'null'
          description: ID of the stored payment method.
        Initiator:
          type:
            - string
            - 'null'
          description: Initiator of the payment.
        StoredMethodUsageType:
          type:
            - string
            - 'null'
          description: Usage type for stored method.
        Sequence:
          type:
            - string
            - 'null'
          description: Sequence number.
        orderDescription:
          type:
            - string
            - 'null'
          description: Description of the order.
        cloudSignatureData:
          type:
            - string
            - 'null'
          description: Cloud signature data.
        cloudSignatureFormat:
          type:
            - string
            - 'null'
          description: Format of cloud signature.
        paymentDetails:
          description: Additional payment details.
          oneOf:
            - {}
            - type: 'null'
        payorData:
          type:
            - string
            - 'null'
          description: Data about the payor.
        accountId:
          type:
            - string
            - 'null'
          description: Account ID.
        bankAccount:
          type:
            - string
            - 'null'
          description: Bank account information.
        gatewayConnector:
          type:
            - string
            - 'null'
          description: Gateway connector used.
        binData:
          description: BIN data for the card.
          oneOf:
            - {}
            - type: 'null'
    TransferOutDetailBillAttachment:
      type: object
      description: Attachment for a bill.
      required:
        - ftype
        - filename
        - fileDescriptor
        - furl
        - fContent
      properties:
        ftype:
          type:
            - string
            - 'null'
          description: File type.
        filename:
          type:
            - string
            - 'null'
          description: File name.
        fileDescriptor:
          type:
            - string
            - 'null'
          description: File descriptor.
        furl:
          type:
            - string
            - 'null'
          description: File URL.
        fContent:
          type:
            - string
            - 'null'
          description: File content.
    TransferOutDetailBill:
      type: object
      description: Bill information for an outbound transfer detail.
      required:
        - billId
        - LotNumber
        - AccountingField1
        - AccountingField2
        - Terms
        - AdditionalData
        - attachments
        - invoiceNumber
        - netAmount
        - invoiceDate
        - dueDate
        - comments
        - identifier
        - discount
        - totalAmount
      properties:
        billId:
          type:
            - integer
            - 'null'
          description: Unique identifier for the bill.
        LotNumber:
          type:
            - string
            - 'null'
          description: Lot number.
        AccountingField1:
          type:
            - string
            - 'null'
          description: Accounting field 1.
        AccountingField2:
          type:
            - string
            - 'null'
          description: Accounting field 2.
        Terms:
          type:
            - string
            - 'null'
          description: Payment terms.
        AdditionalData:
          type:
            - object
            - 'null'
          additionalProperties: {}
          description: Additional data for the bill.
        attachments:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/TransferOutDetailBillAttachment'
          description: Attachments for the bill.
        invoiceNumber:
          type:
            - string
            - 'null'
          description: Invoice number.
        netAmount:
          type:
            - string
            - 'null'
          description: Net amount of the bill.
        invoiceDate:
          type:
            - string
            - 'null'
          description: Date of the invoice.
        dueDate:
          type:
            - string
            - 'null'
          description: Due date for the bill.
        comments:
          type:
            - string
            - 'null'
          description: Comments on the bill.
        identifier:
          type:
            - string
            - 'null'
          description: Identifier for the bill.
        discount:
          type:
            - number
            - 'null'
          format: double
          description: Discount applied.
        totalAmount:
          type:
            - number
            - 'null'
          format: double
          description: Total amount of the bill.
    TransferOutDetailEvent:
      type: object
      description: Event data for an outbound transfer detail.
      required:
        - TransEvent
        - EventData
        - EventTime
      properties:
        TransEvent:
          type:
            - string
            - 'null'
          description: Description of the transaction event.
        EventData:
          type:
            - string
            - 'null'
          description: Additional event data.
        EventTime:
          type:
            - string
            - 'null'
          description: Time the event occurred.
    TransferOutDetailRecord:
      type: object
      description: A record representing an outbound transfer detail.
      required:
        - transferDetailId
        - transferId
        - transactionId
        - IdOut
        - method
        - type
        - category
        - grossAmount
        - returnedAmount
        - refundAmount
        - holdAmount
        - releasedAmount
        - billingFeesAmount
        - adjustmentsAmount
        - netTransferAmount
        - billingFeesDetails
        - CreatedAt
        - Comments
        - Vendor
        - PaypointDbaname
        - PaypointLegalname
        - PaypointId
        - Status
        - PaymentId
        - TransId
        - TransStatus
        - TransStatusDetail
        - TransStatusName
        - TransStatusCategory
        - LastUpdated
        - TotalAmount
        - NetAmount
        - FeeAmount
        - Source
        - ParentOrgName
        - ParentOrgId
        - BatchNumber
        - PaymentStatus
        - PaymentMethod
        - CardToken
        - CheckNumber
        - CheckData
        - PaymentData
        - Bills
        - Events
        - externalPaypointID
        - EntryName
        - Gateway
        - BatchId
        - HasVcardTransactions
        - IsSameDayACH
        - ScheduleId
        - SettlementStatus
        - SettlementStatusName
        - SettlementDate
        - RiskFlagged
        - RiskFlaggedOn
        - RiskStatus
        - RiskReason
        - RiskAction
        - RiskActionCode
        - PayoutProgram
        - AchTraceNumber
      properties:
        transferDetailId:
          type:
            - integer
            - 'null'
          description: Unique identifier for the transfer detail.
        transferId:
          type:
            - integer
            - 'null'
          description: The ID of the transfer this detail belongs to.
        transactionId:
          type:
            - string
            - 'null'
          description: The transaction ID in Payabli's system.
        IdOut:
          type:
            - integer
            - 'null'
          description: The outbound transaction ID.
        method:
          type:
            - string
            - 'null'
          description: Payment method used.
        type:
          type:
            - string
            - 'null'
          description: The transaction type (credit or debit).
        category:
          type:
            - string
            - 'null'
          description: Category of the transaction detail.
        grossAmount:
          type:
            - number
            - 'null'
          format: double
          description: The gross amount of the transaction.
        returnedAmount:
          type:
            - number
            - 'null'
          format: double
          description: Amount returned.
        refundAmount:
          type:
            - number
            - 'null'
          format: double
          description: Amount refunded.
        holdAmount:
          type:
            - number
            - 'null'
          format: double
          description: Amount being held.
        releasedAmount:
          type:
            - number
            - 'null'
          format: double
          description: Amount released.
        billingFeesAmount:
          type:
            - number
            - 'null'
          format: double
          description: Billing fees amount.
        adjustmentsAmount:
          type:
            - number
            - 'null'
          format: double
          description: Adjustments amount.
        netTransferAmount:
          type:
            - number
            - 'null'
          format: double
          description: Net transfer amount after deductions.
        billingFeesDetails:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/BillingFeeDetail'
          description: Detailed breakdown of billing fees.
        CreatedAt:
          type:
            - string
            - 'null'
          description: Date and time the record was created.
        Comments:
          type:
            - string
            - 'null'
          description: Comments on the transfer detail.
        Vendor:
          description: Vendor information.
          oneOf:
            - $ref: '#/components/schemas/TransferOutDetailVendor'
            - type: 'null'
        PaypointDbaname:
          type:
            - string
            - 'null'
          description: DBA name of the paypoint.
        PaypointLegalname:
          type:
            - string
            - 'null'
          description: Legal name of the paypoint.
        PaypointId:
          type:
            - integer
            - 'null'
          description: ID of the paypoint.
        Status:
          type:
            - integer
            - 'null'
          description: Status of the transfer detail.
        PaymentId:
          type:
            - string
            - 'null'
          description: Payment ID.
        TransId:
          type:
            - string
            - 'null'
          description: Transaction ID.
        TransStatus:
          type:
            - integer
            - 'null'
          description: Transaction status.
        TransStatusDetail:
          type:
            - string
            - 'null'
          description: Detailed transaction status.
        TransStatusName:
          type:
            - string
            - 'null'
          description: Name of the transaction status.
        TransStatusCategory:
          type:
            - string
            - 'null'
          description: Category of the transaction status.
        LastUpdated:
          type:
            - string
            - 'null'
          description: Date and time the record was last updated.
        TotalAmount:
          type:
            - number
            - 'null'
          format: double
          description: Total amount of the transaction.
        NetAmount:
          type:
            - number
            - 'null'
          format: double
          description: Net amount of the transaction.
        FeeAmount:
          type:
            - number
            - 'null'
          format: double
          description: Fee amount for the transaction.
        Source:
          type:
            - string
            - 'null'
          description: Source of the transaction.
        ParentOrgName:
          type:
            - string
            - 'null'
          description: Name of the parent organization.
        ParentOrgId:
          type:
            - integer
            - 'null'
          description: ID of the parent organization.
        BatchNumber:
          type:
            - string
            - 'null'
          description: Batch number for the transfer.
        PaymentStatus:
          type:
            - string
            - 'null'
          description: Status of the payment.
        PaymentMethod:
          type:
            - string
            - 'null'
          description: Payment method used.
        CardToken:
          type:
            - string
            - 'null'
          description: Token for the card used.
        CheckNumber:
          type:
            - string
            - 'null'
          description: Check number if paid by check.
        CheckData:
          description: Check data if paid by check.
          oneOf:
            - $ref: '#/components/schemas/TransferOutDetailCheckData'
            - type: 'null'
        PaymentData:
          description: Payment data for the transaction.
          oneOf:
            - $ref: '#/components/schemas/TransferOutDetailPaymentData'
            - type: 'null'
        Bills:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/TransferOutDetailBill'
          description: Bills associated with the transfer.
        Events:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/TransferOutDetailEvent'
          description: Events associated with the transfer.
        externalPaypointID:
          type:
            - string
            - 'null'
          description: External paypoint ID.
        EntryName:
          type:
            - string
            - 'null'
          description: Entry name for the paypoint.
        Gateway:
          type:
            - string
            - 'null'
          description: Gateway used for the transaction.
        BatchId:
          type:
            - integer
            - 'null'
          description: ID of the batch.
        HasVcardTransactions:
          type:
            - boolean
            - 'null'
          description: Whether the transfer has virtual card transactions.
        IsSameDayACH:
          type:
            - boolean
            - 'null'
          description: Whether this is a same-day ACH transaction.
        ScheduleId:
          type:
            - integer
            - 'null'
          description: ID of the schedule if applicable.
        SettlementStatus:
          type:
            - string
            - 'null'
          description: Settlement status.
        SettlementStatusName:
          type:
            - string
            - 'null'
          description: Name of the settlement status.
        SettlementDate:
          type:
            - string
            - 'null'
          description: Date of settlement.
        RiskFlagged:
          type:
            - boolean
            - 'null'
          description: Whether the transaction was flagged for risk.
        RiskFlaggedOn:
          type:
            - string
            - 'null'
          description: Date and time the transaction was flagged.
        RiskStatus:
          type:
            - string
            - 'null'
          description: Risk status of the transaction.
        RiskReason:
          type:
            - string
            - 'null'
          description: Reason for the risk flag.
        RiskAction:
          type:
            - string
            - 'null'
          description: Action taken for risk.
        RiskActionCode:
          type:
            - integer
            - 'null'
          description: Code for the risk action.
        PayoutProgram:
          type:
            - string
            - 'null'
          description: Payout program used.
        AchTraceNumber:
          type:
            - string
            - 'null'
          description: ACH trace number.
    TransferOutDetailQueryResponse:
      type: object
      description: Response body for queries about outbound transfer details.
      required:
        - Summary
        - Records
      properties:
        Summary:
          description: Summary information about the transfer details.
          $ref: '#/components/schemas/QueryTransferSummary'
        Records:
          type: array
          items:
            $ref: '#/components/schemas/TransferOutDetailRecord'
          description: List of outbound transfer detail records.
    QueryUserResponse:
      type: object
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/UserQueryRecord'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    QueryResponseVendors:
      type: object
      description: Response payload for queries related to vendors.
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/VendorQueryRecord'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    VCardSummary:
      type: object
      required:
        - totalPages
        - totalRecords
        - totalAmount
        - totalactive
        - totalamountactive
        - totalbalanceactive
      properties:
        totalPages:
          $ref: '#/components/schemas/Totalpages'
        totalRecords:
          $ref: '#/components/schemas/Totalrecords'
        totalAmount:
          type: number
          format: double
          description: Total amount for the records.
        totalNetAmount:
          type: number
          format: double
          description: Total net amount for the records.
        totalactive:
          type: integer
          description: Total number of active vCards.
        totalamountactive:
          type: number
          format: double
          description: Total amount of active vCards.
        totalbalanceactive:
          type: number
          format: double
          description: Total balance of active vCards.
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
        pageSize:
          $ref: '#/components/schemas/Pagesize'
    VCardCardType:
      type: integer
      description: |
        The type of virtual card:

        - Single-use virtual card: `0`
        - Ghost card: `2`
    AssociatedVendor:
      type: object
      properties:
        VendorNumber:
          $ref: '#/components/schemas/VendorNumber'
        Name1:
          type: string
          description: Primary name for vendor.
        Name2:
          type: string
          description: Secondary name for vendor.
        EIN:
          $ref: '#/components/schemas/Ein'
        Phone:
          type: string
          description: Vendor's phone number.
        Email:
          description: Vendor's email address.
          $ref: '#/components/schemas/Email'
        Address1:
          type: string
          description: Vendor's address.
        Address2:
          type: string
          description: Additional line for vendor's address.
        City:
          type: string
          description: Vendor's city.
        State:
          type: string
          description: Vendor's state.
        Zip:
          type: string
          description: Vendor's postal code.
        Country:
          type: string
          description: Vendor's country.
        Mcc:
          $ref: '#/components/schemas/Mcc'
        LocationCode:
          $ref: '#/components/schemas/LocationCode'
        Contacts:
          type: array
          items:
            $ref: '#/components/schemas/Contacts'
          description: Array of objects describing the vendor's contacts.
        BillingData:
          $ref: '#/components/schemas/BillingDataResponse'
        PaymentMethod:
          type: string
        VendorStatus:
          $ref: '#/components/schemas/Vendorstatus'
        VendorId:
          type: integer
        EnrollmentStatus:
          $ref: '#/components/schemas/EnrollmentStatus'
        Summary:
          $ref: '#/components/schemas/VendorSummary'
        PaypointLegalname:
          description: The paypoint's legal name.
          $ref: '#/components/schemas/Legalname'
        PaypointDbaname:
          description: The paypoint's DBA name.
          $ref: '#/components/schemas/Dbaname'
        PaypointEntryname:
          description: Paypoint's entryname.
          $ref: '#/components/schemas/Entrypointfield'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        CreatedDate:
          $ref: '#/components/schemas/CreatedAt'
        LastUpdated:
          $ref: '#/components/schemas/LastModified'
        remitAddress1:
          $ref: '#/components/schemas/Remitaddress1'
        remitAddress2:
          $ref: '#/components/schemas/Remitaddress2'
        remitCity:
          $ref: '#/components/schemas/Remitcity'
        remitState:
          $ref: '#/components/schemas/Remitstate'
        remitZip:
          $ref: '#/components/schemas/Remitzip'
        remitCountry:
          $ref: '#/components/schemas/Remitcountry'
        payeeName1:
          $ref: '#/components/schemas/PayeeName'
        payeeName2:
          $ref: '#/components/schemas/PayeeName'
        customField1:
          type: string
        customField2:
          type: string
        customerVendorAccount:
          type: string
        InternalReferenceId:
          $ref: '#/components/schemas/InternalReferenceId'
        additionalData:
          $ref: '#/components/schemas/AdditionalData'
        externalPaypointID:
          type: string
    VCardRecord:
      type: object
      properties:
        vcardSent:
          type: boolean
          description: When `true`, the vCard has been sent.
        cardType:
          $ref: '#/components/schemas/VCardCardType'
        cardToken:
          type: string
        cardNumber:
          type: string
          description: The vCard number.
        cvc:
          type: string
          description: The vCard CVC number.
        expirationDate:
          type: string
          description: Expiration date in format YYYY-MM-DD. The minimum time to expire is 3 months, maximum is 3 years. If not provided, the default is 6 months.
        status:
          type: string
        amount:
          type: number
          format: double
          description: The vCard amount.
        currentBalance:
          type: number
          format: double
          description: The vCard's current balance.
        expenseLimit:
          type: number
          format: double
        expenseLimitPeriod:
          type: string
        maxNumberOfUses:
          type: integer
        currentNumberOfUses:
          type: integer
        exactAmount:
          type: boolean
        mcc:
          type: string
          description: MCC assigned to vCard.
        tcc:
          type: string
          description: TCC assigned to vCard.
        misc1:
          type: string
          description: Custom field 1.
        misc2:
          type: string
          description: Custom field 2.
        dateCreated:
          $ref: '#/components/schemas/CreatedAt'
        dateModified:
          $ref: '#/components/schemas/LastModified'
        associatedVendor:
          $ref: '#/components/schemas/AssociatedVendor'
        associatedCustomer:
          $ref: '#/components/schemas/CustomerData'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        PaypointDbaname:
          description: The paypoint's DBA name.
          $ref: '#/components/schemas/Dbaname'
        PaypointLegalname:
          description: The paypoint's legal name.
          $ref: '#/components/schemas/Legalname'
        PaypointEntryname:
          description: The paypoint's entry name (entrypoint).
          $ref: '#/components/schemas/Entrypointfield'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        paypointId:
          type: integer
          description: The paypoint's unique identifier.
    VCardQueryResponse:
      type: object
      properties:
        Summary:
          $ref: '#/components/schemas/VCardSummary'
        Records:
          type: array
          items:
            $ref: '#/components/schemas/VCardRecord'
    VCardTransactionRecord:
      type: object
      description: A virtual card transaction record returned by the query.
      required:
        - Identifier
        - CardToken
        - LastFour
        - ExpirationDate
        - Mcc
        - PayoutId
        - CustomerId
        - VendorId
        - MiscData1
        - MiscData2
        - CurrentUses
        - Amount
        - Balance
        - PaypointId
        - PaypointLegal
        - PaypointDba
        - ExternalPaypointID
        - OrgName
        - Type
        - Status
        - CreatedOn
        - TransactionAmount
        - PostedAmount
        - PostedOn
        - MerchantName
        - AuthorizationStatus
        - ReasonToDecline
      properties:
        Identifier:
          type:
            - string
            - 'null'
          description: Unique identifier for the transaction.
        CardToken:
          type:
            - string
            - 'null'
          description: Token of the virtual card associated with the transaction.
        LastFour:
          type:
            - string
            - 'null'
          description: Last four digits of the masked virtual card number.
        ExpirationDate:
          type:
            - string
            - 'null'
          description: Expiration date of the virtual card used for the transaction.
        Mcc:
          oneOf:
            - $ref: '#/components/schemas/Mcc'
            - type: 'null'
        PayoutId:
          type:
            - integer
            - 'null'
          format: int64
          description: Identifier of the payout linked to this transaction.
        CustomerId:
          type:
            - integer
            - 'null'
          format: int64
          description: Identifier of the customer linked to this transaction.
        VendorId:
          type:
            - integer
            - 'null'
          format: int64
          description: Identifier of the vendor linked to this transaction.
        MiscData1:
          type:
            - string
            - 'null'
          description: Custom field 1 from the virtual card.
        MiscData2:
          type:
            - string
            - 'null'
          description: Custom field 2 from the virtual card.
        CurrentUses:
          type:
            - integer
            - 'null'
          description: Number of times the virtual card has been used.
        Amount:
          type:
            - number
            - 'null'
          format: double
          description: Authorized amount on the virtual card.
        Balance:
          type:
            - number
            - 'null'
          format: double
          description: Current balance remaining on the virtual card.
        PaypointId:
          type:
            - integer
            - 'null'
          format: int64
          description: Numeric identifier of the paypoint that issued the virtual card.
        PaypointLegal:
          oneOf:
            - $ref: '#/components/schemas/Legalname'
            - type: 'null'
        PaypointDba:
          oneOf:
            - $ref: '#/components/schemas/Dbaname'
            - type: 'null'
        ExternalPaypointID:
          oneOf:
            - $ref: '#/components/schemas/ExternalPaypointId'
            - type: 'null'
        OrgName:
          oneOf:
            - $ref: '#/components/schemas/OrgParentName'
            - type: 'null'
        Type:
          type:
            - string
            - 'null'
          description: Transaction type, such as `AUTHORIZATION`.
        Status:
          type:
            - string
            - 'null'
          description: Transaction status, such as `AUTHORIZATION`.
        CreatedOn:
          type:
            - string
            - 'null'
          description: 'Date and time the transaction was created. Format: `YYYY-MM-DD HH:MM:SS.ffffff`.'
        TransactionAmount:
          type:
            - string
            - 'null'
          description: Amount of the transaction, as a string value.
        PostedAmount:
          type:
            - string
            - 'null'
          description: Posted amount of the transaction, as a string value.
        PostedOn:
          type:
            - string
            - 'null'
          description: Date and time the transaction was posted, in format `YYYY-MM-DD HH:MM:SS.ffffff`. Null when the transaction hasn't posted yet.
        MerchantName:
          type:
            - string
            - 'null'
          description: Name of the merchant where the virtual card was used.
        AuthorizationStatus:
          type:
            - string
            - 'null'
          description: Authorization status of the transaction.
        ReasonToDecline:
          type:
            - string
            - 'null'
          description: Reason the transaction was declined, when applicable.
    VCardTransactionQueryResponse:
      type: object
      description: Response body for queries about virtual card transactions.
      required:
        - Summary
        - Records
      properties:
        Summary:
          $ref: '#/components/schemas/VCardSummary'
        Records:
          type: array
          items:
            $ref: '#/components/schemas/VCardTransactionRecord'
    typeResult:
      type: string
      description: The type of object to create in Payabli. Accepted values are `bill` and `invoice`.
    FileContentImageOnly:
      type: object
      properties:
        ftype:
          $ref: '#/components/schemas/FileContentFtype'
        filename:
          type: string
          description: The name of the file to be uploaded
        furl:
          type: string
          description: Optional URL link to the file
        fContent:
          type: string
          description: Base64-encoded file content
    OcrBillItem:
      type: object
      properties:
        itemTotalAmount:
          type: number
          format: double
        itemTaxAmount:
          type: number
          format: double
        itemTaxRate:
          type: number
          format: double
        itemProductCode:
          type: string
        itemProductName:
          type: string
        itemDescription:
          type: string
        itemCommodityCode:
          type: string
        itemUnitOfMeasure:
          type: string
        itemCost:
          type: number
          format: double
        itemQty:
          type: integer
        itemMode:
          type: integer
        itemCategories:
          type: array
          items:
            type: string
    OcrBillItemAdditionalData:
      type: object
      properties:
        category:
          type: string
        currency_code:
          type: string
        type:
          type: string
        reference_number:
          type: string
    OcrVendorBillingData:
      type: object
      properties:
        id:
          type: integer
        bankName:
          type: string
        routingAccount:
          type: string
        accountNumber:
          type: string
        typeAccount:
          type: string
        bankAccountHolderName:
          type: string
        bankAccountHolderType:
          type: string
        bankAccountFunction:
          type: integer
    OcrVendorAdditionalData:
      type: object
      properties:
        web:
          type: string
    OcrVendor:
      type: object
      properties:
        vendorNumber:
          type: string
        name1:
          type: string
        name2:
          type: string
        ein:
          type: string
        phone:
          type: string
        email:
          type: string
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        zip:
          type: string
        country:
          type: string
        mcc:
          type: string
        locationCode:
          type: string
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/Contacts'
        billingData:
          $ref: '#/components/schemas/OcrVendorBillingData'
        paymentMethod:
          type: string
        vendorStatus:
          type: integer
        remitAddress1:
          type: string
        remitAddress2:
          type: string
        remitCity:
          type: string
        remitState:
          type: string
        remitZip:
          type: string
        remitCountry:
          type: string
        payeeName1:
          type: string
        payeeName2:
          type: string
        customerVendorAccount:
          type: string
        internalReferenceId:
          type: integer
          format: int64
        customField1:
          type: string
        customField2:
          type: string
        additionalData:
          $ref: '#/components/schemas/OcrVendorAdditionalData'
    OcrAttachment:
      type: object
      properties:
        ftype:
          type: string
        filename:
          type: string
        fileDescriptor:
          type: string
        furl:
          type: string
        fContent:
          type: string
    OcrResultData:
      type: object
      properties:
        billNumber:
          type: string
        netAmount:
          type: number
          format: double
        billDate:
          type: string
          format: date-time
        dueDate:
          type: string
          format: date-time
        comments:
          type: string
        billItems:
          type: array
          items:
            $ref: '#/components/schemas/OcrBillItem'
        mode:
          type: integer
        accountingField1:
          type: string
        accountingField2:
          type: string
        additionalData:
          $ref: '#/components/schemas/OcrBillItemAdditionalData'
        vendor:
          $ref: '#/components/schemas/OcrVendor'
        endDate:
          type: string
          format: date-time
        frequency:
          type: string
        terms:
          type: string
        status:
          type: integer
        lotNumber:
          type: string
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/OcrAttachment'
    OcrResponseData:
      type: object
      properties:
        resultData:
          $ref: '#/components/schemas/OcrResultData'
    PayabliApiResponseOCR:
      type: object
      required:
        - isSuccess
        - responseText
        - responseCode
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          description: Details of the OCR processing result
          $ref: '#/components/schemas/OcrResponseData'
    NotificationLogSearchRequest:
      type: object
      required:
        - startDate
        - endDate
      properties:
        startDate:
          type: string
          format: date-time
          description: The start date for the search.
        endDate:
          type: string
          format: date-time
          description: The end date for the search.
        notificationEvent:
          type: string
          description: The type of notification event to filter by.
        succeeded:
          type: boolean
          description: Indicates whether the notification was successful.
        orgId:
          type: integer
          format: int64
          description: The ID of the organization to filter by.
        paypointId:
          type: integer
          format: int64
          description: The ID of the paypoint to filter by.
    NotificationLog:
      type: object
      required:
        - id
        - orgId
        - paypointId
        - notificationEvent
        - target
        - responseStatus
        - success
        - jobData
        - createdDate
        - successDate
        - lastFailedDate
        - isInProgress
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier for the notification.
        orgId:
          type:
            - integer
            - 'null'
          format: int64
          description: The ID of the organization that the notification belongs to.
        paypointId:
          type:
            - integer
            - 'null'
          format: int64
          description: The ID of the paypoint that the notification is related to.
        notificationEvent:
          type:
            - string
            - 'null'
          description: The event that triggered the notification.
        target:
          type:
            - string
            - 'null'
          description: The target URL for the notification.
        responseStatus:
          type:
            - string
            - 'null'
          description: The HTTP response status of the notification.
        success:
          type: boolean
          description: Indicates whether the notification was successful.
        jobData:
          type:
            - string
            - 'null'
          description: Contains the body of the notification.
        createdDate:
          type: string
          format: date-time
          description: The date and time when the notification was created.
        successDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The date and time when the notification was successfully delivered.
        lastFailedDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The date and time when the notification last failed.
        isInProgress:
          type: boolean
          description: Indicates whether the notification is currently in progress.
    StringStringKeyValuePair:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
    KeyValueArray:
      type: object
      properties:
        key:
          type: string
        value:
          type: array
          items:
            type: string
    NotificationLogDetail:
      allOf:
        - $ref: '#/components/schemas/NotificationLog'
        - type: object
          properties:
            webHeaders:
              type: array
              items:
                $ref: '#/components/schemas/StringStringKeyValuePair'
            responseHeaders:
              type: array
              items:
                $ref: '#/components/schemas/KeyValueArray'
            responseContent:
              type: string
    BulkRetryRequest:
      type: array
      items:
        type: string
        format: uuid
      description: A list of notification log IDs to retry. The maximum number of IDs that can be retried in a single request is 50.
    DeviceEntry:
      type: object
      properties:
        description:
          type: string
          description: Description or name for the device. This can be anything, but Payabli recommends entering the name of the paypoint, or some other easy to identify descriptor. If you have several devices for one paypoint, you can give them descriptions like "Cashier 1" and "Cashier 2", or "Front Desk" and "Back Office"
        registrationCode:
          type: string
          description: |-
            The device registration code or serial number, depending on the model.

            - Ingenico devices: This is the activation code that's displayed on the device screen during setup.

            - PAX A920 device: This code is the serial number on the back of the device.
    AddDeviceResponse:
      allOf:
        - $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
        - type: object
          properties:
            pageIdentifier:
              $ref: '#/components/schemas/PageIdentifier'
            responseData:
              type: string
              description: |
                If `isSuccess` = true, this contains the device identifier.
                If `isSuccess` = false, this contains the reason for the error.
    RemoveDeviceResponse:
      allOf:
        - $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
        - type: object
          properties:
            pageIdentifier:
              $ref: '#/components/schemas/PageIdentifier'
            responseData:
              type: string
              description: |
                If `isSuccess` = true, this contains the device identifier.
                If `isSuccess` = false, this contains the reason for the error.
    PoiDevice:
      type: object
      description: Information about the point of interaction device (also known as a terminal or cloud device) used to process the transaction.
      properties:
        connected:
          type: boolean
          description: The device connection status.
        dateDeRegistered:
          type: string
          format: date-time
          description: The date the device was unregistered.
        dateRegistered:
          type: string
          format: date-time
          description: The date the device was registered.
        deviceId:
          type: string
          description: The device identifier.
        deviceLicense:
          type: string
          description: Device license. This is typically the same as `deviceId`.
        deviceNickName:
          type: string
          description: Device description provided during registration.
        lastConnectedDate:
          type: string
          format: date-time
          description: Last connected date.
        lastDisconnectedDate:
          type: string
          format: date-time
          description: Last disconnected date.
        lastTransactionDate:
          type: string
          format: date-time
          description: Last transaction date.
        make:
          type: string
          description: The device manufacturer.
        model:
          type: string
          description: The device model.
        registered:
          type: boolean
          description: The device registration status.
        serialNumber:
          type: string
          description: The device serial number.
    CloudQueryApiResponse:
      type: object
      description: Object containing details about cloud devices and their registration history.
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseList:
          type: array
          items:
            $ref: '#/components/schemas/PoiDevice'
          description: List of devices and history of registration.
        responseText:
          $ref: '#/components/schemas/ResponseText'
    LineItem:
      type: object
      required:
        - itemCost
        - itemQty
      properties:
        itemCategories:
          type: array
          items:
            type: string
          description: Array of tags classifying item or product.
        itemCommodityCode:
          $ref: '#/components/schemas/ItemCommodityCode'
        itemCost:
          type: number
          format: double
          description: Item or product price per unit.
        itemDescription:
          $ref: '#/components/schemas/ItemDescription'
        itemMode:
          type: integer
          description: 'Internal class of item or product: value ''0'' is only for invoices, ''1'' for bills, and ''2'' is common for both.'
        itemProductCode:
          $ref: '#/components/schemas/ItemProductCode'
        itemProductName:
          $ref: '#/components/schemas/ItemProductName'
        itemQty:
          type: integer
          description: Quantity of item or product.
        itemUnitOfMeasure:
          $ref: '#/components/schemas/ItemUnitofMeasure'
    PayabliApiResponse6:
      type: object
      description: Response schema for line item operations.
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseData:
          description: If `isSuccess` = true, this contains the line item identifier. If `isSuccess` = false, this contains the reason for the error.
          $ref: '#/components/schemas/Responsedatanonobject'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    LineItemQueryRecord:
      type: object
      required:
        - itemCost
        - itemQty
      properties:
        createdAt:
          description: Timestamp of when line item was created, in UTC.
          $ref: '#/components/schemas/CreatedAt'
        id:
          type: integer
          format: int64
          description: Identifier of line item.
        itemCategories:
          type: array
          items:
            type: string
          description: Array of tags classifying item or product.
        itemCommodityCode:
          $ref: '#/components/schemas/ItemCommodityCode'
        itemCost:
          type: number
          format: double
          description: Item or product price per unit.
        itemDescription:
          $ref: '#/components/schemas/ItemDescription'
        itemMode:
          type: integer
          description: 'Internal class of item or product: value ''0'' is only for invoices , ''1'' for bills, and ''2'' common for both.'
        itemProductCode:
          $ref: '#/components/schemas/ItemProductCode'
        itemProductName:
          $ref: '#/components/schemas/ItemProductName'
        itemQty:
          type: integer
          description: Quantity of item or product.
        itemUnitOfMeasure:
          $ref: '#/components/schemas/ItemUnitofMeasure'
        lastUpdated:
          description: Timestamp of when the line item was updated, in UTC.
          $ref: '#/components/schemas/LastModified'
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
        ParentOrgName:
          description: The name of the paypoint's parent organization.
          $ref: '#/components/schemas/OrgParentName'
        PaypointDbaname:
          description: The paypoint's DBA name.
          $ref: '#/components/schemas/Dbaname'
        PaypointEntryname:
          description: The paypoint's entryname (entrypoint) value.
          $ref: '#/components/schemas/Entrypointfield'
        PaypointLegalname:
          description: The paypoint's legal name.
          $ref: '#/components/schemas/Legalname'
    DeleteItemResponse:
      type: object
      required:
        - isSuccess
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    QueryResponseItemsRecordsItem:
      type: object
      properties:
        LineItem:
          $ref: '#/components/schemas/LineItem'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        PaypointDbaname:
          description: The paypoint's DBA name.
          $ref: '#/components/schemas/Dbaname'
        PaypointEntryname:
          description: The paypoint's entry name (entrypoint).
          $ref: '#/components/schemas/Entrypointfield'
        PaypointLegalname:
          description: The paypoint's legal name.
          $ref: '#/components/schemas/Legalname'
    QueryResponseItems:
      type: object
      description: Response for line item queries
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/QueryResponseItemsRecordsItem'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    ApplicationDataPayInServicesAch:
      allOf:
        - $ref: '#/components/schemas/AchSetup'
    ApplicationDataPayInServicesCard:
      allOf:
        - $ref: '#/components/schemas/CardSetup'
    ApplicationDataPayInServices:
      type: object
      required:
        - ach
        - card
      properties:
        ach:
          $ref: '#/components/schemas/ApplicationDataPayInServicesAch'
        card:
          $ref: '#/components/schemas/ApplicationDataPayInServicesCard'
        odp:
          $ref: '#/components/schemas/OdpSetup'
    Annualrevenue:
      type: number
      format: double
      description: Annual revenue amount.
    BoardingAverageBillSize:
      type: string
      description: |
        This is the average amount of each bill you pay through our service. For
        example, if your business paid 3 bills for a total of $1,500 then your
        average bill size is $500.
    BoardingAvgMonthlyBill:
      type: string
      description: |
        This is the total number of bills the business pays each month. For
        example, if your business pays an electric bill of $500, an internet bill
        of $150, and various suppliers $5,000 every month, then your monthly bill
        volume would be $5,650.
    ApplicationDataPayInContactsItem:
      allOf:
        - $ref: '#/components/schemas/Contacts'
    FaxNumber:
      type: string
      description: Fax number.
    ApplicationDataPayInOwnershipItem:
      allOf:
        - $ref: '#/components/schemas/Owners'
    SignerName:
      type: string
      description: The signer's name.
    SignerSsn:
      type: string
      description: The signer's SSN.
    SignerDob:
      type: string
      description: The signer's date of birth.
    SignerPhone:
      type: string
      description: The signer's phone number.
    Signeraddress:
      type: string
      description: |
        The signer's address. This must be the physical address of the signer,
        not a P.O. box.
    SignerAddress1:
      type: string
      description: |
        Additional line for the signer's address. If used, this must be the
        physical address of the signer, not a P.O. box.
    SignerCity:
      type: string
      description: The signer's city.
    SignerCountry:
      type: string
      description: |
        The signer's country in ISO-3166-1 alpha 2 format. See
        [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) for more.
    SignerState:
      type: string
      description: The signer's state.
    SignerZip:
      type: string
      description: The signer's ZIP code.
    SignerAcceptance:
      type: boolean
      description: |
        The signer's acceptance status. A true or false indicating an
        acceptance to the terms of service with the root org or provider.
    SignedDocumentReference:
      type: string
      description: Reference to the signed document.
    PciAttestation:
      type: boolean
      description: |
        When `true`, indicates that the merchant acknowledges PCI responsibilities
        and can be enrolled in the PCI program for breach insurance.
    AttestationDate:
      type: string
      description: |
        Date the attestation was provided for PCI Compliance (`pciAttestation`),
        in MM/DD/YYYY format.
    SignDate:
      type: string
      description: |
        Date when the signer signed the document. Accepted formats:
        YYYY-MM-DD, MM/DD/YYYY.
    SignerDataRequest:
      type: object
      description: Information about the application's signer.
      properties:
        name:
          $ref: '#/components/schemas/SignerName'
        ssn:
          $ref: '#/components/schemas/SignerSsn'
        dob:
          $ref: '#/components/schemas/SignerDob'
        phone:
          $ref: '#/components/schemas/SignerPhone'
        email:
          description: The signer's email address.
          $ref: '#/components/schemas/Email'
        address:
          $ref: '#/components/schemas/Signeraddress'
        address1:
          $ref: '#/components/schemas/SignerAddress1'
        city:
          $ref: '#/components/schemas/SignerCity'
        country:
          $ref: '#/components/schemas/SignerCountry'
        state:
          $ref: '#/components/schemas/SignerState'
        zip:
          $ref: '#/components/schemas/SignerZip'
        acceptance:
          $ref: '#/components/schemas/SignerAcceptance'
        signedDocumentReference:
          $ref: '#/components/schemas/SignedDocumentReference'
        pciAttestation:
          $ref: '#/components/schemas/PciAttestation'
        attestationDate:
          $ref: '#/components/schemas/AttestationDate'
        additionalData:
          $ref: '#/components/schemas/AdditionalDataMap'
        signDate:
          $ref: '#/components/schemas/SignDate'
    Ticketamt:
      type: number
      format: double
      description: |
        The average transaction size that the business expects to process. For
        example, if you process $10,000 a month across 10 transactions, that's
        an average ticket of $1000.
    RepCode:
      type: string
      maxLength: 50
      description: |
        Sales representative code. This is an optional field that can be used
        to track the sales representative associated with the application.
    RepName:
      type: string
      maxLength: 50
      description: |
        Sales representative name. This is an optional field that can be used
        to track the sales representative associated with the application.
    RepOffice:
      type: string
      maxLength: 50
      description: |
        Sales representative office location. This is an optional field that
        can be used to track the sales representative office associated with
        the application.
    OnCreate:
      type: string
      description: |
        Action to take when the application is created. The only currently
        supported option is `submitApplication`. Use this when you have collected
        eSignature elsewhere or are adding additional locations for an applicant,
        or when you want to submit an application via API with one call without
        using the hosted boarding UI or embedded boarding components.
    ApplicationDataPayIn:
      type: object
      description: Fields for Pay In boarding applications.
      required:
        - services
        - bankData
        - phonenumber
        - processingRegion
        - signer
        - whenCharged
        - whenDelivered
        - whenProvided
        - whenRefunded
      properties:
        services:
          $ref: '#/components/schemas/ApplicationDataPayInServices'
        annualRevenue:
          $ref: '#/components/schemas/Annualrevenue'
        averageBillSize:
          $ref: '#/components/schemas/BoardingAverageBillSize'
        averageMonthlyBill:
          $ref: '#/components/schemas/BoardingAvgMonthlyBill'
        avgmonthly:
          $ref: '#/components/schemas/Avgmonthly'
        baddress:
          $ref: '#/components/schemas/Baddress1'
        baddress1:
          $ref: '#/components/schemas/Baddress2'
        bankData:
          $ref: '#/components/schemas/BankData'
        bcity:
          $ref: '#/components/schemas/Bcity'
        bcountry:
          $ref: '#/components/schemas/Bcountry'
        binperson:
          $ref: '#/components/schemas/Binperson'
        binphone:
          $ref: '#/components/schemas/Binphone'
        binweb:
          $ref: '#/components/schemas/Binweb'
        boardingLinkId:
          type: string
          description: Boarding link ID for the application. Either `templateId` or `boardingLinkId` are required.
        bstate:
          $ref: '#/components/schemas/Bstate'
        bsummary:
          $ref: '#/components/schemas/Bsummary'
        btype:
          $ref: '#/components/schemas/OwnType'
        bzip:
          $ref: '#/components/schemas/Bzip'
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationDataPayInContactsItem'
          description: List of contacts for the business.
        creditLimit:
          type: string
          description: The maximum amount of credit that our lending partner has authorized to your business for Pay In processing. It's the upper boundary on how much you can spend or owe on a credit account at any given time. For on-demand payout (Pay Out) credit limits, see `payoutCreditLimit`.
        dbaName:
          description: The alternate or common name that this business is doing business under usually referred to as a DBA name. Payabli strongly recommends including this information.
          $ref: '#/components/schemas/Dbaname'
        ein:
          $ref: '#/components/schemas/Ein'
        externalpaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        faxnumber:
          description: The business's fax number.
          $ref: '#/components/schemas/FaxNumber'
        highticketamt:
          $ref: '#/components/schemas/Highticketamt'
        legalName:
          $ref: '#/components/schemas/Legalname'
        license:
          $ref: '#/components/schemas/License'
        licstate:
          $ref: '#/components/schemas/Licensestate'
        maddress:
          $ref: '#/components/schemas/Maddress'
        maddress1:
          $ref: '#/components/schemas/Maddress1'
        mcc:
          $ref: '#/components/schemas/Mcc'
        mcity:
          $ref: '#/components/schemas/Mcity'
        mcountry:
          $ref: '#/components/schemas/Mcountry'
        mstate:
          $ref: '#/components/schemas/Mstate'
        mzip:
          $ref: '#/components/schemas/Mzip'
        orgId:
          $ref: '#/components/schemas/Orgid'
        ownership:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationDataPayInOwnershipItem'
          description: List of Owners with at least a 25% ownership.
        phonenumber:
          description: The business's phone number.
          $ref: '#/components/schemas/PhoneNumber'
        processingRegion:
          type: string
          description: The business's processing region, either `US` or `CA`.
        recipientEmail:
          description: Email address for the applicant. This is used to send the applicant a boarding link.
          $ref: '#/components/schemas/Email'
        recipientEmailNotification:
          $ref: '#/components/schemas/RecipientEmailNotification'
        resumable:
          $ref: '#/components/schemas/Resumable'
        signer:
          $ref: '#/components/schemas/SignerDataRequest'
        startdate:
          $ref: '#/components/schemas/Busstartdate'
        taxFillName:
          $ref: '#/components/schemas/Taxfillname'
        templateId:
          description: The associated boarding template's ID in Payabli. Either `templateId` or `boardingLinkId` are required.
          $ref: '#/components/schemas/TemplateId'
        ticketamt:
          $ref: '#/components/schemas/Ticketamt'
        website:
          $ref: '#/components/schemas/Website'
        whenCharged:
          $ref: '#/components/schemas/Whencharged'
        whenDelivered:
          $ref: '#/components/schemas/Whendelivered'
        whenProvided:
          $ref: '#/components/schemas/Whenprovided'
        whenRefunded:
          $ref: '#/components/schemas/Whenrefunded'
        additionalData:
          $ref: '#/components/schemas/AdditionalDataMap'
        RepCode:
          $ref: '#/components/schemas/RepCode'
        RepName:
          $ref: '#/components/schemas/RepName'
        RepOffice:
          $ref: '#/components/schemas/RepOffice'
        onCreate:
          $ref: '#/components/schemas/OnCreate'
    ApplicationDataManagedContactsItem:
      allOf:
        - $ref: '#/components/schemas/Contacts'
    BoardingBusinessFax:
      type: string
      description: The business's fax number.
    ApplicationDataManagedOwnershipItem:
      allOf:
        - $ref: '#/components/schemas/Owners'
    BoardingBusinessPhone:
      type: string
      description: The business's phone number.
    ApplicationDataManaged:
      type: object
      required:
        - signer
      properties:
        annualRevenue:
          description: Annual revenue amount. We recommend including this value.
          $ref: '#/components/schemas/Annualrevenue'
        attachments:
          $ref: '#/components/schemas/Attachments'
        baddress:
          $ref: '#/components/schemas/Baddress1'
        baddress1:
          $ref: '#/components/schemas/Baddress2'
        bankData:
          $ref: '#/components/schemas/BankData'
        bcity:
          $ref: '#/components/schemas/Bcity'
        bcountry:
          $ref: '#/components/schemas/Bcountry'
        boardingLinkId:
          type: string
          description: Boarding link ID for the application. Either `templateId` or `boardingLinkId` are required.
        bstate:
          $ref: '#/components/schemas/Bstate'
        bsummary:
          $ref: '#/components/schemas/Bsummary'
        btype:
          $ref: '#/components/schemas/OwnType'
        bzip:
          $ref: '#/components/schemas/Bzip'
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationDataManagedContactsItem'
          description: List of contacts for the business.
        dbaname:
          $ref: '#/components/schemas/Dbaname'
        ein:
          $ref: '#/components/schemas/Ein'
        faxnumber:
          $ref: '#/components/schemas/BoardingBusinessFax'
        legalname:
          $ref: '#/components/schemas/Legalname'
        license:
          $ref: '#/components/schemas/License'
        licstate:
          $ref: '#/components/schemas/Licensestate'
        maddress:
          $ref: '#/components/schemas/Maddress'
        maddress1:
          $ref: '#/components/schemas/Maddress1'
        mcc:
          $ref: '#/components/schemas/Mcc'
        mcity:
          $ref: '#/components/schemas/Mcity'
        mcountry:
          $ref: '#/components/schemas/Mcountry'
        mstate:
          $ref: '#/components/schemas/Mstate'
        mzip:
          $ref: '#/components/schemas/Mzip'
        orgId:
          $ref: '#/components/schemas/Orgid'
        ownership:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationDataManagedOwnershipItem'
          description: List of Owners with at least a 25% ownership.
        phonenumber:
          $ref: '#/components/schemas/BoardingBusinessPhone'
        recipientEmail:
          description: Email address for the applicant. This is used to send the applicant a boarding link.
          $ref: '#/components/schemas/Email'
        recipientEmailNotification:
          $ref: '#/components/schemas/RecipientEmailNotification'
        resumable:
          $ref: '#/components/schemas/Resumable'
        signer:
          $ref: '#/components/schemas/SignerDataRequest'
        startdate:
          $ref: '#/components/schemas/Busstartdate'
        taxfillname:
          $ref: '#/components/schemas/Taxfillname'
        templateId:
          description: The associated boarding template's ID in Payabli. Either `templateId` or `boardingLinkId` are required.
          $ref: '#/components/schemas/TemplateId'
        website:
          $ref: '#/components/schemas/Website'
        RepCode:
          $ref: '#/components/schemas/RepCode'
        RepName:
          $ref: '#/components/schemas/RepName'
        RepOffice:
          $ref: '#/components/schemas/RepOffice'
        onCreate:
          $ref: '#/components/schemas/OnCreate'
    ApplicationDataOdpContactsItem:
      allOf:
        - $ref: '#/components/schemas/Contacts'
    ApplicationDataOdpOwnershipItem:
      allOf:
        - $ref: '#/components/schemas/Owners'
    PayoutAverageMonthlyVolume:
      type: number
      format: double
      description: |
        The total number of bills the business pays each month. For example, if
        your business pays an electric bill of $500, an internet bill of $150, and
        various suppliers $5,000 every month then your monthly bill volume would
        be $5,650.
    PayoutAverageTicketLimit:
      type: number
      format: double
      description: |
        The average amount of each bill you pay through our service. For example,
        if your business paid 3 bills for a total of $1,500 then your average
        bill size is $500.
    PayoutCreditLimit:
      type: number
      format: double
      description: |
        The maximum amount of credit that our lending partner has authorized to
        the business for on-demand payouts. It's the upper boundary on how much
        you can spend or owe on a credit account at any given time.
    PayoutHighTicketAmount:
      type: number
      format: double
      description: |
        The largest amount for a bill you will pay through our service. For
        example, if your business paid for 3 bills each month for $500, $1000,
        and $5000 respectively, then your highest ticket is $5000.
    ApplicationDataOdp:
      type: object
      required:
        - payoutAverageMonthlyVolume
        - payoutAverageTicketAmount
        - payoutCreditLimit
        - payoutHighTicketAmount
        - signer
      properties:
        services:
          $ref: '#/components/schemas/Services'
        annualRevenue:
          description: Annual revenue amount. We recommend including this value.
          $ref: '#/components/schemas/Annualrevenue'
        attachments:
          $ref: '#/components/schemas/Attachments'
        baddress:
          $ref: '#/components/schemas/Baddress1'
        baddress1:
          $ref: '#/components/schemas/Baddress2'
        bankData:
          $ref: '#/components/schemas/BankData'
        bcity:
          $ref: '#/components/schemas/Bcity'
        bcountry:
          $ref: '#/components/schemas/Bcountry'
        boardingLinkId:
          type: string
          description: Boarding link ID for the application. Either `templateId` or `boardingLinkId` are required.
        bstate:
          $ref: '#/components/schemas/Bstate'
        bsummary:
          $ref: '#/components/schemas/Bsummary'
        btype:
          $ref: '#/components/schemas/OwnType'
        bzip:
          $ref: '#/components/schemas/Bzip'
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationDataOdpContactsItem'
          description: List of contacts for the business.
        dbaname:
          $ref: '#/components/schemas/Dbaname'
        ein:
          $ref: '#/components/schemas/Ein'
        faxnumber:
          $ref: '#/components/schemas/BoardingBusinessFax'
        highticketamt:
          $ref: '#/components/schemas/Highticketamt'
        legalname:
          $ref: '#/components/schemas/Legalname'
        license:
          $ref: '#/components/schemas/License'
        licstate:
          $ref: '#/components/schemas/Licensestate'
        maddress:
          $ref: '#/components/schemas/Maddress'
        maddress1:
          $ref: '#/components/schemas/Maddress1'
        mcc:
          $ref: '#/components/schemas/Mcc'
        mcity:
          $ref: '#/components/schemas/Mcity'
        mcountry:
          $ref: '#/components/schemas/Mcountry'
        mstate:
          $ref: '#/components/schemas/Mstate'
        mzip:
          $ref: '#/components/schemas/Mzip'
        orgId:
          $ref: '#/components/schemas/Orgid'
        ownership:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationDataOdpOwnershipItem'
          description: List of Owners with at least a 25% ownership.
        payoutAverageMonthlyVolume:
          $ref: '#/components/schemas/PayoutAverageMonthlyVolume'
        payoutAverageTicketAmount:
          $ref: '#/components/schemas/PayoutAverageTicketLimit'
        payoutCreditLimit:
          $ref: '#/components/schemas/PayoutCreditLimit'
        payoutHighTicketAmount:
          $ref: '#/components/schemas/PayoutHighTicketAmount'
        phonenumber:
          $ref: '#/components/schemas/BoardingBusinessPhone'
        recipientEmail:
          description: Email address for the applicant. This is used to send the applicant a boarding link.
          $ref: '#/components/schemas/Email'
        recipientEmailNotification:
          $ref: '#/components/schemas/RecipientEmailNotification'
        resumable:
          $ref: '#/components/schemas/Resumable'
        signer:
          $ref: '#/components/schemas/SignerDataRequest'
        startdate:
          $ref: '#/components/schemas/Busstartdate'
        taxfillname:
          $ref: '#/components/schemas/Taxfillname'
        templateId:
          description: The associated boarding template's ID in Payabli. Either `templateId` or `boardingLinkId` are required.
          $ref: '#/components/schemas/TemplateId'
        website:
          $ref: '#/components/schemas/Website'
        RepCode:
          $ref: '#/components/schemas/RepCode'
        RepName:
          $ref: '#/components/schemas/RepName'
        RepOffice:
          $ref: '#/components/schemas/RepOffice'
        onCreate:
          $ref: '#/components/schemas/OnCreate'
    ApplicationData:
      type: object
      properties:
        services:
          $ref: '#/components/schemas/Services'
        annualRevenue:
          $ref: '#/components/schemas/Annualrevenue'
        attachments:
          $ref: '#/components/schemas/Attachments'
        avgmonthly:
          $ref: '#/components/schemas/Avgmonthly'
        baddress:
          $ref: '#/components/schemas/Baddress1'
        baddress1:
          $ref: '#/components/schemas/Baddress2'
        bankData:
          $ref: '#/components/schemas/BankData'
        bcity:
          $ref: '#/components/schemas/Bcity'
        bcountry:
          $ref: '#/components/schemas/Bcountry'
        binperson:
          $ref: '#/components/schemas/Binperson'
        binphone:
          $ref: '#/components/schemas/Binphone'
        binweb:
          $ref: '#/components/schemas/Binweb'
        bstate:
          $ref: '#/components/schemas/Bstate'
        bsummary:
          $ref: '#/components/schemas/Bsummary'
        btype:
          $ref: '#/components/schemas/OwnType'
        bzip:
          $ref: '#/components/schemas/Bzip'
        contacts:
          $ref: '#/components/schemas/ContactsField'
        dbaname:
          $ref: '#/components/schemas/Dbaname'
        ein:
          $ref: '#/components/schemas/Ein'
        externalPaypointId:
          $ref: '#/components/schemas/ExternalPaypointId'
        faxnumber:
          $ref: '#/components/schemas/BoardingBusinessFax'
        highticketamt:
          $ref: '#/components/schemas/Highticketamt'
        legalname:
          $ref: '#/components/schemas/Legalname'
        license:
          $ref: '#/components/schemas/License'
        licstate:
          $ref: '#/components/schemas/Licensestate'
        maddress:
          $ref: '#/components/schemas/Maddress'
        maddress1:
          $ref: '#/components/schemas/Maddress1'
        mcc:
          $ref: '#/components/schemas/Mcc'
        mcity:
          $ref: '#/components/schemas/Mcity'
        mcountry:
          $ref: '#/components/schemas/Mcountry'
        mstate:
          $ref: '#/components/schemas/Mstate'
        mzip:
          $ref: '#/components/schemas/Mzip'
        orgId:
          $ref: '#/components/schemas/Orgid'
        ownership:
          $ref: '#/components/schemas/Ownership'
        payoutAverageMonthlyVolume:
          $ref: '#/components/schemas/PayoutAverageMonthlyVolume'
        payoutAverageTicketLimit:
          $ref: '#/components/schemas/PayoutAverageTicketLimit'
        payoutCreditLimit:
          $ref: '#/components/schemas/PayoutCreditLimit'
        payoutHighTicketAmount:
          $ref: '#/components/schemas/PayoutHighTicketAmount'
        phonenumber:
          $ref: '#/components/schemas/BoardingBusinessPhone'
        recipientEmail:
          description: Email address for the applicant. This is used to send the applicant a boarding link.
          $ref: '#/components/schemas/Email'
        recipientEmailNotification:
          $ref: '#/components/schemas/RecipientEmailNotification'
        resumable:
          $ref: '#/components/schemas/Resumable'
        signer:
          $ref: '#/components/schemas/SignerDataRequest'
        startdate:
          $ref: '#/components/schemas/Busstartdate'
        taxfillname:
          $ref: '#/components/schemas/Taxfillname'
        templateId:
          $ref: '#/components/schemas/TemplateId'
        ticketamt:
          $ref: '#/components/schemas/Ticketamt'
        website:
          $ref: '#/components/schemas/Website'
        whenCharged:
          $ref: '#/components/schemas/Whencharged'
        whenDelivered:
          $ref: '#/components/schemas/Whendelivered'
        whenProvided:
          $ref: '#/components/schemas/Whenprovided'
        whenRefunded:
          $ref: '#/components/schemas/Whenrefunded'
        RepCode:
          $ref: '#/components/schemas/RepCode'
        RepName:
          $ref: '#/components/schemas/RepName'
        RepOffice:
          $ref: '#/components/schemas/RepOffice'
        onCreate:
          $ref: '#/components/schemas/OnCreate'
    AddApplicationRequest:
      oneOf:
        - title: Pay In
          description: Fields for Pay In processing applications
          $ref: '#/components/schemas/ApplicationDataPayIn'
        - title: Managed Payout
          description: Fields for Managed Payout processing applications
          $ref: '#/components/schemas/ApplicationDataManaged'
        - title: On-Demand Payout
          description: Fields for On-Demand Payout processing applications
          $ref: '#/components/schemas/ApplicationDataOdp'
        - title: All Fields
          description: All fields for boarding applications
          $ref: '#/components/schemas/ApplicationData'
    BoardingLinkId:
      type: integer
      description: |
        The boarding link ID. This is found at the end of the boarding link
        reference name. For example:
        `https://boarding.payabli.com/boarding/app/myorgaccountname-00091`. The
        ID is `91`.
    BoardingStatus:
      type: integer
      description: |
        The application's status in the merchant boarding process. See
        [Boarding Status Reference](/developers/references/boarding-statuses) for
        more.
    RequiredElement:
      type: boolean
      description: When `true`, the element is required.
    ValueTemplates:
      type: string
    LinkData:
      type: object
      properties:
        ro:
          $ref: '#/components/schemas/ReadOnly'
        rq:
          $ref: '#/components/schemas/RequiredElement'
        validator:
          type: string
          description: |
            The type of validation applied to the field. Available values:

            - `text`
            - `alpha`
            - `ein`
            - `url`
            - `phone`
            - `alphanumeric`
            - `zipcode`
            - `numbers`
            - `float`
            - `ssn`
            - `email`
            - `routing`
        value:
          $ref: '#/components/schemas/ValueTemplates'
    AchLinkTypes:
      type: object
      properties:
        ccd:
          $ref: '#/components/schemas/LinkData'
        ppd:
          $ref: '#/components/schemas/LinkData'
        web:
          $ref: '#/components/schemas/LinkData'
    LinkRow:
      type: object
      properties:
        columns:
          type: array
          items:
            $ref: '#/components/schemas/LinkData'
    BasicTable:
      type: object
      properties:
        body:
          type: array
          items:
            $ref: '#/components/schemas/LinkRow'
        header:
          $ref: '#/components/schemas/LinkRow'
    AchSection:
      type: object
      properties:
        acceptance:
          $ref: '#/components/schemas/AchLinkTypes'
        fees:
          $ref: '#/components/schemas/BasicTable'
        price:
          $ref: '#/components/schemas/BasicTable'
    CardLinkTypes:
      type: object
      properties:
        amex:
          $ref: '#/components/schemas/LinkData'
        discover:
          $ref: '#/components/schemas/LinkData'
        mastercard:
          $ref: '#/components/schemas/LinkData'
        visa:
          $ref: '#/components/schemas/LinkData'
    CardSection:
      type: object
      properties:
        acceptance:
          $ref: '#/components/schemas/CardLinkTypes'
        fees:
          $ref: '#/components/schemas/BasicTable'
        price:
          $ref: '#/components/schemas/BasicTable'
    SSection:
      type: object
      properties:
        ach:
          $ref: '#/components/schemas/AchSection'
        card:
          $ref: '#/components/schemas/CardSection'
    ASection:
      type: object
      properties:
        minimumDocuments:
          type: integer
        multipleContacts:
          type: boolean
        multipleOwners:
          type: boolean
    Bnk:
      type: object
      properties:
        accountNumber:
          $ref: '#/components/schemas/LinkData'
        bankName:
          $ref: '#/components/schemas/LinkData'
        routingAccount:
          $ref: '#/components/schemas/LinkData'
        typeAccount:
          $ref: '#/components/schemas/LinkData'
    DSection:
      type: object
      properties:
        depositAccount:
          $ref: '#/components/schemas/Bnk'
        withdrawalAccount:
          $ref: '#/components/schemas/Bnk'
    BAddress:
      type: object
      properties:
        baddress:
          $ref: '#/components/schemas/LinkData'
        baddress1:
          $ref: '#/components/schemas/LinkData'
        bcity:
          $ref: '#/components/schemas/LinkData'
        bcountry:
          $ref: '#/components/schemas/LinkData'
        bstate:
          $ref: '#/components/schemas/LinkData'
        bzip:
          $ref: '#/components/schemas/LinkData'
        maddress:
          $ref: '#/components/schemas/LinkData'
        maddress1:
          $ref: '#/components/schemas/LinkData'
        mcity:
          $ref: '#/components/schemas/LinkData'
        mcountry:
          $ref: '#/components/schemas/LinkData'
        mstate:
          $ref: '#/components/schemas/LinkData'
        mzip:
          $ref: '#/components/schemas/LinkData'
    BDetails:
      type: object
      properties:
        btype:
          $ref: '#/components/schemas/LinkData'
        dbaname:
          $ref: '#/components/schemas/LinkData'
        ein:
          $ref: '#/components/schemas/LinkData'
        faxnumber:
          $ref: '#/components/schemas/LinkData'
        legalname:
          $ref: '#/components/schemas/LinkData'
        license:
          $ref: '#/components/schemas/LinkData'
        licstate:
          $ref: '#/components/schemas/LinkData'
        phonenumber:
          $ref: '#/components/schemas/LinkData'
        startdate:
          $ref: '#/components/schemas/LinkData'
        taxfillname:
          $ref: '#/components/schemas/LinkData'
        website:
          $ref: '#/components/schemas/LinkData'
    BSection:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/BAddress'
        details:
          $ref: '#/components/schemas/BDetails'
    CList:
      type: object
      properties:
        contactEmail:
          $ref: '#/components/schemas/LinkData'
        contactName:
          $ref: '#/components/schemas/LinkData'
        contactPhone:
          $ref: '#/components/schemas/LinkData'
        contactTitle:
          $ref: '#/components/schemas/LinkData'
    OList:
      type: object
      properties:
        oaddress:
          $ref: '#/components/schemas/LinkData'
        ocity:
          $ref: '#/components/schemas/LinkData'
        ocountry:
          $ref: '#/components/schemas/LinkData'
        odriverstate:
          $ref: '#/components/schemas/LinkData'
        ostate:
          $ref: '#/components/schemas/LinkData'
        ownerdob:
          $ref: '#/components/schemas/LinkData'
        ownerdriver:
          $ref: '#/components/schemas/LinkData'
        owneremail:
          $ref: '#/components/schemas/LinkData'
        ownername:
          $ref: '#/components/schemas/LinkData'
        ownerpercent:
          $ref: '#/components/schemas/LinkData'
        ownerphone1:
          $ref: '#/components/schemas/LinkData'
        ownerphone2:
          $ref: '#/components/schemas/LinkData'
        ownerssn:
          $ref: '#/components/schemas/LinkData'
        ownertitle:
          $ref: '#/components/schemas/LinkData'
        ozip:
          $ref: '#/components/schemas/LinkData'
    OSection:
      type: object
      properties:
        contact_list:
          $ref: '#/components/schemas/CList'
        own_list:
          $ref: '#/components/schemas/OList'
    PSection:
      type: object
      properties:
        avgmonthly:
          $ref: '#/components/schemas/LinkData'
        binperson:
          $ref: '#/components/schemas/LinkData'
        binphone:
          $ref: '#/components/schemas/LinkData'
        binweb:
          $ref: '#/components/schemas/LinkData'
        bsummary:
          $ref: '#/components/schemas/LinkData'
        highticketamt:
          $ref: '#/components/schemas/LinkData'
        mcc:
          $ref: '#/components/schemas/LinkData'
        ticketamt:
          $ref: '#/components/schemas/LinkData'
        whenCharged:
          $ref: '#/components/schemas/LinkData'
        whenDelivered:
          $ref: '#/components/schemas/LinkData'
        whenProvided:
          $ref: '#/components/schemas/LinkData'
        whenRefunded:
          $ref: '#/components/schemas/LinkData'
    BuilderData:
      type: object
      properties:
        services:
          $ref: '#/components/schemas/SSection'
        attributes:
          $ref: '#/components/schemas/ASection'
        banking:
          $ref: '#/components/schemas/DSection'
        business:
          $ref: '#/components/schemas/BSection'
        owners:
          $ref: '#/components/schemas/OSection'
        processing:
          $ref: '#/components/schemas/PSection'
    BoardingApplicationAttachments:
      type: object
      properties:
        filelist:
          type: array
          items:
            $ref: '#/components/schemas/PairFiles'
          description: Array of objects describing files contained in the ZIP file.
        zipfile:
          type: string
          description: Zip file containing attachments.
    AppId:
      type: integer
      description: Boarding application ID.
    ApplicationDetailsRecordMessagesItem:
      type: object
      properties:
        content:
          type: string
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        currentApplicationStatus:
          type: integer
        currentApplicationSubStatus:
          type: integer
        id:
          type: integer
        messageType:
          type: integer
        originalApplicationStatus:
          type: integer
        originalApplicationSubStatus:
          type: integer
        roomId:
          type: integer
        userId:
          type: integer
        userName:
          type: string
    SignerData:
      type: object
      description: Information about the application's signer.
      properties:
        signerUuid:
          type: string
          description: The signer's ID. This is automatically generated by Payabli.
        name:
          $ref: '#/components/schemas/SignerName'
        ssn:
          $ref: '#/components/schemas/SignerSsn'
        dob:
          $ref: '#/components/schemas/SignerDob'
        phone:
          $ref: '#/components/schemas/SignerPhone'
        email:
          description: The signer's email address.
          $ref: '#/components/schemas/Email'
        address:
          $ref: '#/components/schemas/Signeraddress'
        address1:
          $ref: '#/components/schemas/SignerAddress1'
        city:
          $ref: '#/components/schemas/SignerCity'
        state:
          $ref: '#/components/schemas/SignerState'
        zip:
          $ref: '#/components/schemas/SignerZip'
        country:
          $ref: '#/components/schemas/SignerCountry'
        acceptance:
          $ref: '#/components/schemas/SignerAcceptance'
        signedDocumentReference:
          type: string
          description: Reference to the signed document.
        pciAttestation:
          $ref: '#/components/schemas/PciAttestation'
        attestationDate:
          $ref: '#/components/schemas/AttestationDate'
        signDate:
          $ref: '#/components/schemas/SignDate'
        additionalData:
          $ref: '#/components/schemas/AdditionalDataMap'
    ApplicationDetailsRecord:
      type: object
      properties:
        annualRevenue:
          $ref: '#/components/schemas/Annualrevenue'
        averageMonthlyVolume:
          $ref: '#/components/schemas/Avgmonthly'
        averageTicketAmount:
          $ref: '#/components/schemas/Ticketamt'
        bAddress1:
          $ref: '#/components/schemas/Baddress1'
        bAddress2:
          $ref: '#/components/schemas/Baddress2'
        bankData:
          $ref: '#/components/schemas/BankData'
        bCity:
          $ref: '#/components/schemas/Bcity'
        bCountry:
          $ref: '#/components/schemas/Bcountry'
        bFax:
          description: The business's fax number.
          $ref: '#/components/schemas/Bphone'
        binPerson:
          $ref: '#/components/schemas/Binperson'
        binPhone:
          $ref: '#/components/schemas/Binphone'
        binWeb:
          $ref: '#/components/schemas/Binweb'
        boardingLinkId:
          $ref: '#/components/schemas/BoardingLinkId'
        boardingStatus:
          $ref: '#/components/schemas/BoardingStatus'
        boardingSubStatus:
          $ref: '#/components/schemas/BoardingStatus'
        bPhone:
          $ref: '#/components/schemas/Bphone'
        bStartdate:
          $ref: '#/components/schemas/Busstartdate'
        bState:
          $ref: '#/components/schemas/Bstate'
        bSummary:
          $ref: '#/components/schemas/Bsummary'
        builderData:
          $ref: '#/components/schemas/BuilderData'
        bZip:
          $ref: '#/components/schemas/Bzip'
        contactData:
          $ref: '#/components/schemas/ContactsField'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        dbaName:
          $ref: '#/components/schemas/Dbaname'
        documentsRef:
          $ref: '#/components/schemas/BoardingApplicationAttachments'
        ein:
          $ref: '#/components/schemas/Ein'
        externalPaypointId:
          $ref: '#/components/schemas/ExternalPaypointId'
        generalEvents:
          type: array
          items:
            $ref: '#/components/schemas/GeneralEvents'
          description: Events associated with the application.
        highTicketAmount:
          $ref: '#/components/schemas/Highticketamt'
        idApplication:
          $ref: '#/components/schemas/AppId'
        lastModified:
          $ref: '#/components/schemas/LastModified'
        legalName:
          $ref: '#/components/schemas/Legalname'
        license:
          $ref: '#/components/schemas/License'
        licenseState:
          $ref: '#/components/schemas/Licensestate'
        logo:
          type: string
          description: A URL pointing to a logo file.
        mAddress1:
          $ref: '#/components/schemas/Maddress'
        mAddress2:
          $ref: '#/components/schemas/Maddress1'
        mccid:
          type: string
        mCity:
          $ref: '#/components/schemas/Mstate'
        mCountry:
          $ref: '#/components/schemas/Mcountry'
        messages:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationDetailsRecordMessagesItem'
        mState:
          $ref: '#/components/schemas/Mstate'
        mZip:
          $ref: '#/components/schemas/Mzip'
        orgId:
          $ref: '#/components/schemas/Orgid'
        orgParentName:
          $ref: '#/components/schemas/OrgParentName'
        ownerData:
          $ref: '#/components/schemas/Ownership'
        ownType:
          $ref: '#/components/schemas/OwnType'
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
        recipientEmailNotification:
          $ref: '#/components/schemas/RecipientEmailNotification'
        resumable:
          $ref: '#/components/schemas/Resumable'
        salesCode:
          $ref: '#/components/schemas/SalesCode'
        serviceData:
          $ref: '#/components/schemas/Services'
        signer:
          $ref: '#/components/schemas/SignerData'
        taxfillname:
          $ref: '#/components/schemas/Taxfillname'
        templateId:
          $ref: '#/components/schemas/TemplateId'
        websiteAddress:
          $ref: '#/components/schemas/Website'
        whencharged:
          $ref: '#/components/schemas/Whencharged'
        whendelivered:
          $ref: '#/components/schemas/Whendelivered'
        whenProvided:
          $ref: '#/components/schemas/Whenprovided'
        whenrefund:
          $ref: '#/components/schemas/Whenrefunded'
        additionalData:
          $ref: '#/components/schemas/AdditionalDataMap'
    RequestAppByAuth:
      type: object
      properties:
        email:
          description: The email address the applicant used to save the application.
          $ref: '#/components/schemas/Email'
        referenceId:
          type: string
          description: The referenceId is sent to the applicant via email when they save the application.
    ApplicationQueryRecord:
      type: object
      properties:
        annualRevenue:
          $ref: '#/components/schemas/Annualrevenue'
        averageMonthlyVolume:
          $ref: '#/components/schemas/Avgmonthly'
        averageTicketAmount:
          $ref: '#/components/schemas/Ticketamt'
        bAddress1:
          $ref: '#/components/schemas/Baddress1'
        bAddress2:
          $ref: '#/components/schemas/Baddress2'
        bankData:
          $ref: '#/components/schemas/BankData'
        bCity:
          $ref: '#/components/schemas/Bcity'
        bCountry:
          $ref: '#/components/schemas/Bcountry'
        bFax:
          description: The business's fax number.
          $ref: '#/components/schemas/Bphone'
        binPerson:
          $ref: '#/components/schemas/Binperson'
        binPhone:
          $ref: '#/components/schemas/Binphone'
        binWeb:
          $ref: '#/components/schemas/Binweb'
        boardingLinkId:
          $ref: '#/components/schemas/BoardingLinkId'
        boardingStatus:
          $ref: '#/components/schemas/BoardingStatus'
        boardingSubStatus:
          $ref: '#/components/schemas/BoardingStatus'
        bPhone:
          $ref: '#/components/schemas/Bphone'
        bStartdate:
          $ref: '#/components/schemas/Busstartdate'
        bState:
          $ref: '#/components/schemas/Bstate'
        bSummary:
          $ref: '#/components/schemas/Bsummary'
        builderData:
          $ref: '#/components/schemas/BuilderData'
        bZip:
          $ref: '#/components/schemas/Bzip'
        contactData:
          $ref: '#/components/schemas/ContactsField'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        dbaName:
          $ref: '#/components/schemas/Dbaname'
        documentsRef:
          $ref: '#/components/schemas/BoardingApplicationAttachments'
        ein:
          $ref: '#/components/schemas/Ein'
        externalPaypointId:
          $ref: '#/components/schemas/ExternalPaypointId'
        generalEvents:
          type: array
          items:
            $ref: '#/components/schemas/GeneralEvents'
          description: Events associated with the application.
        highTicketAmount:
          $ref: '#/components/schemas/Highticketamt'
        idApplication:
          $ref: '#/components/schemas/AppId'
        lastModified:
          $ref: '#/components/schemas/LastModified'
        legalName:
          $ref: '#/components/schemas/Legalname'
        license:
          $ref: '#/components/schemas/License'
        licenseState:
          $ref: '#/components/schemas/Licensestate'
        logo:
          description: Object containing logo file.
          $ref: '#/components/schemas/FileContent'
        mAddress1:
          $ref: '#/components/schemas/Maddress'
        mAddress2:
          $ref: '#/components/schemas/Maddress1'
        mccid:
          type: string
        mCity:
          $ref: '#/components/schemas/Mstate'
        mCountry:
          $ref: '#/components/schemas/Mcountry'
        mState:
          $ref: '#/components/schemas/Mstate'
        mZip:
          $ref: '#/components/schemas/Mzip'
        orgId:
          $ref: '#/components/schemas/Orgid'
        orgParentName:
          $ref: '#/components/schemas/OrgParentName'
        ownerData:
          $ref: '#/components/schemas/Ownership'
        ownType:
          $ref: '#/components/schemas/OwnType'
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
        recipientEmailNotification:
          $ref: '#/components/schemas/RecipientEmailNotification'
        resumable:
          $ref: '#/components/schemas/Resumable'
        salesCode:
          $ref: '#/components/schemas/SalesCode'
        serviceData:
          $ref: '#/components/schemas/Services'
        signer:
          $ref: '#/components/schemas/SignerData'
        taxfillname:
          $ref: '#/components/schemas/Taxfillname'
        templateId:
          $ref: '#/components/schemas/TemplateId'
        websiteAddress:
          $ref: '#/components/schemas/Website'
        whencharged:
          $ref: '#/components/schemas/Whencharged'
        whendelivered:
          $ref: '#/components/schemas/Whendelivered'
        whenProvided:
          $ref: '#/components/schemas/Whenprovided'
        whenrefund:
          $ref: '#/components/schemas/Whenrefunded'
        additionalData:
          $ref: '#/components/schemas/AdditionalDataMap'
        RepCode:
          $ref: '#/components/schemas/RepCode'
        RepName:
          $ref: '#/components/schemas/RepName'
        RepOffice:
          $ref: '#/components/schemas/RepOffice'
    AcceptOauth:
      type: boolean
    AcceptRegister:
      type: boolean
    EntryAttributes:
      type: string
    ReferenceName:
      type: string
    ReferenceTemplateId:
      type: integer
      format: int64
    BoardingLinkQueryRecord:
      type: object
      properties:
        acceptOauth:
          $ref: '#/components/schemas/AcceptOauth'
        acceptRegister:
          $ref: '#/components/schemas/AcceptRegister'
        builderData:
          $ref: '#/components/schemas/BuilderData'
        entryAttributes:
          $ref: '#/components/schemas/EntryAttributes'
        id:
          type: integer
          format: int64
        logo:
          description: Object containing logo file.
          $ref: '#/components/schemas/FileContent'
        orgId:
          $ref: '#/components/schemas/Orgid'
        'pageIdentifier:':
          $ref: '#/components/schemas/PageIdentifier'
        recipientEmailNotification:
          $ref: '#/components/schemas/RecipientEmailNotification'
        referenceName:
          $ref: '#/components/schemas/ReferenceName'
        referenceTemplateId:
          $ref: '#/components/schemas/ReferenceTemplateId'
        resumable:
          $ref: '#/components/schemas/Resumable'
    PayabliApiResponse00:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          $ref: '#/components/schemas/Responsedata'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    QueryBoardingAppsListResponse:
      type: object
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationQueryRecord'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    TemplateCode:
      type: string
      description: The internal code for the template.
    TemplateName:
      type: string
      description: The template name.
    QueryBoardingLinksResponseRecordsItem:
      type: object
      properties:
        AcceptOauth:
          $ref: '#/components/schemas/AcceptOauth'
        AcceptRegister:
          $ref: '#/components/schemas/AcceptRegister'
        EntryAttributes:
          $ref: '#/components/schemas/EntryAttributes'
        Id:
          type: integer
          description: The record ID.
        LastUpdated:
          $ref: '#/components/schemas/LastModified'
        OrgParentName:
          $ref: '#/components/schemas/OrgParentName'
        ReferenceName:
          $ref: '#/components/schemas/ReferenceName'
        ReferenceTemplateId:
          $ref: '#/components/schemas/ReferenceTemplateId'
        TemplateCode:
          $ref: '#/components/schemas/TemplateCode'
        TemplateName:
          $ref: '#/components/schemas/TemplateName'
    QueryBoardingLinksResponse:
      type: object
      description: ''
      properties:
        Records:
          type: array
          items:
            $ref: '#/components/schemas/QueryBoardingLinksResponseRecordsItem'
        Summary:
          $ref: '#/components/schemas/QuerySummary'
    CreateApplicationFromPaypointRequest:
      type: object
      description: Request to create a boarding application linked to an existing paypoint. Used for adding new services to a paypoint without creating a duplicate record.
      required:
        - paypointId
        - templateId
        - recipientEmail
      properties:
        paypointId:
          type: integer
          format: int64
          description: ID of the existing paypoint to link to this application.
        templateId:
          type: integer
          format: int64
          description: ID of the boarding template to use for the new application.
        recipientEmail:
          type: string
          description: Email address where the boarding link is sent. Required. If you don't want to email the merchant, send to an internal address and use `returnBoardingAccessInfoInLine` to retrieve the link from the response instead.
        returnBoardingAccessInfoInLine:
          type: boolean
          description: When `true`, returns the boarding access information directly in the response.
        onCreate:
          type: array
          items:
            type: string
          description: Additional actions to trigger when the application is created. Currently only `submitApplication` is supported, which automatically submits the application on creation and skips the draft state.
    CreateApplicationFromPaypointResponseData:
      type: object
      properties:
        appId:
          type: integer
          format: int64
          description: Unique identifier for the created application.
        boardingLink:
          type: string
          description: URL where the merchant can complete the boarding process.
    CreateApplicationFromPaypointResponse:
      type: object
      description: Response returned when creating a boarding application linked to an existing paypoint.
      required:
        - responseText
      properties:
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        roomId:
          $ref: '#/components/schemas/RoomIdNotInUse'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          $ref: '#/components/schemas/CreateApplicationFromPaypointResponseData'
    PayabliApiResponseTemplateId:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          description: When the operation is successful, contains the template's ID.
          $ref: '#/components/schemas/Responsedatanonobject'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    BoardingLinkApiResponse:
      type: object
      description: ''
      required:
        - responseText
      properties:
        responseData:
          type: string
          description: |-
            Reference name for boarding link (if responseText = Success) or
            List of empty fields separated by comma (if responseText = Fail)
        responseText:
          $ref: '#/components/schemas/ResponseText'
    BoardingQueryLinks:
      type: object
      properties:
        acceptOauth:
          $ref: '#/components/schemas/AcceptOauth'
        acceptRegister:
          $ref: '#/components/schemas/AcceptRegister'
        entryAttributes:
          $ref: '#/components/schemas/EntryAttributes'
        id:
          $ref: '#/components/schemas/BoardingLinkId'
        lastUpdated:
          $ref: '#/components/schemas/LastModified'
        orgParentName:
          $ref: '#/components/schemas/OrgParentName'
        referenceName:
          $ref: '#/components/schemas/ReferenceName'
        referenceTemplateId:
          $ref: '#/components/schemas/ReferenceTemplateId'
        templateCode:
          $ref: '#/components/schemas/TemplateCode'
        templateName:
          $ref: '#/components/schemas/TemplateName'
    PosCol:
      type: integer
      description: The element's column position.
    PosRow:
      type: integer
      description: The element's row position.
    Visible:
      type: boolean
      description: When `true`, makes the section visible on the application.
    TemplateElement:
      type: object
      properties:
        posCol:
          $ref: '#/components/schemas/PosCol'
        posRow:
          $ref: '#/components/schemas/PosRow'
        readOnly:
          $ref: '#/components/schemas/ReadOnly'
        value:
          $ref: '#/components/schemas/ValueTemplates'
        visible:
          $ref: '#/components/schemas/Visible'
        required:
          $ref: '#/components/schemas/RequiredElement'
    TemplateAdditionalDataField:
      type: object
      properties:
        visible:
          $ref: '#/components/schemas/Visible'
        readOnly:
          $ref: '#/components/schemas/ReadOnly'
        required:
          $ref: '#/components/schemas/RequiredElement'
        posRow:
          $ref: '#/components/schemas/PosRow'
        posCol:
          $ref: '#/components/schemas/PosCol'
        value:
          $ref: '#/components/schemas/ValueTemplates'
        label:
          type: string
        type:
          type: string
    TemplateAdditionalDataSection:
      type: object
      required:
        - fields
      properties:
        visible:
          $ref: '#/components/schemas/Visible'
        fields:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TemplateAdditionalDataField'
    BusinessSection:
      type: object
      description: Details about a business.
      properties:
        baddress:
          $ref: '#/components/schemas/TemplateElement'
        baddress1:
          $ref: '#/components/schemas/TemplateElement'
        bcity:
          $ref: '#/components/schemas/TemplateElement'
        bcountry:
          $ref: '#/components/schemas/TemplateElement'
        bstate:
          $ref: '#/components/schemas/TemplateElement'
        btype:
          $ref: '#/components/schemas/TemplateElement'
        bzip:
          $ref: '#/components/schemas/TemplateElement'
        dbaname:
          $ref: '#/components/schemas/TemplateElement'
        ein:
          $ref: '#/components/schemas/TemplateElement'
        faxnumber:
          $ref: '#/components/schemas/TemplateElement'
        legalname:
          $ref: '#/components/schemas/TemplateElement'
        license:
          $ref: '#/components/schemas/TemplateElement'
        licstate:
          $ref: '#/components/schemas/TemplateElement'
        maddress:
          $ref: '#/components/schemas/TemplateElement'
        maddress1:
          $ref: '#/components/schemas/TemplateElement'
        mcity:
          $ref: '#/components/schemas/TemplateElement'
        mcountry:
          $ref: '#/components/schemas/TemplateElement'
        mstate:
          $ref: '#/components/schemas/TemplateElement'
        mzip:
          $ref: '#/components/schemas/TemplateElement'
        phonenumber:
          $ref: '#/components/schemas/TemplateElement'
        startdate:
          $ref: '#/components/schemas/TemplateElement'
        taxfillname:
          $ref: '#/components/schemas/TemplateElement'
        visible:
          $ref: '#/components/schemas/Visible'
        website:
          $ref: '#/components/schemas/TemplateElement'
        additionalData:
          $ref: '#/components/schemas/TemplateAdditionalDataSection'
    SubFooter:
      type: string
    SubHeader:
      type: string
    BankSection:
      type: object
      description: Details about a bank account.
      properties:
        visible:
          $ref: '#/components/schemas/Visible'
        accountNumber:
          $ref: '#/components/schemas/TemplateElement'
        accountType:
          $ref: '#/components/schemas/TemplateElement'
        bankName:
          $ref: '#/components/schemas/TemplateElement'
        routingNumber:
          $ref: '#/components/schemas/TemplateElement'
    DocumentSectionTermsAndConditionsTcLinksItem:
      type: object
      properties:
        label:
          type: string
        value:
          type: string
    DocumentSectionTermsAndConditions:
      type: object
      properties:
        tcLinks:
          type: array
          items:
            $ref: '#/components/schemas/DocumentSectionTermsAndConditionsTcLinksItem'
        visible:
          $ref: '#/components/schemas/Visible'
    SignerSection:
      type: object
      properties:
        visible:
          $ref: '#/components/schemas/Visible'
        name:
          $ref: '#/components/schemas/TemplateElement'
        ssn:
          $ref: '#/components/schemas/TemplateElement'
        dob:
          $ref: '#/components/schemas/TemplateElement'
        phone:
          $ref: '#/components/schemas/TemplateElement'
        email:
          $ref: '#/components/schemas/TemplateElement'
        address:
          $ref: '#/components/schemas/TemplateElement'
        address1:
          $ref: '#/components/schemas/TemplateElement'
        city:
          $ref: '#/components/schemas/TemplateElement'
        country:
          $ref: '#/components/schemas/TemplateElement'
        state:
          $ref: '#/components/schemas/TemplateElement'
        zip:
          $ref: '#/components/schemas/TemplateElement'
        acceptance:
          $ref: '#/components/schemas/TemplateElement'
        signedDocumentReference:
          $ref: '#/components/schemas/TemplateElement'
        additionalData:
          $ref: '#/components/schemas/TemplateAdditionalDataSection'
    DocumentSection:
      type: object
      properties:
        visble:
          $ref: '#/components/schemas/Visible'
        subFooter:
          $ref: '#/components/schemas/SubFooter'
        subHeader:
          $ref: '#/components/schemas/SubHeader'
        depositBank:
          $ref: '#/components/schemas/BankSection'
        minimumDocuments:
          type: integer
          description: The minimum number of documents the applicant must upload with the application.
        uploadDocuments:
          type: boolean
          description: When `true`, allows the applicant to upload documents to the application.
        bankData:
          $ref: '#/components/schemas/BankSection'
        termsAndConditions:
          $ref: '#/components/schemas/DocumentSectionTermsAndConditions'
        signer:
          $ref: '#/components/schemas/SignerSection'
        visible:
          $ref: '#/components/schemas/Visible'
        withdrawalBank:
          $ref: '#/components/schemas/BankSection'
    OwnersSection:
      type: object
      description: Information about a business owner.
      properties:
        contactEmail:
          $ref: '#/components/schemas/TemplateElement'
        contactName:
          $ref: '#/components/schemas/TemplateElement'
        contactPhone:
          $ref: '#/components/schemas/TemplateElement'
        contactTitle:
          $ref: '#/components/schemas/TemplateElement'
        multipleContacts:
          type: boolean
          description: Offer add more contacts
        multipleOwners:
          type: boolean
          description: offer add more owners
        oaddress:
          $ref: '#/components/schemas/TemplateElement'
        ocity:
          $ref: '#/components/schemas/TemplateElement'
        ocountry:
          $ref: '#/components/schemas/TemplateElement'
        odriverstate:
          $ref: '#/components/schemas/TemplateElement'
        ostate:
          $ref: '#/components/schemas/TemplateElement'
        ownerdob:
          $ref: '#/components/schemas/TemplateElement'
        ownerdriver:
          $ref: '#/components/schemas/TemplateElement'
        owneremail:
          $ref: '#/components/schemas/TemplateElement'
        ownername:
          $ref: '#/components/schemas/TemplateElement'
        ownerpercent:
          $ref: '#/components/schemas/TemplateElement'
        ownerphone1:
          $ref: '#/components/schemas/TemplateElement'
        ownerphone2:
          $ref: '#/components/schemas/TemplateElement'
        ownerssn:
          $ref: '#/components/schemas/TemplateElement'
        ownertitle:
          $ref: '#/components/schemas/TemplateElement'
        ozip:
          $ref: '#/components/schemas/TemplateElement'
        subFooter:
          $ref: '#/components/schemas/SubFooter'
        subHeader:
          $ref: '#/components/schemas/SubHeader'
        visible:
          $ref: '#/components/schemas/Visible'
        additionalData:
          $ref: '#/components/schemas/TemplateAdditionalDataSection'
    ProcessingSection:
      type: object
      properties:
        avgmonthly:
          $ref: '#/components/schemas/TemplateElement'
        binperson:
          $ref: '#/components/schemas/TemplateElement'
        binphone:
          $ref: '#/components/schemas/TemplateElement'
        binweb:
          $ref: '#/components/schemas/TemplateElement'
        bsummary:
          $ref: '#/components/schemas/TemplateElement'
        highticketamt:
          $ref: '#/components/schemas/TemplateElement'
        mcc:
          $ref: '#/components/schemas/TemplateElement'
        subFooter:
          $ref: '#/components/schemas/SubFooter'
        subHeader:
          $ref: '#/components/schemas/SubHeader'
        ticketamt:
          $ref: '#/components/schemas/TemplateElement'
        visible:
          $ref: '#/components/schemas/Visible'
        whenCharged:
          $ref: '#/components/schemas/TemplateElement'
        whenDelivered:
          $ref: '#/components/schemas/TemplateElement'
        whenProvided:
          $ref: '#/components/schemas/TemplateElement'
        whenRefunded:
          $ref: '#/components/schemas/TemplateElement'
        CombinedBatches:
          $ref: '#/components/schemas/TemplateElement'
        payoutAverageMonthlyVolume:
          $ref: '#/components/schemas/TemplateElement'
        payoutHighTicketAmount:
          $ref: '#/components/schemas/TemplateElement'
        payoutAverageTicketAmount:
          $ref: '#/components/schemas/TemplateElement'
        payoutCreditLimit:
          $ref: '#/components/schemas/TemplateElement'
    SalesSection:
      type: object
      properties:
        salesCode:
          $ref: '#/components/schemas/SalesCode'
        salesCRM:
          type: string
    TierItem:
      type: object
      properties:
        amountxAuth:
          type: number
          format: double
        highPayRange:
          type: number
          format: double
        lowPayRange:
          type: number
          format: double
        percentxAuth:
          type: number
          format: double
    AchTypesTiers:
      type: object
      properties:
        ccd:
          $ref: '#/components/schemas/TierItem'
        ppd:
          $ref: '#/components/schemas/TierItem'
        web:
          $ref: '#/components/schemas/TierItem'
    AchAbsorbSection:
      type: object
      properties:
        multiTier:
          type: boolean
        tiers:
          type: array
          items:
            $ref: '#/components/schemas/AchTypesTiers'
        visible:
          $ref: '#/components/schemas/Visible'
    BasicTemplateElement:
      type: object
      properties:
        readOnly:
          $ref: '#/components/schemas/ReadOnly'
        required:
          $ref: '#/components/schemas/RequiredElement'
        visible:
          $ref: '#/components/schemas/Visible'
    AchTypes:
      type: object
      properties:
        ccd:
          $ref: '#/components/schemas/BasicTemplateElement'
        ppd:
          $ref: '#/components/schemas/BasicTemplateElement'
        web:
          $ref: '#/components/schemas/BasicTemplateElement'
    AchAcceptanceElement:
      type: object
      properties:
        types:
          $ref: '#/components/schemas/AchTypes'
        posCol:
          $ref: '#/components/schemas/PosCol'
        posRow:
          $ref: '#/components/schemas/PosRow'
        readOnly:
          $ref: '#/components/schemas/ReadOnly'
        value:
          $ref: '#/components/schemas/ValueTemplates'
        visible:
          $ref: '#/components/schemas/Visible'
    AchFeeSection:
      type: object
      properties:
        advancedSettlementAchFee:
          $ref: '#/components/schemas/TemplateElement'
        annualAchFee:
          $ref: '#/components/schemas/TemplateElement'
        chargebackAchFee:
          $ref: '#/components/schemas/TemplateElement'
        earlyTerminationAchFee:
          $ref: '#/components/schemas/TemplateElement'
        monthlyAchFee:
          $ref: '#/components/schemas/TemplateElement'
        quarterlyPCIAchFee:
          $ref: '#/components/schemas/TemplateElement'
        returnedAchFee:
          $ref: '#/components/schemas/TemplateElement'
        sameDayAchFee:
          $ref: '#/components/schemas/TemplateElement'
        sundayOriginationAchFee:
          $ref: '#/components/schemas/TemplateElement'
        verifyBankAchFee:
          $ref: '#/components/schemas/TemplateElement'
        verifyFundAchFee:
          $ref: '#/components/schemas/TemplateElement'
        verifyNegativeAchFee:
          $ref: '#/components/schemas/TemplateElement'
        visible:
          $ref: '#/components/schemas/Visible'
    TierItemPass:
      type: object
      properties:
        amountFeeone-time:
          type: number
          format: double
        amountFeeRecurring:
          type: number
          format: double
        highPayRange:
          type: number
          format: double
        lowPayRange:
          type: number
          format: double
        percentFeeone-time:
          type: number
          format: double
        percentFeeRecurring:
          type: number
          format: double
    AchTypesPass:
      type: object
      properties:
        ccd:
          $ref: '#/components/schemas/TierItemPass'
        ppd:
          $ref: '#/components/schemas/TierItemPass'
        web:
          $ref: '#/components/schemas/TierItemPass'
    AchPassThroughSection:
      type: object
      properties:
        multiTier:
          type: boolean
        tiers:
          type: array
          items:
            $ref: '#/components/schemas/AchTypesPass'
        visible:
          $ref: '#/components/schemas/Visible'
    AchService:
      type: object
      properties:
        achAbsorb:
          $ref: '#/components/schemas/AchAbsorbSection'
        achAbsorb_highPayRange:
          $ref: '#/components/schemas/TemplateElement'
        achAbsorb_lowPayRange:
          $ref: '#/components/schemas/TemplateElement'
        achAcceptance:
          $ref: '#/components/schemas/AchAcceptanceElement'
        achFees:
          $ref: '#/components/schemas/AchFeeSection'
        achPass_highPayRange:
          $ref: '#/components/schemas/TemplateElement'
        achPass_lowPayRange:
          $ref: '#/components/schemas/TemplateElement'
        achPassThrough:
          $ref: '#/components/schemas/AchPassThroughSection'
        batchCutoffTime:
          $ref: '#/components/schemas/TemplateElement'
          description: |
            Controls how to present the `batchCutoffTime` field on the application.
            If this field isn't sent, batch cutoff time defaults to 5 ET.
        discountFrequency:
          $ref: '#/components/schemas/TemplateElement'
        fundingRollup:
          $ref: '#/components/schemas/TemplateElement'
        gateway:
          $ref: '#/components/schemas/TemplateElement'
        pdfTemplateId:
          $ref: '#/components/schemas/TemplateElement'
        pricingPlan:
          type: integer
          format: int64
        pricingType:
          $ref: '#/components/schemas/TemplateElement'
        processor:
          $ref: '#/components/schemas/TemplateElement'
        provider:
          $ref: '#/components/schemas/TemplateElement'
        tierName:
          $ref: '#/components/schemas/TemplateElement'
        visible:
          $ref: '#/components/schemas/Visible'
    CardTypes:
      type: object
      properties:
        amex:
          $ref: '#/components/schemas/BasicTemplateElement'
        discover:
          $ref: '#/components/schemas/BasicTemplateElement'
        masterCard:
          $ref: '#/components/schemas/BasicTemplateElement'
        visa:
          $ref: '#/components/schemas/BasicTemplateElement'
    CardAcceptanceElement:
      type: object
      properties:
        types:
          $ref: '#/components/schemas/CardTypes'
        posCol:
          $ref: '#/components/schemas/PosCol'
        posRow:
          $ref: '#/components/schemas/PosRow'
        readOnly:
          $ref: '#/components/schemas/ReadOnly'
        value:
          type: string
        visible:
          $ref: '#/components/schemas/Visible'
    CardFeeSection:
      type: object
      properties:
        achBatchCardFee:
          $ref: '#/components/schemas/TemplateElement'
        annualCardFee:
          $ref: '#/components/schemas/TemplateElement'
        avsCardFee:
          $ref: '#/components/schemas/TemplateElement'
        chargebackCardFee:
          $ref: '#/components/schemas/TemplateElement'
        ddaRejectsCardFee:
          $ref: '#/components/schemas/TemplateElement'
        earlyTerminationCardFee:
          $ref: '#/components/schemas/TemplateElement'
        minimumProcessingCardFee:
          $ref: '#/components/schemas/TemplateElement'
        monthlyPCICardFee:
          $ref: '#/components/schemas/TemplateElement'
        montlyPlatformCardFee:
          $ref: '#/components/schemas/TemplateElement'
        retrievalCardFee:
          $ref: '#/components/schemas/TemplateElement'
        transactionCardFee:
          $ref: '#/components/schemas/TemplateElement'
        visible:
          $ref: '#/components/schemas/Visible'
    CardType:
      type: object
      properties:
        amex:
          $ref: '#/components/schemas/TierItem'
        discover:
          $ref: '#/components/schemas/TierItem'
        masterCard:
          $ref: '#/components/schemas/TierItem'
        visa:
          $ref: '#/components/schemas/TierItem'
    CardFlatSection:
      type: object
      properties:
        tiers:
          type: array
          items:
            $ref: '#/components/schemas/CardType'
        visible:
          $ref: '#/components/schemas/Visible'
    CardIcpSection:
      type: object
      properties:
        tiers:
          type: array
          items:
            $ref: '#/components/schemas/CardType'
        visible:
          $ref: '#/components/schemas/Visible'
    CardTypePass:
      type: object
      properties:
        amex:
          $ref: '#/components/schemas/TierItemPass'
        discover:
          $ref: '#/components/schemas/TierItemPass'
        masterCard:
          $ref: '#/components/schemas/TierItemPass'
        visa:
          $ref: '#/components/schemas/TierItemPass'
    CardPassThroughSection:
      type: object
      properties:
        multiTier:
          type: boolean
        tiers:
          type: array
          items:
            $ref: '#/components/schemas/CardTypePass'
        visible:
          $ref: '#/components/schemas/Visible'
    CardService:
      type: object
      properties:
        batchCutoffTime:
          description: Controls how to present the `batchCutoffTime` field on the application. If this field isn't sent, batch cutoff time defaults to 5 ET.
          $ref: '#/components/schemas/TemplateElement'
        cardAcceptance:
          $ref: '#/components/schemas/CardAcceptanceElement'
        cardFees:
          $ref: '#/components/schemas/CardFeeSection'
        cardFlat:
          $ref: '#/components/schemas/CardFlatSection'
        cardFlat_amountxAuth:
          $ref: '#/components/schemas/TemplateElement'
        cardFlat_highPayRange:
          $ref: '#/components/schemas/TemplateElement'
        cardFlat_lowPayRange:
          $ref: '#/components/schemas/TemplateElement'
        cardFlat_percentxAuth:
          $ref: '#/components/schemas/TemplateElement'
        cardICP:
          $ref: '#/components/schemas/CardIcpSection'
        cardICP_amountxAuth:
          $ref: '#/components/schemas/TemplateElement'
        cardICP_highPayRange:
          $ref: '#/components/schemas/TemplateElement'
        cardICP_lowPayRange:
          $ref: '#/components/schemas/TemplateElement'
        cardICP_percentxAuth:
          $ref: '#/components/schemas/TemplateElement'
        cardPassThrough:
          $ref: '#/components/schemas/CardPassThroughSection'
        cardPassThrough_amountRecurring:
          $ref: '#/components/schemas/TemplateElement'
        cardPassThrough_amountxAuth:
          $ref: '#/components/schemas/TemplateElement'
        cardPassThrough_highPayRange:
          $ref: '#/components/schemas/TemplateElement'
        cardPassThrough_lowPayRange:
          $ref: '#/components/schemas/TemplateElement'
        cardPassThrough_percentRecurring:
          $ref: '#/components/schemas/TemplateElement'
        cardPassThrough_percentxAuth:
          $ref: '#/components/schemas/TemplateElement'
        discountFrequency:
          $ref: '#/components/schemas/TemplateElement'
        fundingRollup:
          $ref: '#/components/schemas/TemplateElement'
        gateway:
          $ref: '#/components/schemas/TemplateElement'
        passThroughCost:
          $ref: '#/components/schemas/TemplateElement'
        pdfTemplateId:
          $ref: '#/components/schemas/TemplateElement'
        pricingPlan:
          type: integer
          format: int64
        pricingType:
          $ref: '#/components/schemas/TemplateElement'
        processor:
          $ref: '#/components/schemas/TemplateElement'
        provider:
          $ref: '#/components/schemas/TemplateElement'
        tierName:
          $ref: '#/components/schemas/TemplateElement'
        visible:
          $ref: '#/components/schemas/Visible'
    ServicesSection:
      type: object
      description: Details about pricing and payment services for a business.
      properties:
        ach:
          $ref: '#/components/schemas/AchService'
        card:
          $ref: '#/components/schemas/CardService'
        subFooter:
          $ref: '#/components/schemas/SubFooter'
        subHeader:
          $ref: '#/components/schemas/SubHeader'
        visible:
          $ref: '#/components/schemas/Visible'
    UnderWritingMethod:
      type: string
      description: |
        This field controls which method is used to handle risk orchestration.

        - `automatic`: Sends the application through the automatic
          underwriting workflow using the provided `policyId`.
        - `manual`: Puts the application into the pending review status. An
          analyst must manually change its final status to approved or
          declined.
        - `bypass`: The application won't go through Payabli's review, and
          proceeds directly to boarding products and services.
      enum:
        - automatic
        - manual
        - bypass
    PolicyId:
      type: string
      description: |
        Used to identify the risk workflow used to review this account. Policy
        IDs must be created before using automatic underwriting, and is
        **required** when `method` is `automatic`.
    UnderwritingDataResponse:
      type: object
      description: Underwriting data is used to manage risk orchestration in the boarding application lifecycle.
      properties:
        method:
          $ref: '#/components/schemas/UnderWritingMethod'
        policyId:
          $ref: '#/components/schemas/PolicyId'
    TemplateContentResponse:
      type: object
      properties:
        businessData:
          $ref: '#/components/schemas/BusinessSection'
        documentsData:
          $ref: '#/components/schemas/DocumentSection'
        ownershipData:
          $ref: '#/components/schemas/OwnersSection'
        processingData:
          $ref: '#/components/schemas/ProcessingSection'
        salesData:
          $ref: '#/components/schemas/SalesSection'
        servicesData:
          $ref: '#/components/schemas/ServicesSection'
        underwritingData:
          $ref: '#/components/schemas/UnderwritingDataResponse'
    TemplateQueryRecord:
      type: object
      properties:
        addPrice:
          type: boolean
        boardingLinks:
          type: array
          items:
            $ref: '#/components/schemas/BoardingQueryLinks'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        idTemplate:
          type: integer
          format: int64
        isRoot:
          $ref: '#/components/schemas/IsRoot'
        orgParentName:
          $ref: '#/components/schemas/OrgParentName'
        recipientEmailNotification:
          $ref: '#/components/schemas/RecipientEmailNotification'
        resumable:
          $ref: '#/components/schemas/Resumable'
        templateCode:
          $ref: '#/components/schemas/TemplateCode'
        templateContent:
          $ref: '#/components/schemas/TemplateContentResponse'
        templateDescription:
          type: string
        templateTitle:
          type: string
        usedBy:
          type: integer
    TemplateQueryResponse:
      type: object
      properties:
        records:
          type: array
          items:
            $ref: '#/components/schemas/TemplateQueryRecord'
        summary:
          $ref: '#/components/schemas/QuerySummary'
    ExportFormat1:
      type: string
      enum:
        - csv
        - xlsx
    ServiceCost:
      type: object
      properties:
        description:
          type: string
        enabled:
          $ref: '#/components/schemas/Enabled'
        monthlyCost:
          type: number
          format: double
        name:
          type: string
        reseller:
          type: boolean
        setupCost:
          type: number
          format: double
        txCost:
          type: number
          format: double
        txPercentCost:
          type: number
          format: double
    AddOrganizationRequest:
      type: object
      required:
        - orgName
        - orgType
        - replyToEmail
      properties:
        services:
          type: array
          items:
            $ref: '#/components/schemas/ServiceCost'
        billingInfo:
          $ref: '#/components/schemas/Instrument'
        contacts:
          $ref: '#/components/schemas/ContactsField'
        hasBilling:
          type: boolean
        hasResidual:
          type: boolean
        orgAddress:
          $ref: '#/components/schemas/Orgaddress'
        orgCity:
          $ref: '#/components/schemas/Orgcity'
        orgCountry:
          $ref: '#/components/schemas/Orgcountry'
        orgEntryName:
          $ref: '#/components/schemas/Orgentryname'
        orgId:
          $ref: '#/components/schemas/Orgidstring'
        orgLogo:
          $ref: '#/components/schemas/FileContent'
        orgName:
          $ref: '#/components/schemas/Orgname'
        orgParentId:
          $ref: '#/components/schemas/OrgParentId'
        orgState:
          $ref: '#/components/schemas/Orgstate'
        orgTimezone:
          $ref: '#/components/schemas/Orgtimezone'
        orgType:
          $ref: '#/components/schemas/Orgtype'
        orgWebsite:
          $ref: '#/components/schemas/Orgwebsite'
        orgZip:
          $ref: '#/components/schemas/Orgzip'
        replyToEmail:
          $ref: '#/components/schemas/ReplyToEmail'
    AddOrganizationResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          description: Returns the organization ID.
          $ref: '#/components/schemas/Responsedatanonobject'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    OrganizationData:
      type: object
      properties:
        services:
          type: array
          items:
            $ref: '#/components/schemas/ServiceCost'
        billingInfo:
          $ref: '#/components/schemas/Instrument'
        contacts:
          $ref: '#/components/schemas/ContactsField'
        hasBilling:
          type: boolean
        hasResidual:
          type: boolean
        orgAddress:
          $ref: '#/components/schemas/Orgaddress'
        orgCity:
          $ref: '#/components/schemas/Orgcity'
        orgCountry:
          $ref: '#/components/schemas/Orgcountry'
        orgEntryName:
          $ref: '#/components/schemas/Orgentryname'
        orgId:
          $ref: '#/components/schemas/Orgidstring'
        orgLogo:
          $ref: '#/components/schemas/FileContent'
        orgName:
          $ref: '#/components/schemas/Orgname'
        orgParentId:
          $ref: '#/components/schemas/OrgParentId'
        orgState:
          $ref: '#/components/schemas/Orgstate'
        orgTimezone:
          $ref: '#/components/schemas/Orgtimezone'
        orgType:
          $ref: '#/components/schemas/Orgtype'
        orgWebsite:
          $ref: '#/components/schemas/Orgwebsite'
        orgZip:
          $ref: '#/components/schemas/Orgzip'
        replyToEmail:
          $ref: '#/components/schemas/ReplyToEmail'
    EditOrganizationResponse:
      type: object
      required:
        - responseCode
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          description: Returns the organization ID.
          $ref: '#/components/schemas/Responsedatanonobject'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    DeleteOrganizationResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          description: Returns the organization ID.
          $ref: '#/components/schemas/Responsedatanonobject'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    VerifyAccountDetailsRequest:
      type: object
      required:
        - routingNumber
        - accountNumber
      properties:
        routingNumber:
          type: string
          description: The bank routing number to verify.
        accountNumber:
          type: string
          description: The bank account number to verify.
        accountType:
          type: string
          description: The type of bank account, such as `Checking` or `Savings`.
        country:
          type: string
          description: The ISO country code for the bank account, such as `US`.
        accountHolderType:
          type: string
          description: The type of account holder. Accepted values are `personal` or `business`. Required when bank authentication is enabled for the paypoint's organization.
        holderName:
          type: string
          description: The name of the bank account holder. For personal accounts, provide the holder's full name (for example, `Jane Doe`); the value is split on the first space into first and last name. For business accounts, provide the legal business name. Required when bank authentication is enabled for the paypoint's organization.
    BankAccountVerificationDetailsResponse:
      type: object
      description: Detailed bank account verification results from the verification network.
      required:
        - isValid
        - errorMessage
        - bankName
        - reportedAccountType
        - accountAddedDate
        - accountLastUpdatedDate
        - accountClosedDate
      properties:
        aba:
          type: string
          description: The ABA routing number that was verified.
        accountNumber:
          type: string
          description: The account number that was verified.
        isValid:
          type: boolean
          description: Whether the bank account passed verification.
        errorMessage:
          type:
            - string
            - 'null'
          description: Error message if the verification request failed.
        verificationResponse:
          type: string
          description: Overall verification outcome. Possible values include `Pass`, `Verified`, `Declined`, `NoData`, `Bypassed`, and `Error`.
        responseCode:
          type: string
          description: Response code returned by the verification network.
        responseValue:
          type: string
          description: Response value associated with the verification outcome.
        responseDescription:
          type: string
          description: Human-readable description of the verification outcome.
        bankName:
          type:
            - string
            - 'null'
          description: Name of the bank associated with the routing number.
        reportedAccountType:
          type:
            - string
            - 'null'
          description: Account type as reported by the verification network, such as `Checking` or `Savings`.
        accountAddedDate:
          type:
            - string
            - 'null'
          description: Date the account was first seen by the verification network (ISO 8601 format).
        accountLastUpdatedDate:
          type:
            - string
            - 'null'
          description: Date the account record was last updated in the verification network (ISO 8601 format).
        accountClosedDate:
          type:
            - string
            - 'null'
          description: Date the account was closed, if applicable (ISO 8601 format).
    VerifyAccountDetailsResponse:
      type: object
      description: Response wrapper for the bank account verification details endpoint.
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          $ref: '#/components/schemas/BankAccountVerificationDetailsResponse'
    StatBasicExtendedQueryRecord:
      type: object
      required:
        - statX
        - outCustomers
        - outNewCustomers
        - outTransactions
        - outSubscriptionsPaid
        - outCardTransactions
        - outVCardTransactions
        - outACHTransactions
        - outCheckTransactions
        - outPendingMethodTransactions
        - outTransactionsVolume
        - outSubscriptionsPaidVolume
        - outCardVolume
        - outVCardVolume
        - outACHVolume
        - outCheckVolume
        - outPendingMethodVolume
        - inTransactions
        - inSubscriptionsPaid
        - inCustomers
        - inNewCustomers
        - inCardTransactions
        - inACHTransactions
        - inCheckTransactions
        - inCashTransactions
        - inWalletTransactions
        - inCardChargeBacks
        - inACHReturns
        - inTransactionsVolume
        - inSubscriptionsPaidVolume
        - inCardVolume
        - inACHVolume
        - inCheckVolume
        - inCashVolume
        - inWalletVolume
        - inCardChargeBackVolume
        - inACHReturnsVolume
      properties:
        statX:
          type: string
          description: The time window based on the mode and frequency used for the query.
        outCustomers:
          type: integer
          description: Number of active vendors.
        outNewCustomers:
          type: integer
          description: Number of new vendors.
        outTransactions:
          type: integer
          description: Outbound (payout) transactions count.
        outSubscriptionsPaid:
          type: integer
          description: Recurring outbound (payout) transactions count.
        outCardTransactions:
          type: integer
          description: Outbound (payout) pCard transactions count.
        outVCardTransactions:
          type: integer
          description: Outbound (payout) vCard transactions count.
        outACHTransactions:
          type: integer
          description: Outbound (payout) ACH transactions count.
        outCheckTransactions:
          type: integer
          description: Outbound (payout) check transactions count.
        outPendingMethodTransactions:
          type: integer
          description: Outbound (payout) Managed Payables transactions count.
        outTransactionsVolume:
          type: number
          format: double
          description: Outbound (payout) volume.
        outSubscriptionsPaidVolume:
          type: number
          format: double
          description: Recurring outbound (payout) volume.
        outCardVolume:
          type: number
          format: double
          description: Outbound (payout) pCard transactions volume.
        outVCardVolume:
          type: number
          format: double
          description: Outbound (payout) vCard transactions volume.
        outACHVolume:
          type: number
          format: double
          description: Outbound (payout) ACH transactions volume.
        outCheckVolume:
          type: number
          format: double
          description: Outbound (payout) check transactions volume.
        outPendingMethodVolume:
          type: number
          format: double
          description: Outbound (payout) Managed Payables volume.
        inTransactions:
          type: integer
          description: Inbound transactions count.
        inSubscriptionsPaid:
          type: integer
          description: Inbound recurring transactions count.
        inCustomers:
          type: integer
          description: Number of active customers.
        inNewCustomers:
          type: integer
          description: Number of new customers.
        inCardTransactions:
          type: integer
          description: Inbound card transactions count.
        inACHTransactions:
          type: integer
          description: Inbound ACH transactions count.
        inCheckTransactions:
          type: integer
          description: Inbound check transactions count.
        inCashTransactions:
          type: integer
          description: Inbound cash transactions count.
        inWalletTransactions:
          type: integer
          description: Inbound wallet transactions count.
        inCardChargeBacks:
          type: integer
          description: Inbound card chargebacks and returns count.
        inACHReturns:
          type: integer
          description: Inbound ACH returns count.
        inTransactionsVolume:
          type: number
          format: double
          description: Inbound volume.
        inSubscriptionsPaidVolume:
          type: number
          format: double
          description: Inbound recurring payments volume.
        inCardVolume:
          type: number
          format: double
          description: Inbound card volume.
        inACHVolume:
          type: number
          format: double
          description: Inbound ACH volume.
        inCheckVolume:
          type: number
          format: double
          description: Inbound check volume.
        inCashVolume:
          type: number
          format: double
          description: Inbound cash volume recognized.
        inWalletVolume:
          type: number
          format: double
          description: Inbound wallet transactions volume.
        inCardChargeBackVolume:
          type: number
          format: double
          description: Inbound Card chargebacks and returns volume.
        inACHReturnsVolume:
          type: number
          format: double
          description: Inbound ACH returns volume.
    SubscriptionStatsQueryRecord:
      type: object
      required:
        - interval
        - count
        - volume
      properties:
        interval:
          type: string
          description: Time interval identifier
        count:
          type: integer
          description: Number of subscriptions
        volume:
          type: number
          format: double
          description: Subscription volume
    StatBasicQueryRecord:
      type: object
      required:
        - statX
        - inTransactions
        - inTransactionsVolume
        - inWalletTransactions
        - inWalletVolume
      properties:
        statX:
          type: string
          description: Statistical grouping identifier
        inTransactions:
          type: integer
          description: Number of incoming transactions
        inTransactionsVolume:
          type: number
          format: double
          description: Volume of incoming transactions
        inWalletTransactions:
          type: integer
          description: Number of incoming wallet transactions
        inWalletVolume:
          type: number
          format: double
          description: Volume of incoming wallet transactions
    StatisticsVendorQueryRecord:
      type: object
      required:
        - statX
        - active
        - activeVolume
        - sentToApproval
        - sentToApprovalVolume
        - toApproval
        - toApprovalVolume
        - approved
        - approvedVolume
        - disapproved
        - disapprovedVolume
        - cancelled
        - cancelledVolume
        - inTransit
        - inTransitVolume
        - paid
        - paidVolume
      properties:
        statX:
          type: string
          description: Statistical grouping identifier
        active:
          type: integer
          description: Number of active transactions
        activeVolume:
          type: number
          format: double
          description: Volume of active transactions
        sentToApproval:
          type: integer
          description: Number of transactions sent to approval
        sentToApprovalVolume:
          type: number
          format: double
          description: Volume of transactions sent to approval
        toApproval:
          type: integer
          description: Number of transactions to approval
        toApprovalVolume:
          type: number
          format: double
          description: Volume of transactions to approval
        approved:
          type: integer
          description: Number of approved transactions
        approvedVolume:
          type: number
          format: double
          description: Volume of approved transactions
        disapproved:
          type: integer
          description: Number of disapproved transactions
        disapprovedVolume:
          type: number
          format: double
          description: Volume of disapproved transactions
        cancelled:
          type: integer
          description: Number of cancelled transactions
        cancelledVolume:
          type: number
          format: double
          description: Volume of cancelled transactions
        inTransit:
          type: integer
          description: Number of transactions in transit
        inTransitVolume:
          type: number
          format: double
          description: Volume of transactions in transit
        paid:
          type: integer
          description: Number of paid transactions
        paidVolume:
          type: number
          format: double
          description: Volume of paid transactions
    NotificationStandardRequestContentEventType:
      type: string
      description: The notification's event name.
      enum:
        - payin_transaction_rejected
        - payin_transaction_onhold
        - payin_transaction_released
        - payin_transaction_recovered
        - payout_transaction_initiated
        - payout_transaction_authorized
        - payout_transaction_approvedcaptured
        - payout_transaction_declined
        - payout_transaction_technicaldecline
        - payout_transaction_failed
        - payout_transaction_error
        - payout_transaction_paid
        - payout_transaction_returned
        - payout_transaction_rejected
        - payout_transaction_voidedcancelled
        - payout_transaction_processing
        - payout_transaction_processed
        - payout_transaction_onhold
        - payout_transaction_released
        - payout_transaction_recovered
        - payin_batch_onhold
        - payin_batch_released
        - payout_batch_open
        - payout_batch_onhold
        - payout_batch_released
        - payout_batch_processed
        - payout_batch_paid
        - payout_batch_funded
        - payout_batch_closed
        - payout_batch_notclosed
        - payout_batch_fundpending
        - payout_batch_cancelled
        - payout_batch_transferred
        - payout_batch_resolved
        - payout_batch_settlement_pending
        - payout_batch_settlement_intransit
        - payout_batch_settlement_transferred
        - payout_batch_settlement_funded
        - payout_batch_settlement_resolved
        - payout_batch_settlement_exception
        - payout_batch_settlement_achreturn
        - payout_batch_settlement_held
        - payout_batch_settlement_released
        - ApprovedPayment
        - AuthorizedPayment
        - DeclinedPayment
        - OriginatedPayment
        - SettledPayment
        - SubscriptionCreated
        - SubscriptionUpdated
        - SubscriptionCanceled
        - SubscriptionCompleted
        - FundedPayment
        - VoidedPayment
        - RefundedPayment
        - HoldTransaction
        - ReleasedTransaction
        - HoldBatch
        - ReleasedBatch
        - TransferAdjusted
        - TransferDisabledCreditFund
        - TransferDisabledDebitFund
        - TransferNotAvailableBalance
        - TransferReadyforRetry
        - TransferResolved
        - TransferReturn
        - TransferSuccess
        - TransferSuspended
        - TransferError
        - SendReceipt
        - RecoveredTransaction
        - CreatedApplication
        - ApprovedApplication
        - FailedBoardingApplication
        - SubmittedApplication
        - ActivatedMerchant
        - ReceivedChargeBack
        - ChargebackUpdated
        - ReceivedRetrieval
        - RetrievalUpdated
        - ReceivedAchReturn
        - HoldingApplication
        - DeclinedApplication
        - BoardingApplication
        - PaypointMoved
        - FraudAlert
        - InvoiceSent
        - InvoicePaid
        - InvoiceCreated
        - BillPaid
        - BillApproved
        - BillDisApproved
        - BillCanceled
        - BillProcessing
        - CardCreated
        - CardActivated
        - CardDeactivated
        - CardExpired
        - CardExpiring
        - CardLimitUpdated
        - BatchClosed
        - BatchNotClosed
        - PayOutFunded
        - PayOutProcessed
        - PayOutCanceled
        - PayOutPaid
        - PayOutReturned
        - PayoutSubscriptionCreated
        - PayoutSubscriptionUpdated
        - PayoutSubscriptionCanceled
        - PayoutSubscriptionCompleted
        - PayoutSubscriptionReminder
        - importFileReceived
        - importFileProcessed
        - importFileError
        - exportFileSent
        - exportFileError
        - UpdatedMerchant
        - Report
        - FailedEmailNotification
        - FailedWebNotification
        - FailedSMSNotification
        - UserPasswordExpiring
        - UserPasswordExpired
        - TransactionNotFound
        - SystemAlert
    NotificationStandardRequestContent:
      type: object
      properties:
        eventType:
          description: The notification's event name.
          $ref: '#/components/schemas/NotificationStandardRequestContentEventType'
        internalData:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueDuo'
          description: Array of pairs key:value to insert in request body to target in **method** = *web*.
        transactionId:
          type: string
          description: Used internally to reference the entity or object generating the event.
          default: '0'
        webHeaderParameters:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueDuo'
          description: Array of pairs key:value to insert in header of request to target in **method** = *web*.
    NotificationStandardRequestFrequency:
      type: string
      enum:
        - one-time
        - untilcancelled
      x-fern-enum:
        one-time:
          name: OneTime
    NotificationStandardRequestMethod:
      type: string
      description: |
        Get near-instant notifications via email, SMS, or webhooks for important
        events like new payment disputes, merchant activations, fraud alerts,
        approved transactions, settlement history, vendor payouts, and more. Use
        webhooks with notifications to get real-time updates and automate
        operations based on those key events. See
        [Notifications](/developers/developer-guides/notifications-and-webhooks-overview#notifications)
        for more.
      enum:
        - email
        - sms
        - web
    NotificationStandardRequest:
      type: object
      description: Information about the standard notification configuration (email, SMS, web).
      required:
        - frequency
        - method
        - ownerType
        - target
      properties:
        content:
          $ref: '#/components/schemas/NotificationStandardRequestContent'
        frequency:
          $ref: '#/components/schemas/NotificationStandardRequestFrequency'
        method:
          description: Get near-instant notifications via email, SMS, or webhooks for important events like new payment disputes, merchant activations, fraud alerts, approved transactions, settlement history, vendor payouts, and more. Use webhooks with notifications to get real-time updates and automate operations based on those key events. See [Notifications](/developers/developer-guides/notifications-and-webhooks-overview#notifications) for more.
          $ref: '#/components/schemas/NotificationStandardRequestMethod'
        ownerId:
          $ref: '#/components/schemas/Ownerid'
        ownerType:
          $ref: '#/components/schemas/Ownertype'
        status:
          $ref: '#/components/schemas/Statusnotification'
        target:
          type: string
          description: |-
            Specify the notification target.
            - For method=email the expected value is a list of email addresses separated by semicolon.
            - For method=sms the expected value is a list of phone numbers separated by semicolon.
            - For method=web the expected value is a valid and complete URL. Webhooks support only standard HTTP ports: 80, 443, 8080, or 4443.
    NotificationReportRequestContentFileFormat:
      type: string
      description: |
        Indicate the format of report file to be generated by the engine.
      enum:
        - json
        - csv
        - xlsx
    NotificationReportRequestContentReportName:
      type: string
      description: The kind of report to generate.
      enum:
        - Transaction
        - Settlement
        - Boarding
        - Returned
    NotificationReportRequestContent:
      type: object
      properties:
        eventType:
          type: string
          const: Report
          description: The notification's event name.
        fileFormat:
          description: Indicate the format of report file to be generated by the engine.
          $ref: '#/components/schemas/NotificationReportRequestContentFileFormat'
        internalData:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueDuo'
          description: Array of pairs key:value to insert in request body to target in **method** = *report-web*.
        reportName:
          description: The kind of report to generate.
          $ref: '#/components/schemas/NotificationReportRequestContentReportName'
        timeZone:
          $ref: '#/components/schemas/Timezone'
        transactionId:
          type: string
          description: Used internally to reference the entity or object generating the event.
          default: '0'
        webHeaderParameters:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueDuo'
          description: Array of pairs key:value to insert in header of request to target in **method** = *report-web*.
    NotificationReportRequestFrequency:
      type: string
      enum:
        - one-time
        - daily
        - weekly
        - biweekly
        - monthly
        - quarterly
        - semiannually
        - annually
      x-fern-enum:
        one-time:
          name: OneTime
    NotificationReportRequestMethod:
      type: string
      description: |
        Automated reporting lets you gather critical reports without manually
        filtering and exporting the data. Get automated daily, weekly, and
        monthly reports for daily sales, ACH returns, settlements, and more. You
        can send these reports via email or via webhook. See
        [Automated Reports](/developers/developer-guides/notifications-and-webhooks-overview#automated-reports)
        for more.
      enum:
        - report-email
        - report-web
      x-fern-enum:
        report-email:
          name: ReportEmail
        report-web:
          name: ReportWeb
    NotificationReportRequest:
      type: object
      description: Information about the report notification configuration (report-email, report-web).
      required:
        - content
        - frequency
        - method
        - ownerType
        - target
      properties:
        content:
          $ref: '#/components/schemas/NotificationReportRequestContent'
        frequency:
          $ref: '#/components/schemas/NotificationReportRequestFrequency'
        method:
          description: Automated reporting lets you gather critical reports without manually filtering and exporting the data. Get automated daily, weekly, and monthly reports for daily sales, ACH returns, settlements, and more. You can send these reports via email or via webhook. See [Automated Reports](/developers/developer-guides/notifications-and-webhooks-overview#automated-reports) for more.
          $ref: '#/components/schemas/NotificationReportRequestMethod'
        ownerId:
          $ref: '#/components/schemas/Ownerid'
        ownerType:
          $ref: '#/components/schemas/Ownertype'
        status:
          $ref: '#/components/schemas/Statusnotification'
        target:
          type: string
          description: |-
            Specify the notification target.
            For method=report-email the expected value is a list of email addresses separated by semicolon.
            For method=report-web the expected value is a valid and complete URL. Webhooks support only standard HTTP ports: 80, 443, 8080, or 4443.
    AddNotificationRequest:
      oneOf:
        - title: Notification
          description: Create a standard webhook, email, or SMS notification.
          $ref: '#/components/schemas/NotificationStandardRequest'
        - title: Report
          description: Create an auto-generated report.
          $ref: '#/components/schemas/NotificationReportRequest'
    PayabliApiResponseNotificationsResponseData:
      description: |
        When the request was successful, this contains the notification ID, or
        `nID` used to manage the notification.
      oneOf:
        - type: integer
        - type: string
    PayabliApiResponseNotifications:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          description: |-
            If `isSuccess` = true, `responseData` contains the notification identifier.
            If `isSuccess` = false, `responseData` contains the reason for the error.
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          description: When the request was successful, this contains the notification ID, or `nID` used to manage the notification.
          $ref: '#/components/schemas/PayabliApiResponseNotificationsResponseData'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    NotificationQueryRecord:
      type: object
      properties:
        content:
          description: Notification content.
          $ref: '#/components/schemas/NotificationContent'
        createdAt:
          description: Timestamp of when notification was created.
          $ref: '#/components/schemas/CreatedAt'
        frequency:
          $ref: '#/components/schemas/Frequencynotification'
        lastUpdated:
          description: Timestamp of when notification was last updated.
          $ref: '#/components/schemas/LastModified'
        method:
          $ref: '#/components/schemas/Methodnotification'
        notificationId:
          $ref: '#/components/schemas/NotificationId'
        ownerId:
          $ref: '#/components/schemas/Ownerid'
        ownerName:
          type: string
          description: Name of entity owner of notification.
        ownerType:
          $ref: '#/components/schemas/Ownertype'
        source:
          description: Custom descriptor of source of notification.
          $ref: '#/components/schemas/Source'
        status:
          $ref: '#/components/schemas/Statusnotification'
        target:
          $ref: '#/components/schemas/Target'
    UpdateNotificationRequest:
      oneOf:
        - $ref: '#/components/schemas/NotificationStandardRequest'
        - $ref: '#/components/schemas/NotificationReportRequest'
    MfaData:
      type: object
      properties:
        mfa:
          type: boolean
        mfaMode:
          $ref: '#/components/schemas/MfaMode'
    OrgScope:
      type: object
      properties:
        orgId:
          $ref: '#/components/schemas/Orgid'
        orgType:
          $ref: '#/components/schemas/Orgtype'
    UserData:
      type: object
      properties:
        access:
          type: array
          items:
            $ref: '#/components/schemas/UsrAccess'
        additionalData:
          $ref: '#/components/schemas/AdditionalData'
        email:
          description: The user's email address.
          $ref: '#/components/schemas/Email'
        language:
          $ref: '#/components/schemas/Language'
        mfaData:
          $ref: '#/components/schemas/MfaData'
        name:
          $ref: '#/components/schemas/NameUser'
        phone:
          description: The user's phone number.
          $ref: '#/components/schemas/PhoneNumber'
        pwd:
          type: string
        scope:
          type: array
          items:
            $ref: '#/components/schemas/OrgScope'
        timeZone:
          $ref: '#/components/schemas/Timezone'
        usrStatus:
          $ref: '#/components/schemas/UsrStatus'
    AddUserResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          type: string
          description: The response data.
        responseText:
          $ref: '#/components/schemas/ResponseText'
    DeleteUserResponse:
      type: object
      required:
        - responseText
      properties:
        responseText:
          $ref: '#/components/schemas/ResponseText'
    UserAuthRequest:
      type: object
      properties:
        email:
          $ref: '#/components/schemas/Email'
        entry:
          type: string
          description: Identifier for entry point originating the request (used by front-end apps)
        entryType:
          type: integer
          description: 'Type of entry identifier: 0 - partner, 2 - paypoint. This is used by front-end apps, required if an Entry is indicated.'
        psw:
          type: string
        userId:
          type: integer
          format: int64
        userTokenId:
          type: string
    MfaValidationCode:
      type: string
      description: |
        The validation code for multi-factor authentication, typically a hash or
        similar encrypted format.
    PayabliApiResponseMfaBasic:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        mfa:
          $ref: '#/components/schemas/Mfa'
        mfaMode:
          type: string
          description: The mode of multi-factor authentication used.
        mfaValidationCode:
          $ref: '#/components/schemas/MfaValidationCode'
        responseData:
          type: string
          description: Data returned by the response, masked for security.
        responseText:
          $ref: '#/components/schemas/ResponseText'
    PayabliApiResponseUserMfa:
      type: object
      required:
        - responseText
      properties:
        inactiveTokenTime:
          type: integer
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        remaining:
          type: integer
        responseData:
          $ref: '#/components/schemas/Responsedatanonobject'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    UserAuthResetRequest:
      type: object
      properties:
        email:
          description: The user's email address.
          $ref: '#/components/schemas/Email'
        entry:
          type: string
          description: Identifier for entrypoint originating the request (used by front-end apps)
        entryType:
          type: integer
          description: 'Type of entry identifier: 0 - partner, 2 - paypoint. This is used by front-end apps, required if an Entry is indicated.'
    AuthResetUserResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    UserAuthPswResetRequest:
      type: object
      properties:
        psw:
          type: string
          description: New User password
    ChangePswUserResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    LogoutUserResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    MfaValidationData:
      type: object
      properties:
        mfaCode:
          type: string
        mfaValidationCode:
          $ref: '#/components/schemas/MfaValidationCode'
    EditMfaUserResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    VendorEin:
      type: string
      description: |
        EIN/Tax ID for vendor. Must be nine digits formatted as `XX-XXXXXXX`
        (for example, `12-3456789`).
    VendorName1:
      type: string
      description: |
        Primary name for vendor. Required for new vendor.
    VendorName2:
      type: string
      description: |
        Secondary name for vendor. If provided, allowed characters are the
        same as the `name1` field.
    VendorPhone:
      type: string
      pattern: ^[0-9]+$
      description: |
        Vendor's phone number. Phone number can't contain non-digit characters
        like hyphens or parentheses.
    VendorData:
      type: object
      properties:
        vendorNumber:
          $ref: '#/components/schemas/VendorNumber'
        AdditionalData:
          $ref: '#/components/schemas/AdditionalData'
        address1:
          description: Vendor's street address. If any address field is provided, this field is required along with `city`, `state`, and `zip`. Allowed characters are letters, numbers, spaces, and `. ,
          $ref: '#/components/schemas/AddressNullable'
        address2:
          description: Additional line for vendor's address, such as a suite or unit number. Always optional.
          $ref: '#/components/schemas/AddressAddtlNullable'
        billingData:
          description: Object containing vendor's bank information.
          $ref: '#/components/schemas/BillingData'
        city:
          type: string
          description: Vendor's city. Required if any address field is provided.
        contacts:
          description: Array of objects describing the vendor's contacts.
          $ref: '#/components/schemas/ContactsField'
        country:
          type: string
          description: Vendor's country. Must be `US` or `CA`. Defaults to `US` if not provided.
        customField1:
          type: string
          description: Custom field 1 for vendor
        customField2:
          type: string
          description: Custom field 2 for vendor
        customerVendorAccount:
          type: string
          description: Account number of paypoint in the vendor side.
        ein:
          $ref: '#/components/schemas/VendorEin'
        email:
          description: Vendor's email address. Required for vCard.
          $ref: '#/components/schemas/Email'
        internalReferenceId:
          type: integer
          format: int64
          description: Internal identifier for global vendor account.
        locationCode:
          $ref: '#/components/schemas/LocationCode'
        mcc:
          $ref: '#/components/schemas/Mcc'
        name1:
          $ref: '#/components/schemas/VendorName1'
        name2:
          $ref: '#/components/schemas/VendorName2'
        payeeName1:
          $ref: '#/components/schemas/PayeeName'
        payeeName2:
          $ref: '#/components/schemas/PayeeName'
        paymentMethod:
          $ref: '#/components/schemas/VendorPaymentMethodString'
        phone:
          $ref: '#/components/schemas/VendorPhone'
        remitAddress1:
          $ref: '#/components/schemas/Remitaddress1'
        remitAddress2:
          $ref: '#/components/schemas/Remitaddress2'
        remitCity:
          $ref: '#/components/schemas/Remitcity'
        remitCountry:
          $ref: '#/components/schemas/Remitcountry'
        remitEmail:
          $ref: '#/components/schemas/RemitEmail'
        remitState:
          $ref: '#/components/schemas/Remitstate'
        remitZip:
          $ref: '#/components/schemas/Remitzip'
        state:
          type: string
          description: Vendor's state or province. Required if any address field is provided. Must be a valid US state abbreviation (such as `CA`, `NY`) or Canadian province abbreviation (such as `ON`, `BC`), depending on the `country` value.
        vendorStatus:
          $ref: '#/components/schemas/Vendorstatus'
        zip:
          type: string
          description: Vendor's ZIP or postal code. Required if any address field is provided. For US addresses, use five digits (`12345`) or ZIP+4 format (`12345-6789`).
        defaultMethodId:
          type: string
          description: Identifier for the vendor's default stored payment method.
        attachment:
          description: |-
            PDF invoice attachment for AI-powered vendor enrichment.
            When this feature is enabled and you include an attachment, the invoice is scanned and extracted vendor information is merged into the request.
            Fields in the request body take precedence over extracted data.
            If the scan fails, vendor creation proceeds with the original request data.
            See the [vendor enrichment guide](/guides/pay-out-vendor-enrichment-overview) for details.
            Contact Payabli to enable this feature.
          $ref: '#/components/schemas/FileContent'
    PayabliApiResponseVendors:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          type: integer
          description: If the request was successful, this field contains the identifier for the vendor.
        responseText:
          $ref: '#/components/schemas/ResponseText'
    VendorEnrichRequest:
      type: object
      description: Request body for the vendor enrichment endpoint.
      required:
        - vendorId
      properties:
        vendorId:
          type: integer
          format: int64
          description: ID of the vendor to enrich. Must be active and belong to the given entrypoint.
        scope:
          type: array
          items:
            type: string
          description: 'Enrichment stages to run. Valid values are `invoice_scan` and `web_search`. Stages run in order: invoice scan first, then web search. If the vendor becomes payout-ready after invoice scan, web search is skipped.'
        applyEnrichmentData:
          type: boolean
          description: When `true` (the default), extracted data is automatically written to the vendor record. Only empty fields are populated, existing values are never overwritten. When `false`, the vendor record isn't modified. In both cases, `enrichmentData` in the response contains the extracted results. Use `false` for UI flows where users review and confirm changes before applying them with the update vendor endpoint.
        scheduleCallIfNeeded:
          type: boolean
          description: When `true`, triggers an AI outreach call if enrichment stages return insufficient payment acceptance info. This feature is currently in development.
          x-fern-availability: in-development
        invoiceFile:
          description: PDF invoice file, Base64-encoded. Required when `scope` includes `invoice_scan`.
          $ref: '#/components/schemas/FileContent'
        billId:
          type: integer
          format: int64
          description: Bill ID to associate with this enrichment request.
        fallbackMethod:
          type: string
          description: Payment method to apply if enrichment can't find payment details. Values are `check`, `ach`, or `card`.
    VendorEnrichmentInvoiceScan:
      type: object
      description: Vendor contact information and payment acceptance info extracted from an invoice.
      properties:
        vendorName:
          type: string
          description: Vendor name extracted from the invoice.
        street:
          type: string
          description: Street address.
        city:
          type: string
          description: City.
        state:
          type: string
          description: State (two-letter abbreviation).
        zipCode:
          type: string
          description: ZIP code.
        country:
          type: string
          description: Country code.
        phone:
          type: string
          description: Phone number. Format isn't guaranteed and is extracted as-is from the invoice.
        email:
          type: string
          description: Email address.
        paymentLink:
          type: string
          description: Payment portal URL, if found on the invoice.
        cardAccepted:
          type: string
          description: Whether the vendor accepts card payments. Values are `yes`, `no`, or `unable to determine`.
        achAccepted:
          type: string
          description: Whether the vendor accepts ACH payments. Values are `yes`, `no`, or `unable to determine`.
        checkAccepted:
          type: string
          description: Whether the vendor accepts check payments. Values are `yes`, `no`, or `unable to determine`.
        invoiceNumber:
          type: string
          description: Invoice number extracted from the document.
        amountDue:
          type: number
          format: double
          description: Invoice amount due in USD.
        dueDate:
          type: string
          description: Payment due date. Format is `YYYY-MM-DD`.
    VendorEnrichmentWebSearch:
      type: object
      description: Vendor contact information and payment acceptance info found through web search.
      properties:
        phone:
          type: string
          description: Phone number found through web search. Format isn't guaranteed.
        phoneType:
          type: string
          description: Phone classification. Values are `main`, `billing`, or `customer_service`.
        email:
          type: string
          description: Email address.
        emailType:
          type: string
          description: Email classification. Values are `billing`, `general`, or `customer_service`.
        street:
          type: string
          description: Street address.
        city:
          type: string
          description: City.
        state:
          type: string
          description: State (two-letter abbreviation).
        zipCode:
          type: string
          description: ZIP code.
        country:
          type: string
          description: Country code.
        addressType:
          type: string
          description: Address classification. Values are `business`, `headquarters`, or `mailing`.
        paymentLink:
          type: string
          description: Payment portal URL.
        paymentLinkType:
          type: string
          description: Link classification. Values are `payment_portal`, `billing_page`, or `general_website`.
        cardAccepted:
          type: string
          description: Whether the vendor accepts card payments. Values are `yes`, `no`, or `unable to determine`.
        achAccepted:
          type: string
          description: Whether the vendor accepts ACH payments. Values are `yes`, `no`, or `unable to determine`.
        checkAccepted:
          type: string
          description: Whether the vendor accepts check payments. Values are `yes`, `no`, or `unable to determine`.
    VendorEnrichmentData:
      type: object
      description: Container for enrichment stage results.
      properties:
        invoiceScan:
          description: Results from the invoice scan stage, if it ran.
          $ref: '#/components/schemas/VendorEnrichmentInvoiceScan'
        webSearch:
          description: Results from the web search stage, if it ran.
          $ref: '#/components/schemas/VendorEnrichmentWebSearch'
    VendorEnrichResponseData:
      type: object
      description: Enrichment result details.
      properties:
        enrichmentId:
          type: string
          description: 'Unique identifier for this enrichment run. Format: `enrich-{vendorId}-{8-char hex}`.'
        status:
          type: string
          description: Final enrichment status. Values are `completed` (vendor is payout-ready), `completed_from_network` (vendor was already enriched in the Payabli vendor network, no AI processing needed), or `insufficient` (all stages ran but the vendor still lacks sufficient payment data).
        stagesTriggered:
          type: array
          items:
            type: string
          description: Stages that ran successfully. A stage is only listed here if it returned a successful response. Failed stages are excluded.
        vendorPayoutReady:
          type: boolean
          description: '`true` if the vendor now has sufficient payment data to process a payout (ACH, card email, or check remit address).'
        enrichmentData:
          description: Raw extraction results from the enrichment stages that ran.
          $ref: '#/components/schemas/VendorEnrichmentData'
    VendorEnrichResponse:
      type: object
      description: Response from the vendor enrichment endpoint.
      required:
        - responseText
      properties:
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        roomId:
          $ref: '#/components/schemas/RoomIdNotInUse'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          $ref: '#/components/schemas/VendorEnrichResponseData'
    CreateGhostCardRequestBody:
      type: object
      required:
        - vendorId
        - expenseLimit
        - amount
        - maxNumberOfUses
        - exactAmount
        - expenseLimitPeriod
        - billingCycle
        - billingCycleDay
        - dailyTransactionCount
        - dailyAmountLimit
        - transactionAmountLimit
      properties:
        vendorId:
          type: integer
          format: int64
          description: ID of the vendor who receives the card. The vendor must belong to the paypoint and have an active status.
        expenseLimit:
          type: number
          format: double
          description: Spending limit for the card. Must be greater than `0` and can't exceed the paypoint's configured payout credit limit.
        expirationDate:
          type: string
          description: Requested expiration date for the card. If not provided, defaults to 30 days from creation.
        amount:
          type: number
          format: double
          description: Initial load amount for the card.
        maxNumberOfUses:
          type: integer
          description: Maximum number of times the card can be used. Ignored and set to `1` when `exactAmount` is `true`.
        exactAmount:
          type: boolean
          description: When `true`, restricts the card to a single use. `maxNumberOfUses` is automatically set to `1` regardless of any other value provided.
        expenseLimitPeriod:
          type: string
          description: Time period over which `expenseLimit` applies (for example, `monthly` or `weekly`).
        billingCycle:
          type: string
          description: Billing cycle identifier.
        billingCycleDay:
          type: string
          description: Day within the billing cycle.
        dailyTransactionCount:
          type: integer
          description: Maximum number of transactions allowed per day.
        dailyAmountLimit:
          type: number
          format: double
          description: Maximum total spend allowed per day.
        transactionAmountLimit:
          type: integer
          description: Maximum spend allowed per single transaction.
        mcc:
          type: string
          description: Merchant Category Code to restrict where the card can be used. Must be a valid MCC if provided.
        tcc:
          type: string
          description: Transaction Category Code to restrict where the card can be used. Must be a valid TCC if provided.
        misc1:
          type: string
          description: Custom metadata field. Stored on the card record.
        misc2:
          type: string
          description: Custom metadata field. Stored on the card record.
    CreateGhostCardResponseData:
      type: object
      properties:
        ReferenceId:
          type: string
          description: Card token for the ghost card. Use this value to reference the card in subsequent operations (update, cancel, etc.).
        ResultCode:
          $ref: '#/components/schemas/ResultCode'
        ResultText:
          $ref: '#/components/schemas/Resulttext'
    CreateGhostCardResponse:
      type: object
      description: Response for creating a ghost card.
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          $ref: '#/components/schemas/CreateGhostCardResponseData'
    CardStatus:
      type: string
      description: 'The status to set on the card. Not all transitions are valid: `Active` can change to `Inactive`, `Cancelled`, or `Expired`. `Inactive` can change to `Active`. `Expired` can change to `Active` (renews the card). `Cancelled` is terminal and can''t be changed.'
      enum:
        - Active
        - Inactive
        - Cancelled
        - Expired
    UpdateCardRequestBody:
      type: object
      required:
        - cardToken
      properties:
        cardToken:
          type: string
          description: Token that uniquely identifies the card. This is the `ReferenceId` returned when the card was created.
        status:
          description: The new status to set on the card.
          $ref: '#/components/schemas/CardStatus'
    AuthorizePaymentMethod:
      type: object
      description: |-
        Payment method object for vendor payouts.
        - `{ method: "managed" }` - Managed payment method
        - `{ method: "vcard" }` - Virtual card payment method
        - `{ method: "check" }` - Check payment method
        - `{ method: "ach", achHolder: "...", achRouting: "...", achAccount: "...", achAccountType: "..." }` - ACH payment method with bank details
        - `{ method: "ach", storedMethodId: "..." }` - ACH payment method using stored method ID
      required:
        - method
      properties:
        method:
          type: string
          description: Payment method type - "managed", "vcard", "check", or "ach"
        achHolder:
          type: string
          description: Account holder name for ACH payments. Required when method is "ach" and not using `storedMethodId`.
          maxLength: 250
        achRouting:
          type: string
          description: Bank routing number for ACH payments. Required when method is "ach" and not using `storedMethodId`.
        achAccount:
          type: string
          description: Bank account number for ACH payments. Required when method is "ach" and not using `storedMethodId`.
        achAccountType:
          type: string
          description: Account type for ACH payments ("checking" or "savings"). Required when method is "ach" and not using `storedMethodId`.
        achCode:
          $ref: '#/components/schemas/AchSecCode'
        achHolderType:
          $ref: '#/components/schemas/AchHolderType'
        storedMethodId:
          type: string
          description: ID of the stored ACH payment method. Only applicable when method is `ach`. Use this to reference a previously saved ACH method instead of providing bank details directly.
        initiator:
          $ref: '#/components/schemas/Initiator'
        storedMethodUsageType:
          $ref: '#/components/schemas/StoredMethodUsageType'
    VendorCheckNumber:
      type: string
      description: |
        A check number between 1 and 500,000,000. This value must be passed as
        a string. This value can be used for fraud prevention with the
        positive pay service. When no check number is provided, Payabli
        automatically manages check numbering and sequencing for checks issued
        from the same bank account.
    RequestOutAuthorizePaymentDetails:
      type: object
      description: Object containing payment details.
      properties:
        checkNumber:
          $ref: '#/components/schemas/VendorCheckNumber'
        currency:
          type: string
          description: Currency code ISO-4217. If no code is provided, then the currency in the paypoint setting is used. Default is **USD**.
        serviceFee:
          type: number
          format: double
          description: Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually.
        totalAmount:
          type: number
          format: double
          description: Total amount to be charged. If a service fee is included, then this amount should include the service fee.
        unbundled:
          type: boolean
          description: Indicates whether the payout should be bundled into a single transaction or processed separately. If set to `true`, each bill will be processed as a separate payout. If `false` or not provided, then multiple bills will be paid with a single payout.
    RequestOutAuthorizeVendorBillingData:
      type: object
      description: Object containing vendor's bank information. This object is deprecated for this endpoint. Use the `paymentMethod` object in payout authorize requests instead.
      properties:
        bankName:
          $ref: '#/components/schemas/BankName'
        routingAccount:
          $ref: '#/components/schemas/RoutingAccount'
        accountNumber:
          $ref: '#/components/schemas/AccountNumber'
        typeAccount:
          $ref: '#/components/schemas/TypeAccount'
        bankAccountHolderName:
          $ref: '#/components/schemas/BankAccountHolderName'
    RequestOutAuthorizeVendorData:
      type: object
      description: Object containing vendor data.
      properties:
        vendorNumber:
          $ref: '#/components/schemas/VendorNumber'
        name1:
          $ref: '#/components/schemas/VendorName1'
        name2:
          $ref: '#/components/schemas/VendorName2'
        ein:
          $ref: '#/components/schemas/VendorEin'
        phone:
          $ref: '#/components/schemas/VendorPhone'
        email:
          $ref: '#/components/schemas/Email'
        address1:
          $ref: '#/components/schemas/AddressNullable'
        city:
          type: string
        state:
          type: string
        zip:
          type: string
        country:
          type: string
        mcc:
          $ref: '#/components/schemas/Mcc'
        contacts:
          $ref: '#/components/schemas/ContactsField'
        billingData:
          $ref: '#/components/schemas/RequestOutAuthorizeVendorBillingData'
          x-fern-availability: deprecated
        vendorStatus:
          $ref: '#/components/schemas/Vendorstatus'
        remitAddress1:
          $ref: '#/components/schemas/Remitaddress1'
        remitAddress2:
          $ref: '#/components/schemas/Remitaddress2'
        remitCity:
          $ref: '#/components/schemas/Remitcity'
        remitState:
          $ref: '#/components/schemas/Remitstate'
        remitZip:
          $ref: '#/components/schemas/Remitzip'
        remitCountry:
          $ref: '#/components/schemas/Remitcountry'
        customerVendorAccount:
          type: string
        customField1:
          type: string
        customField2:
          type: string
        additionalData:
          $ref: '#/components/schemas/AdditionalData'
        address2:
          $ref: '#/components/schemas/AddressAddtlNullable'
        internalReferenceId:
          type: integer
          format: int64
        locationCode:
          $ref: '#/components/schemas/LocationCode'
        payeeName1:
          $ref: '#/components/schemas/PayeeName'
        payeeName2:
          $ref: '#/components/schemas/PayeeName'
        paymentMethod:
          $ref: '#/components/schemas/VendorPaymentMethod'
        vendorId:
          $ref: '#/components/schemas/Vendorid'
    LotNumber:
      type: string
      description: Lot number associated with the bill.
    RequestOutAuthorizeInvoiceData:
      type: object
      properties:
        invoiceNumber:
          $ref: '#/components/schemas/InvoiceNumber'
        netAmount:
          $ref: '#/components/schemas/NetAmountstring'
        invoiceDate:
          type: string
          format: date
          description: 'Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
        dueDate:
          type: string
          format: date
          description: 'Invoice due date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.'
        comments:
          $ref: '#/components/schemas/Comments'
        lotNumber:
          $ref: '#/components/schemas/LotNumber'
        billId:
          $ref: '#/components/schemas/BillId'
        discount:
          $ref: '#/components/schemas/Discount'
        terms:
          $ref: '#/components/schemas/Terms'
        accountingField1:
          $ref: '#/components/schemas/AccountingField'
        accountingField2:
          $ref: '#/components/schemas/AccountingField'
        additionalData:
          $ref: '#/components/schemas/AdditionalDataString'
        attachments:
          $ref: '#/components/schemas/Attachments'
    AutoCapture:
      type: boolean
      description: |
        When `true`, Payabli captures the transaction asynchronously after a
        successful authorization. The authorization request returns once the
        transaction is authorized; capture happens later, and the response
        doesn't confirm capture. To confirm capture succeeded, listen for the
        [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured)
        webhook event.

        When `false`, you must manually capture the transaction after a
        successful authorization. Defaults to `false`.

        See [Manage payouts with the API](/guides/pay-out-developer-payouts-manage)
        for more information.
    AuthorizePayoutBody:
      type: object
      required:
        - entryPoint
        - paymentMethod
        - paymentDetails
        - vendorData
        - invoiceData
      properties:
        entryPoint:
          $ref: '#/components/schemas/Entrypointfield'
        source:
          $ref: '#/components/schemas/Source'
        orderId:
          $ref: '#/components/schemas/OrderId'
        orderDescription:
          $ref: '#/components/schemas/Orderdescription'
        paymentMethod:
          $ref: '#/components/schemas/AuthorizePaymentMethod'
        paymentDetails:
          description: Object containing payment details.
          $ref: '#/components/schemas/RequestOutAuthorizePaymentDetails'
        vendorData:
          description: Object containing vendor data.
          $ref: '#/components/schemas/RequestOutAuthorizeVendorData'
        invoiceData:
          type: array
          items:
            $ref: '#/components/schemas/RequestOutAuthorizeInvoiceData'
          description: Array of bills associated to the transaction
        accountId:
          $ref: '#/components/schemas/AccountId'
        subdomain:
          $ref: '#/components/schemas/Subdomain'
        subscriptionId:
          $ref: '#/components/schemas/Subscriptionid'
        autoCapture:
          $ref: '#/components/schemas/AutoCapture'
          default: false
    AuthCapturePayoutResponseData:
      type: object
      required:
        - authCode
        - referenceId
        - resultCode
        - resultText
        - avsResponseText
        - cvvResponseText
        - customerId
        - methodReferenceId
      properties:
        authCode:
          oneOf:
            - $ref: '#/components/schemas/Authcode'
            - type: 'null'
        referenceId:
          $ref: '#/components/schemas/Referenceidtrans'
        resultCode:
          $ref: '#/components/schemas/ResultCode'
        resultText:
          $ref: '#/components/schemas/Resulttext'
        avsResponseText:
          oneOf:
            - $ref: '#/components/schemas/AvsResponseText'
            - type: 'null'
        cvvResponseText:
          oneOf:
            - $ref: '#/components/schemas/CvvResponseText'
            - type: 'null'
        customerId:
          $ref: '#/components/schemas/Customeridtrans'
        methodReferenceId:
          oneOf:
            - $ref: '#/components/schemas/MethodReferenceId'
            - type: 'null'
    AuthCapturePayoutResponse:
      type: object
      required:
        - responseCode
        - pageIdentifier
        - roomId
        - isSuccess
        - responseText
        - responseData
      properties:
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        pageIdentifier:
          oneOf:
            - $ref: '#/components/schemas/PageIdentifier'
            - type: 'null'
        roomId:
          $ref: '#/components/schemas/RoomIdNotInUse'
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          $ref: '#/components/schemas/AuthCapturePayoutResponseData'
    CaptureAllOutResponseResponseDataItem:
      type: object
      properties:
        CustomerId:
          description: Internal unique Id of vendor owner of transaction. Returns `0` if the transaction wasn't assigned to an existing vendor or no vendor was created.
          $ref: '#/components/schemas/Customeridtrans'
        ReferenceId:
          $ref: '#/components/schemas/Referenceidtrans'
        ResultCode:
          $ref: '#/components/schemas/ResultCode'
        ResultText:
          description: |-
            Text describing the result.
            If `ResultCode` = 1, returns 'Authorized'.
            If `ResultCode` = 2 or 3, this contains the cause of the decline.
          $ref: '#/components/schemas/Resulttext'
    CaptureAllOutResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          type: array
          items:
            $ref: '#/components/schemas/CaptureAllOutResponseResponseDataItem'
          description: Array of objects describing the transactions.
        responseText:
          $ref: '#/components/schemas/ResponseText'
    PayabliApiResponse0000:
      type: object
      description: The response for canceling a single payout transaction.
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          $ref: '#/components/schemas/PayabliApiResponse0ResponseData'
    BillDetailsResponse:
      type: object
      description: Response object for bill details. Contains basic information about a bill.
      required:
        - dueDate
        - invoiceDate
      properties:
        billId:
          $ref: '#/components/schemas/BillId'
        lotNumber:
          type: string
          description: Lot number of the bill.
        invoiceNumber:
          description: Custom number identifying the bill.
          $ref: '#/components/schemas/InvoiceNumber'
        netAmount:
          description: Net Amount owed in bill. Required when adding a bill.
          $ref: '#/components/schemas/NetAmountstring'
        discount:
          type: string
          description: Bill discount amount.
        dueDate:
          type:
            - string
            - 'null'
          format: date
          description: Bill due date in format YYYY-MM-DD or MM/DD/YYYY.
        invoiceDate:
          type:
            - string
            - 'null'
          format: date
          description: Bill date in format YYYY-MM-DD or MM/DD/YYYY.
        comments:
          description: Any comments about bill. **For managed payouts, this field has a limit of 100 characters**.
          $ref: '#/components/schemas/Comments'
    BillDetailResponse:
      type: object
      properties:
        Bills:
          type: array
          items:
            $ref: '#/components/schemas/BillDetailsResponse'
          description: Bills associated with this transaction.
        CheckData:
          description: Object referencing to paper check image.
          $ref: '#/components/schemas/FileContent'
        CheckNumber:
          type: string
          description: Paper check number related to payout transaction.
        Comments:
          description: Any comment or description for payout transaction.
          $ref: '#/components/schemas/Comments'
        CreatedDate:
          description: Timestamp when the payment was created, in UTC.
          $ref: '#/components/schemas/CreatedAt'
        CreatedAt:
          $ref: '#/components/schemas/CreatedAt'
        Events:
          type: array
          items:
            $ref: '#/components/schemas/QueryTransactionEvents'
          description: Events associated to this transaction.
        FeeAmount:
          $ref: '#/components/schemas/FeeAmount'
        Gateway:
          $ref: '#/components/schemas/Gatewayfield'
        IdOut:
          type: integer
          format: int64
          description: Identifier of payout transaction.
        LastUpdated:
          description: Timestamp when payment record was updated, in UTC.
          $ref: '#/components/schemas/LastModified'
        NetAmount:
          $ref: '#/components/schemas/Netamountnullable'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        ParentOrgId:
          $ref: '#/components/schemas/OrgParentId'
        PaymentData:
          $ref: '#/components/schemas/QueryPaymentData'
        PaymentGroup:
          type: string
          description: Unique identifier for group or batch containing the transaction.
        PaymentId:
          $ref: '#/components/schemas/PaymentIdString'
        PaymentMethod:
          type: string
          description: Method of payment applied to the transaction.
        PaymentStatus:
          type: string
          description: Status of payout transaction.
        PaypointDbaname:
          $ref: '#/components/schemas/Dbaname'
        PaypointLegalname:
          description: Paypoint legal name.
          $ref: '#/components/schemas/Legalname'
        Source:
          $ref: '#/components/schemas/Source'
        Status:
          type: integer
          description: |-
            Internal status of transaction.
            Payout statuses, also known as money out transaction statuses, appear in PartnerHub and PayHub, and the API, and describe where a payout transaction is in its lifecycle.
            | Status | Key | Description | Events |
            |--------|-----|-------------|---------|
            | **Authorized** | 11 | A payout is authorized. These are queued payouts, and nothing happens with them until they're captured. | Authorized |
            | **Captured** | 1 | A payout is captured and is now part of the batch for payout. | Captured |
            | **Canceled** | 0 | An authorized payout has been canceled. A captured payout can be canceled before batch close at 5 PM ET. | Cancelled |
            | **Processing** | 2 | A payout is being processed. | Waiting funds, Funded, Pending (payment type is pending), Generating check |
            | **Processed** | 3 | A payment method is defined for the vendor, and the payout has been sent to the recipient. | Open (vCard issued, ACH sent, check generated but not yet cashed), Processed (Payment Type is no longer pending), Reissued, Returned, Errored |
            | **OnHold** | 4 | A payout has been placed on hold and requires review before proceeding. | OnHold |
            | **Paid** | 5 | A payout has been paid and the recipient has redeemed the funds. | Paid (check cleared, vCard used, ACH settled) |
        StatusText:
          type: string
          description: Text description of the payout transaction status.
        TotalAmount:
          type: number
          format: double
          description: Transaction total amount (including service fee or sub-charge).
        Vendor:
          description: Vendor related to the payout transaction.
          $ref: '#/components/schemas/VendorQueryRecord'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        EntryName:
          $ref: '#/components/schemas/Entry'
        BatchId:
          type: string
          description: Identifier for the batch in which this transaction was processed. Used to track and reconcile batch-level operations.
        HasVcardTransactions:
          $ref: '#/components/schemas/HasVcardTransactions'
        IsSameDayACH:
          $ref: '#/components/schemas/IsSameDayACH'
        ScheduleId:
          $ref: '#/components/schemas/ScheduleId'
          x-fern-availability: in-development
        SettlementStatus:
          $ref: '#/components/schemas/SettlementStatus'
        RiskFlagged:
          $ref: '#/components/schemas/RiskFlagged'
        RiskFlaggedOn:
          $ref: '#/components/schemas/RiskFlaggedOn'
        RiskStatus:
          $ref: '#/components/schemas/RiskStatus'
        RiskReason:
          $ref: '#/components/schemas/RiskReason'
        RiskAction:
          $ref: '#/components/schemas/RiskAction'
        RiskActionCode:
          $ref: '#/components/schemas/RiskActionCode'
    VCardGetResponseContact:
      type: object
      description: Contact information structure.
      properties:
        ContactName:
          type: string
          description: Name of the contact.
        ContactEmail:
          type: string
          description: Email of the contact.
        ContactTitle:
          type: string
          description: Title of the contact.
        ContactPhone:
          type: string
          description: Phone number of the contact.
    VCardGetResponseAssociatedVendorBillingData:
      type: object
      description: Billing data for the vendor.
      properties:
        id:
          type: integer
          description: Unique identifier for billing data.
        accountId:
          type: string
          description: Account identifier.
        nickname:
          type: string
          description: Nickname for the account.
        bankName:
          type: string
          description: Name of the bank used for transactions.
        routingAccount:
          type: string
          description: Routing number for the bank account.
        accountNumber:
          type: string
          description: Masked account number for transactions.
        typeAccount:
          type: string
          description: Type of the bank account.
        bankAccountHolderName:
          type: string
          description: Name of the bank account holder.
        bankAccountHolderType:
          type: string
          description: Type of bank account holder.
        bankAccountFunction:
          type: integer
          description: Function of the bank account.
        verified:
          type: boolean
          description: Indicates if the account is verified.
        status:
          type: integer
          description: Status of the billing data.
        services:
          type: array
          items: {}
          description: Services associated with the account.
        default:
          type: boolean
          description: Indicates if this is the default billing account.
    VCardGetResponseAssociatedVendorSummary:
      type: object
      description: Summary of vendor's billing and transaction status.
      properties:
        ActiveBills:
          type: integer
          description: Number of active bills.
        PendingBills:
          type: integer
          description: Number of bills pending approval or payment.
        InTransitBills:
          type: integer
          description: Number of bills in transit.
        PaidBills:
          type: integer
          description: Number of bills that have been paid.
        OverdueBills:
          type: integer
          description: Number of bills that are overdue.
        ApprovedBills:
          type: integer
          description: Number of bills that have been approved.
        DisapprovedBills:
          type: integer
          description: Number of bills that have been disapproved.
        TotalBills:
          type: integer
          description: Total number of bills.
        ActiveBillsAmount:
          type: number
          format: double
          description: Total amount of active bills.
        PendingBillsAmount:
          type: number
          format: double
          description: Total amount of pending bills.
        InTransitBillsAmount:
          type: number
          format: double
          description: Total amount of bills in transit.
        PaidBillsAmount:
          type: number
          format: double
          description: Total amount of paid bills.
        OverdueBillsAmount:
          type: number
          format: double
          description: Total amount of overdue bills.
        ApprovedBillsAmount:
          type: number
          format: double
          description: Total amount of approved bills.
        DisapprovedBillsAmount:
          type: number
          format: double
          description: Total amount of rejected bills.
        TotalBillsAmount:
          type: number
          format: double
          description: Total amount of all bills.
    VCardGetResponseAssociatedVendor:
      type: object
      description: Information about the associated vendor.
      properties:
        VendorNumber:
          type: string
          description: Unique code identifying the vendor.
        Name1:
          type: string
          description: The primary name associated with the vendor.
        Name2:
          type: string
          description: Additional name information for the vendor.
        EIN:
          type: string
          description: Employer Identification Number of the vendor.
        Phone:
          type: string
          description: Contact phone number of the vendor.
        Email:
          type: string
          description: Contact email address of the vendor.
        RemitEmail:
          type: string
          description: Email address for remittance.
        Address1:
          type: string
          description: Primary address line of the vendor.
        Address2:
          type: string
          description: Secondary address line of the vendor.
        City:
          type: string
          description: City where the vendor is located.
        State:
          type: string
          description: State where the vendor is located.
        Zip:
          type: string
          description: ZIP code for the vendor's location.
        Country:
          type: string
          description: Country where the vendor is located.
        Mcc:
          type: string
          description: Merchant Category Code for the vendor.
        LocationCode:
          $ref: '#/components/schemas/LocationCode'
        Contacts:
          type: array
          items:
            $ref: '#/components/schemas/VCardGetResponseContact'
          description: Array of objects describing the vendor's contacts.
        BillingData:
          description: Billing data for the vendor.
          $ref: '#/components/schemas/VCardGetResponseAssociatedVendorBillingData'
        PaymentMethod:
          type: string
          description: Preferred payment method for vendor.
        VendorStatus:
          type: integer
          description: Status of the vendor.
        VendorId:
          type: integer
          description: Unique identifier for the vendor.
        EnrollmentStatus:
          type: string
          description: Enrollment status of the vendor.
        Summary:
          description: Summary of vendor's billing and transaction status.
          $ref: '#/components/schemas/VCardGetResponseAssociatedVendorSummary'
        PaypointLegalname:
          description: Legal name of the paypoint.
          $ref: '#/components/schemas/Legalname'
        PaypointDbaname:
          description: DBA name of the paypoint.
          $ref: '#/components/schemas/Dbaname'
        PaypointEntryname:
          type: string
          description: Entryname of the paypoint.
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        ParentOrgId:
          type: integer
          description: ID of the parent organization.
        CreatedDate:
          type: string
          description: Date when the vendor record was created.
        LastUpdated:
          type: string
          description: Date when the vendor's information was last updated.
        remitAddress1:
          $ref: '#/components/schemas/Remitaddress1'
        remitAddress2:
          $ref: '#/components/schemas/Remitaddress2'
        remitCity:
          $ref: '#/components/schemas/Remitcity'
        remitState:
          $ref: '#/components/schemas/Remitstate'
        remitZip:
          $ref: '#/components/schemas/Remitzip'
        remitCountry:
          $ref: '#/components/schemas/Remitcountry'
        payeeName1:
          type: string
          description: Primary name of the payee.
        payeeName2:
          type: string
          description: Secondary name of the payee.
        customField1:
          type: string
          description: A custom field for additional data.
        customField2:
          type: string
          description: Another custom field for extra data.
        customerVendorAccount:
          type: string
          description: Account number of paypoint in the vendor side.
        InternalReferenceId:
          type: integer
          description: Internal reference ID used within the system.
        additionalData:
          type: string
          description: Field for additional data, if any.
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        StoredMethods:
          type: string
          description: Stored payment methods for the vendor.
    VCardGetResponse:
      type: object
      properties:
        vcardSent:
          type: boolean
          description: Indicates if the virtual card was sent.
        cardToken:
          type: string
          description: A unique token identifier for the card.
        cardNumber:
          type: string
          description: The masked number of the card.
        cvc:
          type: string
          description: Masked Card Verification Code.
        expirationDate:
          type: string
          description: The expiration date of the card.
        status:
          type: string
          description: The current status of the card.
        amount:
          type: number
          format: double
          description: The initial amount loaded on the card.
        currentBalance:
          type: number
          format: double
          description: The current balance available on the card.
        expenseLimit:
          type: number
          format: double
          description: The set limit for expenses.
        expenseLimitPeriod:
          type: string
          description: The period for the expense limit.
        maxNumberOfUses:
          type: integer
          description: Maximum number of uses allowed for the card.
        currentNumberOfUses:
          type: integer
          description: The current number of times the card has been used.
        exactAmount:
          type: boolean
          description: Indicates if only the exact amount is allowed for transactions.
        mcc:
          type: string
          description: Merchant Category Code, if applicable.
        tcc:
          type: string
          description: Transaction Category Code, if applicable.
        misc1:
          type: string
          description: A miscellaneous field for additional information.
        misc2:
          type: string
          description: Another miscellaneous field for extra information.
        dateCreated:
          type: string
          description: The creation date of the record.
        dateModified:
          type: string
          description: The last modified date of the record.
        associatedVendor:
          description: Information about the associated vendor.
          $ref: '#/components/schemas/VCardGetResponseAssociatedVendor'
        associatedCustomer:
          type: string
          description: Information about the associated customer, if applicable.
        ParentOrgName:
          type: string
          description: Name of the parent organization.
        PaypointDbaname:
          type: string
          description: The 'Doing Business As' name of the Paypoint.
        PaypointLegalname:
          type: string
          description: The legal name of the Paypoint.
        PaypointEntryname:
          type: string
          description: Entry name for the Paypoint, if applicable.
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        paypointId:
          type: integer
          description: The unique identifier for the paypoint.
    SendVCardLinkRequest:
      type: object
      required:
        - transId
      properties:
        transId:
          type: string
          description: The transaction ID of the virtual card payout. The ID is returned as `ReferenceId` in the response when you authorize a payout with POST /MoneyOut/authorize.
    OperationResult:
      type: object
      required:
        - success
      properties:
        message:
          type: string
          description: Message describing the result. If the virtual card link was sent successfully, this contains the email address to which the link was sent.
        success:
          type: boolean
          description: Indicates whether the operation was successful.
    AllowedCheckPaymentStatus:
      type: string
      description: |-
        The new status to apply to a check payment transaction.
        - `0`: Cancelled/Voided — Cancels the check transaction.
        - `5`: Paid — Marks the check transaction as paid.
      enum:
        - '0'
        - '5'
      x-fern-enum:
        '0':
          name: Cancelled
        '5':
          name: Paid
    ReissuePaymentMethod:
      type: object
      description: |-
        Payment method for reissuing a payout transaction. The reissue endpoint uses the payment method details directly. It doesn't fall back to the vendor's managed payment method.
        - `{ method: "vcard" }` - Reissue as a virtual card
        - `{ method: "check" }` - Reissue as a paper check
        - `{ method: "ach", achHolder: "...", achRouting: "...", achAccount: "...", achAccountType: "...", achHolderType: "..." }` - Reissue as ACH with bank details
      required:
        - method
      properties:
        method:
          type: string
          description: Payment method type. Must be `"ach"`, `"check"`, or `"vcard"`.
        achHolder:
          type: string
          description: Account holder name. Required when `method` is `"ach"`.
          maxLength: 250
        achRouting:
          type: string
          description: Bank routing number (9 digits). Required when `method` is `"ach"`.
        achAccount:
          type: string
          description: Bank account number (8-17 digits). Required when `method` is `"ach"`.
        achAccountType:
          type: string
          description: Bank account type (`"checking"` or `"savings"`). Required when `method` is `"ach"`.
        achHolderType:
          $ref: '#/components/schemas/AchHolderType'
    ReissuePayoutBody:
      type: object
      description: Request body for reissuing a payout transaction.
      required:
        - paymentMethod
      properties:
        paymentMethod:
          $ref: '#/components/schemas/ReissuePaymentMethod'
    ReissuePayoutResponseData:
      type: object
      required:
        - transactionId
        - status
      properties:
        transactionId:
          type: string
          description: The transaction ID of the newly created payout.
        status:
          type: string
          description: The status of the new transaction.
        originalTransactionId:
          type: string
          description: The transaction ID of the original payout that was reissued.
    ReissuePayoutResponse:
      type: object
      required:
        - isSuccess
        - responseCode
        - responseText
        - responseData
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          $ref: '#/components/schemas/ReissuePayoutResponseData'
    Cascade:
      type: boolean
      description: |
        When `true`, the wallet service configuration cascades to all paypoints
        and suborganizations belonging to the parent entity.
    OrganizationId:
      type: integer
      format: int64
      description: Organization ID for the target organization.
    ConfigureOrganizationRequestApplePay:
      type: object
      properties:
        cascade:
          $ref: '#/components/schemas/Cascade'
        isEnabled:
          $ref: '#/components/schemas/IsEnabled'
        orgId:
          $ref: '#/components/schemas/OrganizationId'
    ApplePayId:
      type: string
      description: The internal identifier for Apple Pay-related information.
    ApplePayType:
      type: string
      description: The record type.
    WalletCascade:
      type: boolean
      description: |
        When `true`, the wallet service configuration cascades to all paypoints
        and suborganizations belonging to the parent entity.
    WalletIsEnabled:
      type: boolean
      description: When `true`, wallet service is enabled.
    OrganizationUpdates:
      type: object
      properties:
        cascade:
          $ref: '#/components/schemas/WalletCascade'
        isEnabled:
          $ref: '#/components/schemas/WalletIsEnabled'
    ApplePayOrganizationUpdateData:
      type: object
      properties:
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        id:
          description: Internal ID for the Apple Pay organization update.
          $ref: '#/components/schemas/ApplePayId'
        jobId:
          $ref: '#/components/schemas/JobId'
        jobStatus:
          $ref: '#/components/schemas/JobStatus'
        organizationId:
          $ref: '#/components/schemas/OrganizationId'
        type:
          description: The record type, in this context it will always be `ApplePayOrganizationUpdate`.
          $ref: '#/components/schemas/ApplePayType'
        updatedAt:
          $ref: '#/components/schemas/LastModified'
        updates:
          $ref: '#/components/schemas/OrganizationUpdates'
    ConfigureApplePayOrganizationApiResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          $ref: '#/components/schemas/ApplePayOrganizationUpdateData'
        responseText:
          $ref: '#/components/schemas/ResponseText'
    ConfigurePaypointRequestApplePay:
      type: object
      properties:
        entry:
          $ref: '#/components/schemas/Entry'
        isEnabled:
          description: When `true`, Apple Pay is enabled.
          $ref: '#/components/schemas/IsEnabled'
    AppleWalletData:
      type: object
      description: The wallet data.
      properties:
        entry:
          $ref: '#/components/schemas/Entry'
        applePayMerchantId:
          type: string
          description: The Apple Pay merchant identifier.
        domainNames:
          type: array
          items:
            $ref: '#/components/schemas/DomainName'
          description: A list of domain names that are enabled for this paypoint.
        paypointName:
          $ref: '#/components/schemas/PaypointName'
        paypointUrl:
          type:
            - string
            - 'null'
          description: The paypoint URL.
        markedForDeletionAt:
          type: string
          format: date-time
          description: The date and time a paypoint's Apple Pay registration was scheduled for deletion. The paypoint will be unregistered from Apple Pay permanently 30 days from this value.
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        updatedAt:
          $ref: '#/components/schemas/LastModified'
        id:
          description: Internal ID for the Apple Pay paypoint registration update.
          $ref: '#/components/schemas/ApplePayId'
        type:
          description: The record type, in this context it will always be `ApplePayRegistration`.
          $ref: '#/components/schemas/ApplePayType'
    ApplePayPaypointRegistrationData:
      type: object
      properties:
        entry:
          $ref: '#/components/schemas/Entry'
        isEnabled:
          $ref: '#/components/schemas/IsEnabled'
        walletType:
          type: string
          description: The wallet type. In this context it will always be `applepay`.
        walletData:
          $ref: '#/components/schemas/AppleWalletData'
    ConfigureApplePaypointApiResponse:
      type: object
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          $ref: '#/components/schemas/ApplePayPaypointRegistrationData'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        roomId:
          type:
            - integer
            - 'null'
          format: int64
          description: Field not in use on this endpoint
    ConfigureOrganizationRequestGooglePay:
      type: object
      properties:
        cascade:
          $ref: '#/components/schemas/Cascade'
        isEnabled:
          $ref: '#/components/schemas/IsEnabled'
        orgId:
          $ref: '#/components/schemas/OrganizationId'
    ConfigurePaypointRequestGooglePay:
      type: object
      properties:
        entry:
          $ref: '#/components/schemas/Entry'
        isEnabled:
          description: When `true`, Google Pay is enabled.
          $ref: '#/components/schemas/IsEnabled'
    GoogleWalletData:
      type: object
      description: The wallet data.
      properties:
        gatewayMerchantId:
          type: string
          description: The Google Pay merchant identifier.
        gatewayId:
          type: string
          description: The Google Pay gateway identifier.
    GooglePayPaypointRegistrationData:
      type: object
      properties:
        entry:
          $ref: '#/components/schemas/Entry'
        isEnabled:
          $ref: '#/components/schemas/IsEnabled'
        walletType:
          type: string
          description: The wallet type. In this context it will always be `googlepay`.
        walletData:
          $ref: '#/components/schemas/GoogleWalletData'
    ConfigureGooglePaypointApiResponse:
      type: object
      required:
        - isSuccess
        - pageIdentifier
        - responseCode
        - responseData
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/Responsecode'
        responseData:
          $ref: '#/components/schemas/GooglePayPaypointRegistrationData'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        roomId:
          type:
            - integer
            - 'null'
          format: int64
          description: Field not in use on this endpoint
    PayoutSetPause:
      type: boolean
      description: Flag indicating if the payout subscription is paused. When a payout subscription is paused, no payouts are processed until it's unpaused, and the next payment date isn't calculated automatically.
    PayoutPaymentDetail:
      type: object
      description: Payment details for payout subscriptions.
      required:
        - totalAmount
      properties:
        totalAmount:
          type: number
          format: double
          description: Total payout amount. If a service fee is included, this amount should include the service fee.
        serviceFee:
          type: number
          format: double
          description: Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted.
        currency:
          type: string
          description: Currency code ISO-4217. If no code is provided, the currency in the paypoint setting is used. Default is `USD`.
        checkNumber:
          type: string
          description: A check number for the payout. Required when the payment method is `check`.
        orderDescription:
          type: string
          description: Description of the payout order.
        orderId:
          type: string
          description: Order identifier associated with the payout.
        orderIdAlternative:
          type: string
          description: Alternative order identifier.
        paymentDescription:
          type: string
          description: Description of the payment.
        settlementDescriptor:
          type: string
          description: Settlement descriptor for the payout.
        groupNumber:
          type: string
          description: Group number for the payout.
        source:
          type: string
          description: Source identifier for the payout.
        payabliTransId:
          type: string
          description: Payabli transaction identifier.
        unbundled:
          type: boolean
          description: When `true`, each bill is processed as a separate payout. When `false` or not provided, multiple bills are paid with a single payout.
    BillPayOutDataRequest:
      type: object
      properties:
        billId:
          type: integer
          format: int64
          description: Bill ID in Payabli.
        comments:
          description: Any comments about bill. **For managed payouts, this field has a limit of 100 characters**.
          $ref: '#/components/schemas/Comments'
        dueDate:
          type: string
          format: date
          description: Bill due date in format YYYY-MM-DD or MM/DD/YYYY.
        invoiceDate:
          type: string
          format: date
          description: Bill date in format YYYY-MM-DD or MM/DD/YYYY.
        invoiceNumber:
          description: Custom number identifying the bill. Must be unique in paypoint. **Required** for new bill and when `billId` isn't provided.
          $ref: '#/components/schemas/InvoiceNumber'
        netAmount:
          description: Net Amount owed in bill. Required when adding a bill.
          $ref: '#/components/schemas/NetAmountstring'
        discount:
          type: string
          description: Bill discount amount.
        terms:
          description: Description of payment terms.
          $ref: '#/components/schemas/Terms'
        accountingField1:
          $ref: '#/components/schemas/AccountingField'
        accountingField2:
          $ref: '#/components/schemas/AccountingField'
        additionalData:
          $ref: '#/components/schemas/AdditionalDataString'
        attachments:
          description: Bill image attachment. Send the bill image as Base64-encoded string, or as a publicly accessible link. For full details on using this field with a payout authorization, see [the documentation](/developers/developer-guides/pay-out-manage-payouts).
          $ref: '#/components/schemas/Attachments'
    PayoutScheduleDetail:
      type: object
      properties:
        startDate:
          type: string
          description: 'Subscription start date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. This must be a future date.'
        endDate:
          type: string
          description: 'Subscription end date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY or the value `untilcancelled` to indicate a scheduled payout with infinite cycle.'
        frequency:
          description: Frequency of the payout subscription.
          $ref: '#/components/schemas/Frequency'
    PayoutSubscriptionRequestBody:
      type: object
      required:
        - entryPoint
        - paymentMethod
        - vendorData
      properties:
        entryPoint:
          $ref: '#/components/schemas/Entrypointfield'
        subdomain:
          $ref: '#/components/schemas/Subdomain'
        accountId:
          $ref: '#/components/schemas/AccountId'
        source:
          $ref: '#/components/schemas/Source'
        setPause:
          $ref: '#/components/schemas/PayoutSetPause'
        paymentMethod:
          description: Payment method for the payout subscription. Supports `ach`, `vcard`, and `check`. The `managed` method isn't supported for payout subscriptions.
          $ref: '#/components/schemas/AuthorizePaymentMethod'
        paymentDetails:
          description: Object describing details of the payout.
          $ref: '#/components/schemas/PayoutPaymentDetail'
        vendorData:
          description: Object identifying the vendor for this subscription. Only a `vendorId` or `vendorNumber` is needed to link to an existing vendor.
          $ref: '#/components/schemas/RequestOutAuthorizeVendorData'
        billData:
          type: array
          items:
            $ref: '#/components/schemas/BillPayOutDataRequest'
          description: Array of bills associated with the payout subscription. If omitted and `doNotCreateBills` isn't set to `true`, the system creates a bill automatically.
        scheduleDetails:
          description: Object describing the schedule for the payout subscription.
          $ref: '#/components/schemas/PayoutScheduleDetail'
    AddPayoutSubscriptionResponse:
      type: object
      description: Success response
      required:
        - responseText
        - responseData
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          type: integer
          description: The identifier of the newly created payout subscription.
        customerId:
          description: The identifier of the vendor associated with the payout subscription.
          $ref: '#/components/schemas/CustomerId'
    PayoutSubscriptionQueryRecord:
      type: object
      required:
        - startDate
        - endDate
        - nextDate
        - lastRun
      properties:
        idOutSubscription:
          type: integer
          format: int64
          description: The payout subscription's ID.
        status:
          type: integer
          description: |-
            The payout subscription's status.
            - 0: Paused
            - 1: Active
        events:
          type: array
          items:
            $ref: '#/components/schemas/GeneralEvents'
          description: Events associated with the payout subscription.
        vendor:
          $ref: '#/components/schemas/VendorQueryRecord'
        billData:
          type: array
          items:
            $ref: '#/components/schemas/BillPayOutData'
          description: Bills associated with the payout subscription.
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        method:
          type: string
          description: The payout subscription's payment method.
        paypointId:
          $ref: '#/components/schemas/PaypointId'
        totalAmount:
          type: number
          format: double
          description: The payout subscription amount, including any fees.
        netAmount:
          description: The payout subscription amount, minus any fees.
          $ref: '#/components/schemas/Netamountnullable'
        feeAmount:
          type: number
          format: double
          description: Fee applied to the payout subscription.
        paymentData:
          $ref: '#/components/schemas/QueryPaymentData'
        startDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The payout subscription start date.
        endDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The payout subscription's end date.
        nextDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The next date the payout subscription will be processed.
        frequency:
          type: string
          description: The payout subscription's frequency.
        totalCycles:
          type: integer
          description: The total number of cycles the payout subscription is set to run.
        leftCycles:
          type: integer
          description: The number of cycles the payout subscription has left.
        lastRun:
          type:
            - string
            - 'null'
          format: date-time
          description: The last time the payout subscription was processed.
        entrypageId:
          $ref: '#/components/schemas/EntrypageId'
        untilCancelled:
          type: boolean
          description: When `true`, the payout subscription has no explicit end date and runs until canceled.
        lastUpdated:
          description: The last date and time the payout subscription was updated.
          $ref: '#/components/schemas/LastModified'
        createdAt:
          description: Timestamp of when the payout subscription was created, in UTC.
          $ref: '#/components/schemas/CreatedAt'
        paypointLegalname:
          description: The paypoint's legal name.
          $ref: '#/components/schemas/Legalname'
        paypointDbaname:
          description: The paypoint's DBA name.
          $ref: '#/components/schemas/Dbaname'
        paypointEntryname:
          description: The paypoint's entryname.
          $ref: '#/components/schemas/Entrypointfield'
        parentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        parentOrgId:
          $ref: '#/components/schemas/OrgParentId'
        source:
          $ref: '#/components/schemas/Source'
    GetPayoutSubscriptionResponse:
      type: object
      description: Success response
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          description: The payout subscription record.
          $ref: '#/components/schemas/PayoutSubscriptionQueryRecord'
    UpdatePayoutSubscriptionBody:
      type: object
      properties:
        setPause:
          $ref: '#/components/schemas/PayoutSetPause'
        paymentDetails:
          description: Object describing details of the payout.
          $ref: '#/components/schemas/PayoutPaymentDetail'
        paymentMethod:
          $ref: '#/components/schemas/AuthorizePaymentMethod'
        scheduleDetails:
          description: Object describing the schedule for the payout subscription.
          $ref: '#/components/schemas/PayoutScheduleDetail'
    UpdatePayoutSubscriptionResponse:
      type: object
      description: Success response
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseText:
          $ref: '#/components/schemas/ResponseText'
        responseData:
          type: string
          description: |-
            If `isSuccess` = true, this contains the payout subscription ID. When the subscription is paused, it also includes a description (for example, "42 paused").

            If `isSuccess` = false, this contains the reason for the failure.
        customerId:
          $ref: '#/components/schemas/CustomerId'
    DeletePayoutSubscriptionResponse:
      type: object
      description: Success response
      required:
        - responseText
      properties:
        isSuccess:
          $ref: '#/components/schemas/IsSuccess'
        responseData:
          type: string
          description: |-
            If `isSuccess` = true, this contains the identifier of the payout subscription.

            If `isSuccess` = false, this contains the reason for the failure.
        responseText:
          $ref: '#/components/schemas/ResponseText'
    ResponseChargeBack:
      type: object
      properties:
        attachments:
          description: Array of attached files to response.
          $ref: '#/components/schemas/Attachments'
        contactEmail:
          description: Email of response submitter.
          $ref: '#/components/schemas/Email'
        contactName:
          type: string
          description: Name of response submitter
        notes:
          type: string
          description: Response notes
    AddResponseResponse:
      allOf:
        - $ref: '#/components/schemas/PayabliApiResponseGeneric2Part'
        - type: object
          properties:
            responseData:
              type: integer
              description: |
                If `isSuccess` = true, this contains the chargeback identifier. If
                `isSuccess` = false, this contains the reason for the error.
    ChargeBackResponse:
      type: object
      properties:
        attachments:
          description: Object with attached files to response
          $ref: '#/components/schemas/BoardingApplicationAttachments'
        contactEmail:
          description: Email of response submitter.
          $ref: '#/components/schemas/Email'
        contactName:
          type: string
          description: Name of response submitter
        createdAt:
          description: Timestamp when response was submitted, in UTC.
          $ref: '#/components/schemas/CreatedAt'
        id:
          type: integer
          format: int64
          description: Chargeback response identifier
        notes:
          type: string
          description: Response notes
    ChargebackMessage:
      type: object
      required:
        - Id
        - RoomId
        - UserId
        - UserName
        - Content
        - CreatedAt
        - MessageType
      properties:
        Id:
          type: integer
          description: Message identifier.
        RoomId:
          type: integer
          description: Room identifier for the message.
        UserId:
          type: integer
          description: User identifier who sent the message.
        UserName:
          type: string
          description: Name of the user who sent the message.
        Content:
          type: string
          description: Content of the message.
        CreatedAt:
          type: string
          format: date-time
          description: Timestamp when the message was created.
        MessageType:
          type: integer
          description: Type of message.
        MessageProperties:
          type: object
          additionalProperties:
            type: string
          description: Additional properties of the message.
    ChargebackQueryRecords:
      type: object
      required:
        - Id
        - ChargebackDate
        - CaseNumber
        - ReasonCode
        - Reason
        - ReferenceNumber
        - LastFour
        - AccountType
        - Status
        - Method
        - CreatedAt
        - ReplyBy
        - PaymentTransId
        - OrderId
        - TransactionTime
        - Customer
        - PaymentData
        - PaypointLegalname
        - PaypointDbaname
        - ParentOrgName
        - ParentOrgId
        - PaypointEntryname
        - Responses
        - Transaction
        - messages
        - ServiceGroup
        - DisputeType
        - ProcessorName
      properties:
        Id:
          type: integer
          format: int64
          description: Identifier of chargeback or return.
        ChargebackDate:
          type: string
          format: date-time
          description: Date of chargeback in format YYYY-MM-DD or MM/DD/YYYY.
        CaseNumber:
          type: string
          description: Number of case assigned to the chargeback.
        ReasonCode:
          type: string
          description: R code for returned ACH or custom code identifying the reason.
        Reason:
          type: string
          description: Text describing the chargeback or ACH return reason.
        ReferenceNumber:
          type: string
          description: Processor reference number to the chargeback.
        LastFour:
          type: string
          description: Last 4 digits of card or bank account involved in chargeback or return.
        AccountType:
          $ref: '#/components/schemas/Accounttype'
        Status:
          type: integer
          description: |-
            Status for chargeback or ACH return

            - 0: Open (chargebacks only)
            - 1: Pending (chargebacks only)
            - 2: Closed-Won (chargebacks only)
            - 3: Closed-Lost (chargebacks only)
            - 4: ACH Return (ACH only)
            - 5: ACH Dispute, Not Authorized (ACH only)
        Method:
          type: string
          description: 'Type of payment vehicle: **ach** or **card**.'
        CreatedAt:
          description: Timestamp when the register was created, in UTC.
          $ref: '#/components/schemas/CreatedAt'
        ReplyBy:
          $ref: '#/components/schemas/Replyby'
        PaymentTransId:
          type: string
          description: ReferenceId of the transaction in Payabli.
        ScheduleReference:
          type: integer
          format: int64
          description: Reference to the subscription originating the transaction.
        OrderId:
          $ref: '#/components/schemas/OrderId'
        NetAmount:
          description: Net amount in chargeback or ACH return.
          $ref: '#/components/schemas/Netamountnullable'
        TransactionTime:
          $ref: '#/components/schemas/TransactionTime'
        Customer:
          $ref: '#/components/schemas/QueryTransactionPayorData'
        PaymentData:
          $ref: '#/components/schemas/QueryPaymentData'
        PaypointLegalname:
          description: The paypoint's legal name.
          $ref: '#/components/schemas/Legalname'
        PaypointDbaname:
          description: The paypoint's DBA name.
          $ref: '#/components/schemas/Dbaname'
        ParentOrgName:
          $ref: '#/components/schemas/OrgParentName'
        ParentOrgId:
          type: integer
          format: int64
          description: The ID of the parent organization.
        PaypointEntryname:
          description: The paypoint's entryname.
          $ref: '#/components/schemas/Entrypointfield'
        Responses:
          type: array
          items:
            $ref: '#/components/schemas/ChargeBackResponse'
          description: Chargeback response records.
        Transaction:
          $ref: '#/components/schemas/TransactionQueryRecords'
        externalPaypointID:
          $ref: '#/components/schemas/ExternalPaypointId'
        pageidentifier:
          $ref: '#/components/schemas/PageIdentifier'
        messages:
          type: array
          items:
            $ref: '#/components/schemas/ChargebackMessage'
          description: Messages related to the chargeback.
        ServiceGroup:
          type: string
          description: Service group classification.
        DisputeType:
          type: string
          description: Type of dispute classification.
        ProcessorName:
          type: string
          description: Name of the payment processor.
  responses:
    BadRequestError:
      description: Bad request / invalid data.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayabliErrorBody'
          example:
            isSuccess: false
            responseCode: 6000
            responseText: Error
            responseData:
              explanation: <Error Explanation>
              todoAction: <Error Solution>
    UnauthorizedError:
      description: Unauthorized request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayabliErrorBody'
          example:
            isSuccess: false
            responseText: Api token was not provided
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayabliErrorBody'
          example:
            isSuccess: false
            responseText: Internal api error
    ServiceUnavailableError:
      description: Database connection error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayabliErrorBody'
          example:
            isSuccess: false
            responseText: 'Error: Unable to establish connection to database'
    BadRequestAuthResponseErrorV2:
      description: Bad request error for v2 Money In auth endpoint (HTTP 400). Returned when request validation fails. Follows RFC 7807 Problem Details format with Payabli-specific unified response codes. See the [Pay In unified response codes reference](/developers/references/pay-in-unified-response-codes-reference) for the complete list of codes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2BadRequestError'
    DeclinedAuthResponseErrorV2:
      description: Auth or sale decline error for v2 Money In endpoints (HTTP 402). Returned when an authorization or sale operation is declined for a transaction. Uses unified response codes starting with 'D'. See the [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for the complete list of codes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2DeclinedTransactionResponseWrapper'
    InternalServerResponseErrorV2:
      description: Internal server error for v2 Money In endpoints (HTTP 500). Returned when an unexpected error occurs. Follows RFC 7807 Problem Details format.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2InternalServerError'
    BadRequestCaptureResponseErrorV2:
      description: Bad request error for v2 Money In capture endpoint (HTTP 400). Returned when request validation fails. Follows RFC 7807 Problem Details format with Payabli-specific unified response codes. See the [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for the complete list of codes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2BadRequestError'
    DeclinedCaptureResponseErrorV2:
      description: Capture decline error for v2 Money In endpoints (HTTP 402). Returned when a capture operation is declined for a transaction. Uses unified response codes starting with 'D'. See the [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for the complete list of codes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2DeclinedTransactionResponseWrapper'
    BadRequestRefundResponseErrorV2:
      description: Bad request error for v2 Money In refund endpoint (HTTP 400). Returned when request validation fails. Follows RFC 7807 Problem Details format with Payabli-specific unified response codes. See the [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for the complete list of codes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2BadRequestError'
    DeclinedRefundResponseErrorV2:
      description: Refund decline error for v2 Money In endpoints (HTTP 402). Returned when a refund operation is declined for a transaction. Uses unified response codes starting with 'D'. See the [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for the complete list of codes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2DeclinedTransactionResponseWrapper'
    BadRequestVoidResponseErrorV2:
      description: Bad request error for v2 Money In void endpoint (HTTP 400). Returned when request validation fails. Follows RFC 7807 Problem Details format with Payabli-specific unified response codes. See the [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for the complete list of codes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2BadRequestError'
    DeclinedVoidResponseErrorV2:
      description: Void decline error for v2 Money In endpoints (HTTP 402). Returned when a void operation is declined for a transaction. Uses unified response codes starting with 'D'. See the [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for the complete list of codes.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2DeclinedTransactionResponseWrapper'
    ForbiddenError:
      description: Consent error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayabliErrorBody'
          example:
            isSuccess: false
            pageIdentifier: null
            responseCode: 6002
            responseData:
              explanation: The request has failed because the user hasn't consented to communications
              todoAction: The customer must complete the opt-in process
            responseText: Error
  securitySchemes:
    APIKeyAuth:
      type: apiKey
      in: header
      name: requestToken