> ## Documentation Index
> Fetch the complete documentation index at: https://yn-c9bb3266.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List Recipients

> Returns a list of payout recipients. Requires `merchant_recipient_id` query parameter.

<Note>
  The `merchant_recipient_id` query parameter is **required** when listing recipients.
</Note>


## OpenAPI

````yaml GET /v1/recipients
openapi: 3.1.0
info:
  title: Yuno Payments API
  description: >-
    Yuno payment orchestration platform — unified REST API for payments,
    checkout sessions, customers, payment methods, subscriptions, payouts,
    marketplace transfers, and banking connectivity across Latin America.
  version: 1.0.0
  contact:
    name: Yuno Support
    email: support@y.uno
    url: https://docs.y.uno
  license:
    name: Proprietary
    url: https://y.uno
servers:
  - url: https://api-sandbox.y.uno
    description: Sandbox
  - url: https://api.y.uno
    description: Production
security:
  - publicApiKey: []
    privateSecretKey: []
paths:
  /v1/recipients:
    get:
      tags:
        - Recipients
      summary: List recipients
      description: >-
        Returns a list of payout recipients. Requires `merchant_recipient_id`
        query parameter.
      operationId: listRecipients
      parameters:
        - name: merchant_recipient_id
          in: query
          required: true
          description: The merchant-assigned recipient identifier to filter by
          schema:
            type: string
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
            maximum: 100
          description: Maximum number of results to return
        - name: starting_after
          in: query
          schema:
            type: string
          description: >-
            Cursor for forward pagination. Pass the ID of the last item from the
            previous page.
        - name: ending_before
          in: query
          description: Cursor for backward pagination
          schema:
            type: string
      responses:
        '200':
          description: List of recipients
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Recipient'
components:
  schemas:
    Recipient:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: d1e2f3a4-b5c6-7d8e-9f0a-1b2c3d4e5f6a
        merchant_recipient_id:
          type: string
          example: seller-001
        country:
          type: string
          example: BR
        name:
          type: string
          example: Carlos Oliveira
        email:
          type: string
          format: email
          example: carlos@example.com
        document:
          $ref: '#/components/schemas/CustomerDocument'
        bank_account:
          type: object
          properties:
            bank_code:
              type: string
              example: '001'
            account_number:
              type: string
              example: 12345-6
            account_type:
              type: string
              example: CHECKING
        created_at:
          type: string
          format: date-time
          example: '2026-03-01T09:00:00.000Z'
      example:
        id: d1e2f3a4-b5c6-7d8e-9f0a-1b2c3d4e5f6a
        merchant_recipient_id: seller-001
        country: BR
        name: Carlos Oliveira
        email: carlos@example.com
        document:
          document_type: CPF
          document_number: '98765432100'
        bank_account:
          bank_code: '001'
          account_number: 12345-6
          account_type: CHECKING
        created_at: '2026-03-01T09:00:00.000Z'
    CustomerDocument:
      type: object
      description: >-
        Customer's identification document. Both fields are required when the
        `document` object is sent. Yuno does not enforce a fixed enum on
        `document_type`; pass the local code expected by the destination payment
        method.
      required:
        - document_type
        - document_number
      properties:
        document_type:
          type: string
          minLength: 3
          maxLength: 6
          description: >-
            Type of identification document. Common values per country: Brazil —
            `CPF` (individuals), `CNPJ` (businesses); Colombia — `CC`, `CE`,
            `NIT`, `PP`, `TI`; Mexico — `CURP`, `RFC`; Argentina — `DNI`,
            `CUIT`, `CUIL`; Chile — `RUT`, `RUN`; Peru — `DNI`, `RUC`; Uruguay —
            `CI`, `RUT`; United States — `SSN`; international — `PASSPORT`. See
            the [Country Reference](/reference/country-reference) for the
            document required by each payment method.
          example: CPF
        document_number:
          type: string
          minLength: 3
          maxLength: 40
          description: >-
            Document number, digits only, no separators or formatting. Length
            depends on the document type (CPF: 11 digits, CNPJ: 14 digits, CURP:
            18 chars, RFC: 12-13 chars, DNI-AR: 7-8 digits).
          example: '12345678901'
      example:
        document_type: CPF
        document_number: '12345678901'
  securitySchemes:
    publicApiKey:
      type: apiKey
      in: header
      name: public-api-key
      description: Your public API key from the Yuno Dashboard
    privateSecretKey:
      type: apiKey
      in: header
      name: private-secret-key
      description: Your private secret key (server-side only)

````