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

# Listar recebedores



## OpenAPI

````yaml /api-reference/openapi.yaml get /recipients
openapi: 3.0.3
info:
  title: API Beehive Pay
  version: 1.0.0
  description: >
    API pública da Beehive Pay para criar e gerenciar transações, clientes,
    reembolsos,

    transferências, recebedores, contas bancárias, saldo, empresa, Payment
    Links.


    Autenticação:

    - Basic Authorization (ex.: "Basic base64(SECRET_KEY:x)")

    - ou x-api-key (se habilitado no seu gateway)
servers:
  - url: https://api.conta.paybeehive.com.br/v1
    description: Produção
security:
  - basicAuth: []
  - apiKeyAuth: []
tags:
  - name: transactions
    x-group: Transações
    description: Criação e consulta de transações (cartão, Pix e boleto).
  - name: refunds
    x-group: Reembolsos
    description: Estornos/reembolsos de transações.
  - name: customers
    x-group: Clientes
    description: Criação e consulta de clientes.
  - name: transfers
    x-group: Transferências
    description: Criação e consulta de transferências.
  - name: balance
    x-group: Saldo
    description: Consulta de saldo.
  - name: recipients
    x-group: Recebedores
    description: Criação e consulta de recebedores.
  - name: bank-accounts
    x-group: Contas Bancárias
    description: Adição e consulta de contas bancárias.
  - name: company
    x-group: Empresa
    description: Dados e atualização de dados da empresa.
  - name: payment-links
    x-group: Links de Pagamento
    description: Criação e atualização de payment links.
  - name: webhooks
    x-group: Webhooks
    description: Modelo de payloads de eventos enviados via webhook/postback.
paths:
  /recipients:
    get:
      tags:
        - recipients
      summary: Listar recebedores
      operationId: listRecipients
      responses:
        '200':
          description: Lista de recebedores
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Recipient'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    Recipient:
      allOf:
        - $ref: '#/components/schemas/RecipientCreateRequest'
        - type: object
          properties:
            id:
              type: integer
              example: 916
            companyId:
              type: integer
              example: 287
            tenantId:
              type: integer
              example: 1
            createdAt:
              type: string
              example: '2025-12-04T04:33:10.000Z'
            transferSettings:
              type: object
              description: >-
                Configurações retornadas pelo sistema (podem incluir campos
                adicionais).
              additionalProperties: true
            balance:
              type: object
              description: Resumo de saldo do recebedor (pode variar por ambiente).
              additionalProperties: true
    RecipientCreateRequest:
      type: object
      required:
        - legalName
        - document
        - transferSettings
        - bankAccount
      properties:
        legalName:
          type: string
          description: Razão social / nome legal do recebedor (obrigatório).
          maxLength: 50
          example: netero isaac
        email:
          type: string
          format: email
          description: Email do recebedor (opcional).
          example: financeiro@lojaabc.com
        document:
          $ref: '#/components/schemas/Document'
        transferSettings:
          $ref: '#/components/schemas/RecipientTransferSettingsRequest'
          description: Regras de transferência/antecipação do recebedor.
        bankAccount:
          $ref: '#/components/schemas/RecipientBankAccountRequest'
          description: Dados bancários do recebedor.
    Error:
      type: object
      properties:
        message:
          type: string
          example: Invalid request
        code:
          type: string
          example: bad_request
        details:
          type: object
          additionalProperties: true
    Document:
      type: object
      properties:
        number:
          type: string
          example: '12345678909'
        type:
          type: string
          example: cpf
    RecipientTransferSettingsRequest:
      type: object
      required:
        - transferEnabled
        - automaticAnticipationEnabled
        - anticipatableVolumePercentage
      properties:
        transferEnabled:
          type: boolean
          description: Transferência habilitada.
          example: true
        automaticAnticipationEnabled:
          type: boolean
          description: Antecipação automática habilitada.
          example: true
        anticipatableVolumePercentage:
          type: integer
          format: int32
          description: Percentual do volume antecipável (inteiro).
          minimum: 0
          maximum: 100
          example: 2
    RecipientBankAccountRequest:
      type: object
      required:
        - bankCode
        - agencyNumber
        - accountNumber
        - accountDigit
        - type
        - legalName
        - documentNumber
        - documentType
      properties:
        bankCode:
          type: string
          description: Código do banco.
          example: '341'
        agencyNumber:
          type: string
          description: Número da agência.
          example: '1234'
        accountNumber:
          type: string
          description: Número da conta.
          example: '123456'
        accountDigit:
          type: string
          description: Dígito da conta.
          example: '7'
        type:
          type: string
          description: Tipo da conta.
          enum:
            - conta_corrente
            - conta_poupanca
          example: conta_corrente
        legalName:
          type: string
          description: Razão social / nome do titular da conta bancária.
          maxLength: 50
          example: minhalojinha
        documentNumber:
          type: string
          description: >-
            CPF/CNPJ do titular da conta bancária (normalmente o mesmo do
            recebedor).
          example: '12345678909'
        documentType:
          type: string
          description: Tipo do documento do titular.
          enum:
            - cpf
            - cnpj
          example: cpf
  responses:
    Unauthorized:
      description: Não autorizado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Erro interno
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Basic Authorization usando SECRET_KEY como usuário e "x" como senha.
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Header x-api-key (se habilitado).

````