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

# List transfer recipients

> Retrieve a paginated list of saved transfer recipients



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/bila/transfer-recipients
openapi: 3.0.0
info:
  title: Bila Payment Gateway API
  description: |-

    Bila Payment Gateway API - A payment processing API for Africa.

    ## Overview

    This API provides payment gateway functionality for:
    - **Account Management**: Manage payment accounts/wallets
    - **Bank Operations**: Access bank reference data
    - **Account Resolution**: Verify bank and mobile money accounts
    - **Transfer Recipients**: Manage saved transfer recipients
    - **Transfers (Payouts)**: Send money to bank accounts and mobile money
    - **Collections (Receive Payments)**: Collect payments via mobile money
    - **Transaction History**: View all transactions

    ## Mobile Money Providers

    - Airtel Money
    - MTN Mobile Money (MoMo)
    - Zamtel Kwacha

    ## Countries Supported

    - Zambia (zm)
    - Nigeria (ng)

    ## Authentication

    Use your merchant API key in the `x-api-key` header.
    You can generate API keys from your merchant dashboard.

    ## Base URL

    ```
    https://api.usebila.com/api/v1
    ```

    For sandbox/testing:
    ```
    https://sandbox.usebila.com/api/v1
    ```
        
  version: '2.0'
  contact: {}
servers:
  - url: https://api.usebila.com
    description: Production
  - url: https://sandbox.usebila.com
    description: Sandbox
security:
  - x-api-key: []
tags:
  - name: Accounts
    description: Account/wallet management endpoints
  - name: Banks
    description: Bank reference data endpoints
  - name: Resolve
    description: Account resolution/verification endpoints
  - name: Transfer Recipients
    description: Transfer recipient management endpoints
  - name: Transfers
    description: Payout/transfer operation endpoints
  - name: Collections
    description: Payment collection operation endpoints
  - name: Transactions
    description: Transaction history endpoints
  - name: Webhooks
    description: Webhook configuration and delivery history
paths:
  /api/v1/bila/transfer-recipients:
    get:
      tags:
        - Transfer Recipients
      summary: List transfer recipients
      description: Retrieve a paginated list of saved transfer recipients
      operationId: BilaRecipientsController_getRecipients
      parameters:
        - name: page
          required: false
          in: query
          description: 'Page number (default: 1)'
          schema:
            minimum: 1
            example: 1
            type: number
        - name: perPage
          required: false
          in: query
          description: 'Items per page (default: 50)'
          schema:
            minimum: 1
            maximum: 100
            example: 50
            type: number
        - name: type
          required: false
          in: query
          description: Filter by recipient type
          schema:
            type: string
            enum:
              - bank-account
              - mobile-money
      responses:
        '200':
          description: Recipients retrieved successfully
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/BilaResponseDto'
                  - properties:
                      data:
                        $ref: '#/components/schemas/PaginatedRecipientsResponseDto'
        '400':
          description: Bad request
      security:
        - x-api-key: []
components:
  schemas:
    BilaResponseDto:
      type: object
      properties:
        status:
          type: boolean
          description: Request success status
          example: true
        message:
          type: string
          description: Response message
          example: Operation completed successfully
      required:
        - status
        - message
    PaginatedRecipientsResponseDto:
      type: object
      properties:
        data:
          description: List of recipients
          type: array
          items:
            $ref: '#/components/schemas/RecipientResponseDto'
        meta:
          description: Pagination metadata
          allOf:
            - $ref: '#/components/schemas/PaginationMetaDto'
      required:
        - data
        - meta
    RecipientResponseDto:
      type: object
      properties:
        id:
          type: string
          description: Recipient UUID
          example: 68f11209-451f-4a15-bfcd-d916eb8b09f4
          format: uuid
        type:
          type: string
          description: Recipient type
          enum:
            - bank-account
            - mobile-money
          example: bank-account
        accountNumber:
          type: string
          description: Bank account number (bank-account only)
          example: '1234567890'
        accountName:
          type: string
          description: Account holder name
          example: John Doe
        bankId:
          type: string
          description: Bank ID (bank-account only)
          example: bank-001
        bankName:
          type: string
          description: Bank name (bank-account only)
          example: Zambia National Commercial Bank
        phone:
          type: string
          description: Phone number (mobile-money only)
          example: '0977123456'
        operator:
          type: string
          description: Mobile money operator (mobile-money only)
          example: airtel
        country:
          type: string
          description: Country code
          example: zm
        createdAt:
          type: string
          description: Creation timestamp
          example: '2024-01-15T10:30:00Z'
          format: date-time
      required:
        - id
        - type
        - accountName
        - country
        - createdAt
    PaginationMetaDto:
      type: object
      properties:
        total:
          type: number
          description: Total number of records
          example: 150
        perPage:
          type: number
          description: Items per page
          example: 50
        currentPage:
          type: number
          description: Current page number
          example: 1
        pageCount:
          type: number
          description: Total number of pages
          example: 3
      required:
        - total
        - perPage
        - currentPage
        - pageCount
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: Merchant API key (e.g., sk_live_xxx or sk_test_xxx)

````