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

# List recipients



## OpenAPI

````yaml /api-reference/openapi.json get /v1/recipients
openapi: 3.1.0
info:
  title: Chipper Platform API
  version: '2026-02-20'
  description: >-
    Payouts, collections, and FX across African rails — bank, mobile money, and
    stablecoins — through one API.
servers:
  - url: https://sandbox-api.platform.chipper.ai
    description: Sandbox (sk_test_ keys — simulated rails, no real money)
  - url: https://api.platform.chipper.ai
    description: Production (sk_live_ keys)
security:
  - bearerAuth: []
paths:
  /v1/recipients:
    get:
      tags:
        - Recipients
      summary: List recipients
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            description: Page size, 1–100.
            example: 20
          required: false
          name: limit
          in: query
        - schema:
            type: string
            description: The `nextCursor` from the previous page.
          required: false
          name: cursor
          in: query
        - schema:
            type: string
            description: Filter by payment method code.
            example: gh_mtn
          required: false
          name: code
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          required: false
          name: isActive
          in: query
      responses:
        '200':
          description: Newest first.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Recipient'
                  hasMore:
                    type: boolean
                  nextCursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Pass as `cursor` to fetch the next page. Null on the last
                      page.
                required:
                  - data
                  - hasMore
                  - nextCursor
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: unauthorized
                message: Invalid API key
                requestId: req_q7vei435zifs51ia0lqr
      security:
        - bearerAuth: []
components:
  schemas:
    Recipient:
      type: object
      properties:
        id:
          type: string
          example: rcp_x7kd92mfn3qp8wz4t6vb
        accountName:
          type: string
          description: Validated account-holder name where available.
          example: Ama Serwaa
        label:
          type:
            - string
            - 'null'
          description: Your own display label.
          example: Supplier — Accra
        code:
          type: string
          description: Payment method code from the capabilities catalog.
          example: gh_mtn
        accountNumber:
          type: string
          description: Fiat recipients only.
          example: '233559630374'
        address:
          type: string
          description: Crypto recipients only.
          example: 9aE4gcS3…
        tag:
          type: string
          description: Memo/tag for chains that require one (Stellar, Ripple).
        country:
          type: string
          example: GH
        currency:
          type: string
          example: GHS
        isActive:
          type: boolean
        createdAt:
          type: string
          format: date-time
          example: '2026-08-01T09:12:44.000Z'
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - accountName
        - label
        - code
        - country
        - currency
        - isActive
        - createdAt
        - updatedAt
    Error:
      type: object
      properties:
        error:
          type: string
          description: Stable machine-readable code.
        message:
          type: string
          description: Human-readable explanation.
        requestId:
          type: string
          description: Echoed in the x-request-id response header — quote it to support.
      required:
        - error
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `sk_test_…` (sandbox) or `sk_live_…` (production).'

````