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

# Lista receivers



## OpenAPI

````yaml GET /receivers
openapi: 3.1.0
info:
  title: Astron Pay API
  version: 1.0.0
  description: >-
    API B2B para integração de câmbio crypto ↔ BRL via PIX. Autentique com
    `x-api-key` + `x-api-secret`.
  contact:
    name: Astron Pay
    url: https://astronpay.co
    email: dev@astronpay.co
servers:
  - url: https://api.astronpay.co/api/v1
    description: Production
security:
  - apiKey: []
    apiSecret: []
  - bearerAuth: []
tags:
  - name: Fee Tiers
    description: Consulta e atualização das taxas do merchant.
  - name: Receivers
    description: CRUD, KYC, limites e wallet signing dos receivers.
  - name: Quote
    description: Cotações de payin e payout.
  - name: Payin
    description: Ordens de entrada (BRL → crypto).
  - name: Payout
    description: Ordens de saída (crypto → BRL).
  - name: Orders
    description: Consulta genérica de ordens.
  - name: Merchant Wallet
    description: Assinatura de transações com a wallet gerenciada do merchant.
  - name: Ledger
    description: Saldos, entries e liquidações.
  - name: Webhook Config
    description: Configuração de webhook e listagem de eventos.
paths:
  /receivers:
    get:
      tags:
        - Receivers
      summary: Lista receivers do merchant
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
            maximum: 100
        - name: status
          in: query
          schema:
            type: string
            enum:
              - PENDING
              - ACTIVE
              - SUSPENDED
              - BLOCKED
        - name: kycStatus
          in: query
          schema:
            type: string
            enum:
              - PENDING
              - SUBMITTED
              - UNDER_REVIEW
              - APPROVED
              - REJECTED
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  receivers:
                    type: array
                    items:
                      $ref: '#/components/schemas/Receiver'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
components:
  schemas:
    Receiver:
      type: object
      required:
        - id
        - merchantId
        - type
        - name
        - document
        - documentType
        - status
        - kycStatus
        - createdAt
      properties:
        id:
          type: string
          format: uuid
        merchantId:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - PF
            - PJ
        name:
          type: string
          example: João Silva
        email:
          type: string
          format: email
          nullable: true
        phone:
          type: string
          nullable: true
          example: '+5511999999999'
        document:
          type: string
          example: '12345678901'
        documentType:
          type: string
          enum:
            - CPF
            - CNPJ
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - SUSPENDED
            - BLOCKED
        kycStatus:
          type: string
          enum:
            - PENDING
            - SUBMITTED
            - UNDER_REVIEW
            - APPROVED
            - REJECTED
        limits:
          $ref: '#/components/schemas/ReceiverLimits'
        walletAddress:
          type: string
          nullable: true
          example: 4k5d...Solana
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Pagination:
      type: object
      properties:
        page:
          type: integer
          example: 1
        pageSize:
          type: integer
          example: 20
        total:
          type: integer
          example: 147
        totalPages:
          type: integer
          example: 8
    ReceiverLimits:
      type: object
      properties:
        dailyLimitBrl:
          type: number
          example: 50000
        dailyTransactionLimit:
          type: integer
          example: 20
        nightTransactionsEnabled:
          type: boolean
          example: false
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
    apiSecret:
      type: apiKey
      in: header
      name: x-api-secret
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````