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

# List Recipients

> Retrieve a paginated list of all payment recipients associated with your account.

Retrieve a paginated list of all payment recipients associated with your account. This endpoint supports filtering by various criteria.

## Overview

This endpoint returns all recipients you've created, with optional filtering capabilities. You can filter by account type, country, currency, account name, or account number.

## Query Parameters

<ParamField query="page" type="integer">
  Page number for pagination (default: 1)
</ParamField>

<ParamField query="per_page" type="integer">
  Number of items per page (default: 10)
</ParamField>

<ParamField query="account_type" type="string">
  Filter by account type: "individual" or "business"
</ParamField>

<ParamField query="country" type="string">
  Filter by country name
</ParamField>

<ParamField query="currency" type="string">
  Filter by currency code (e.g., "NGN", "USD")
</ParamField>

<ParamField query="account_name" type="string">
  Filter by account holder name (partial match)
</ParamField>

<ParamField query="account_number" type="string">
  Filter by account number
</ParamField>

## Response

<ResponseField name="data" type="object">
  Paginated response containing:

  * `total_pages`: Total number of pages
  * `current_page`: Current page number
  * `total_records`: Total number of recipients
  * `next_page`: URL for next page
  * `previous_page`: URL for previous page
  * `items`: Array of recipient objects
</ResponseField>

<ResponseField name="data.items[]" type="object">
  Each recipient object includes:

  * `id`: Recipient UUID
  * `account_number`: Account number
  * `account_name`: Account holder name
  * `account_type`: Account type
  * `account_currency`: Currency code
  * `account_bank_name`: Bank name
  * `account_bank_code`: Bank code
  * `limit`: Payment limit
  * `identification`: Identification information
  * `payment_details`: Payment details
  * `created_at`: Creation timestamp
  * `updated_at`: Last update timestamp
</ResponseField>


## OpenAPI

````yaml GET /payments/recipients
openapi: 3.0.0
info:
  title: Pooler Developer API
  description: >-
    Comprehensive API documentation for Pooler payment and financial services
    platform
  version: 1.0.0
servers:
  - url: https://api.usepooler.com
    description: Production server
  - url: https://sandbox.usepooler.com
    description: Sandbox server
security:
  - bearerAuth: []
paths:
  /payments/recipients:
    get:
      tags:
        - Recipients
      summary: List Recipients
      description: >-
        Retrieve a paginated list of all payment recipients associated with your
        account.
      operationId: listRecipients
      parameters:
        - name: page
          in: query
          description: Page number for pagination
          schema:
            type: integer
            default: 1
        - name: per_page
          in: query
          description: Number of items per page
          schema:
            type: integer
            default: 10
        - name: account_type
          in: query
          description: Filter by account type (individual | business)
          schema:
            type: string
            enum:
              - individual
              - business
        - name: country
          in: query
          description: Filter by country
          schema:
            type: string
        - name: currency
          in: query
          description: Filter by currency code
          schema:
            type: string
        - name: account_name
          in: query
          description: Filter by account name
          schema:
            type: string
        - name: account_number
          in: query
          description: Filter by account number
          schema:
            type: string
      responses:
        '200':
          description: Recipients retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRecipientsResponse'
components:
  schemas:
    PaginatedRecipientsResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        stan:
          type: string
          format: uuid
        data:
          $ref: '#/components/schemas/PaginatedRecipients'
    PaginatedRecipients:
      type: object
      properties:
        total_pages:
          type: integer
        current_page:
          type: integer
        total_records:
          type: integer
        next_page:
          type: string
        previous_page:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/Recipient'
    Recipient:
      type: object
      properties:
        id:
          type: string
          format: uuid
        merchant_id:
          type: string
          format: uuid
        account_number:
          type: string
        account_name:
          type: string
        account_type:
          type: string
        is_internal_account:
          type: boolean
        account_currency:
          type: string
        account_bank_name:
          type: string
        account_bank_code:
          type: string
        account_country_code:
          type: string
        account_country:
          type: string
        identification:
          type: object
        limit:
          type: string
        payment_details:
          type: object
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer token authentication. Include your API key in the Authorization
        header as: Bearer {your_api_key}

````