> ## Documentation Index
> Fetch the complete documentation index at: https://docs.quentli.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List external payment types

> Returns the ways the organization records payments received outside Quentli, such as cash or bank transfer.



## OpenAPI

````yaml /openapi.yaml get /v1/external-payment-types
openapi: 3.1.0
info:
  title: Quentli REST API
  version: 1.0.0
  description: OpenAPI spec for Quentli REST endpoints.
servers:
  - url: https://api.quentli.com
    description: Production API
  - url: https://api.staging.quentli.com
    description: Staging API for production-like validation
security:
  - organizationApiKey: []
  - oauthAccessToken: []
tags:
  - name: Auth
  - name: Management
  - name: Billing
  - name: Catalog
  - name: Customers
  - name: Invoices
  - name: Payment Methods
  - name: Payment Sessions
  - name: Payments
  - name: Subscriptions
  - name: Tax Invoices
  - name: Webhooks
  - name: Messaging
paths:
  /v1/external-payment-types:
    get:
      tags:
        - Payments
      summary: List external payment types
      description: >-
        Returns the ways the organization records payments received outside
        Quentli, such as cash or bank transfer.
      operationId: external_payment_types_list
      parameters:
        - schema:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/StringFilter'
              name:
                $ref: '#/components/schemas/StringFilter'
              taxPaymentForm:
                $ref: '#/components/schemas/StringFilter'
            description: Filter fields encoded with `qs` bracket notation.
          required: false
          description: Filter fields encoded with `qs` bracket notation.
          style: deepObject
          explode: true
          name: filter
          in: query
        - schema:
            type: boolean
            default: false
            description: Whether to include archived types.
          required: false
          description: Whether to include archived types.
          name: includeArchived
          in: query
      responses:
        '200':
          description: External payment types list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExternalPaymentTypesResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
components:
  schemas:
    StringFilter:
      type: object
      properties:
        equals:
          type: string
        in:
          type: array
          items:
            type: string
        notIn:
          type: array
          items:
            type: string
        lt:
          type: string
        lte:
          type: string
        gt:
          type: string
        gte:
          type: string
        contains:
          type: string
        startsWith:
          type: string
        endsWith:
          type: string
        search:
          type: string
        not:
          $ref: '#/components/schemas/StringFilter'
      additionalProperties: false
    GetExternalPaymentTypesResponse:
      type: array
      items:
        $ref: '#/components/schemas/ExternalPaymentType'
      description: List of external payment types.
    UserError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
          required:
            - message
      required:
        - error
      additionalProperties: false
      description: Standard user-facing error response envelope.
    ExternalPaymentType:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the external payment type.
          example: ept_1234567890abcdefghij
        createdAt:
          type: string
          format: date-time
          description: When the external payment type was created.
        updatedAt:
          type: string
          format: date-time
          description: When the external payment type was last updated.
        organizationId:
          type: string
          description: Organization that owns the external payment type.
        name:
          type: string
          description: Name of the external payment type.
          example: Transferencia bancaria
        taxPaymentForm:
          type:
            - string
            - 'null'
          description: SAT payment form code used on tax invoices.
          example: '03'
        editable:
          type: boolean
          description: Whether the external payment type can be edited.
        archivedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When the external payment type was archived, if applicable.
        createdById:
          type:
            - string
            - 'null'
          description: User who created the external payment type.
        updatedById:
          type:
            - string
            - 'null'
          description: User who last updated the external payment type.
        archivedById:
          type:
            - string
            - 'null'
          description: User who archived the external payment type.
      required:
        - id
        - createdAt
        - updatedAt
        - organizationId
        - name
        - taxPaymentForm
        - editable
        - archivedAt
        - createdById
        - updatedById
        - archivedById
      description: >-
        A way of receiving payments outside Quentli, such as cash or bank
        transfer.
  securitySchemes:
    organizationApiKey:
      type: http
      scheme: bearer
      description: 'Organization API key using `Authorization: Bearer sk_...`.'
    oauthAccessToken:
      type: http
      scheme: bearer
      bearerFormat: OAuth 2.1
      description: 'OAuth access token using `Authorization: Bearer qoa_at_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.