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

# List external payments

> Returns a paginated list of external payments (payments recorded in Karat but settled outside of Karat).



## OpenAPI

````yaml /api-reference/openapi.json get /external-payments
openapi: 3.1.0
info:
  title: Karat Payout API
  description: >-
    Your gateway to seamless, automated, and scalable payment solutions. The
    Karat Payout API lets you create recipients, send payouts, track payment
    status, manage tax documents, record external payments, and subscribe to
    webhook events.
  version: 1.0.0
servers:
  - url: https://payouts.api.trykarat.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Payments
    description: Create and manage outgoing payouts to recipients.
  - name: Recipients
    description: Manage the payees you send payouts to.
  - name: Tax
    description: Retrieve recipient tax forms (W-9) and download links.
  - name: External Payments
    description: Record and manage payments made outside of Karat.
  - name: Webhooks
    description: Subscribe to event notifications for payout activity.
paths:
  /external-payments:
    get:
      tags:
        - External Payments
      summary: List external payments
      description: >-
        Returns a paginated list of external payments (payments recorded in
        Karat but settled outside of Karat).
      operationId: getExternalPayments
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
        - name: recipientId
          in: query
          description: Filter external payments by recipient ID.
          required: false
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: A paginated list of external payments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExternalPayment'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: Maximum number of results to return (max 100, default 100).
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 100
    Offset:
      name: offset
      in: query
      description: Number of results to skip for pagination (default 0).
      required: false
      schema:
        type: integer
        minimum: 0
        default: 0
  schemas:
    ExternalPayment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        amount:
          type: integer
          description: Amount in cents.
        description:
          type: string
          nullable: true
        date:
          type: string
          format: date
        paymentMethod:
          type: string
          nullable: true
        platform:
          type: string
          nullable: true
        receiptFileName:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        recipient:
          type: object
          properties:
            id:
              type: string
              format: uuid
            firstName:
              type: string
              nullable: true
            lastName:
              type: string
              nullable: true
            email:
              type: string
              format: email
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Total number of matching records.
        limit:
          type: integer
        offset:
          type: integer
    Error:
      type: object
      description: Standard error envelope returned for all non-2xx responses.
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
          required:
            - message
      required:
        - error
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              message: Invalid api key
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Pass your API key as a bearer token: `Authorization: Bearer <API_KEY>`.'

````