> ## Documentation Index > Fetch the complete documentation index at: https://docs.z2pay.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar recebedores > Lista paginada dos recebedores vinculados à sua conta, com filtro por e-mail ou documento. `GET /recipients` Faz parte do recurso [recebedores](/pt-BR/recipients) — os conceitos e o objeto estão lá. Retorna a lista paginada dos recebedores vinculados à sua conta. Apenas recebedores do tipo merchant aparecem aqui. **Os dois filtros são exatos, e combiná-los é restritivo.** `email` exige o endereço completo e `document` o CPF/CNPJ como foi cadastrado — valores parciais não retornam nada. Se você informar os dois e eles apontarem para recebedores diferentes, a lista volta **vazia**, em vez de trazer os dois. ## Exemplo ```bash theme={null} curl -G https://api.sandbox.z2pay.com/v1/recipients -H "x-api-key: SUA_CHAVE_DE_SANDBOX" --data-urlencode "limit=10" ``` ```json theme={null} { "data": [ { "id": "rec_v57bi6ruyolouw3cpaq2ofy1k", "name": "Loja do João ME", "email": "contato@lojadojoao.com.br", "document": "12345678000190", "type": "company", "phone": "+5511999998888", "status": "active", "role": "seller", "defaultBankAccount": { "id": "rba_nub9kaa2xd5ptruubjel1w65z", "bankCode": "341", "bankName": "Itaú", "bankAgency": "1234", "bankAccount": "56789", "bankAccountDigit": "0", "bankHolderName": "Loja do João ME", "bankHolderDocument": "12345678000190" }, "createdAt": "2026-06-01T13:00:00.000Z", "updatedAt": "2026-06-10T09:30:00.000Z" } ], "pagination": { "page": 1, "limit": 10, "total": 1, "totalPages": 1 } } ``` ## OpenAPI ````yaml openapi/psp.json GET /recipients openapi: 3.0.3 info: title: Z2Pay PSP API version: 1.0.0 description: API pública do PSP — autenticação via API Key (Credential) servers: - url: https://api.sandbox.z2pay.com/v1 description: Sandbox - url: https://api.z2pay.com/v1 description: Produção security: [] tags: - name: Cards description: Cartões salvos de um cliente - name: Chargebacks description: Gerenciamento de chargebacks - name: Customers description: Gerenciamento de clientes (compradores) - name: Fees description: Tabela de taxas da conta (pix, boleto, cartão, saque, refund, chargeback) - name: Recipients description: Gerenciamento de recebedores (sellers/merchants que recebem repasses) - name: Refunds description: Gerenciamento de reembolsos e estornos - name: Splits description: Regras de divisão do valor de uma venda entre recebedores - name: Transactions description: Gerenciamento de transações e payments - name: Wallets description: Saldo, extrato e resumo da carteira de um recebedor, agrupados por moeda - name: Webhooks description: Configuração, gerenciamento e histórico de entregas de webhooks - name: Withdrawals description: Solicitação e acompanhamento de saques (payouts) por recipient paths: /recipients: get: tags: - Recipients summary: Listar recebedores description: >- Retorna lista paginada de recipients da company, com filtros opcionais por email/document operationId: RecipientController_list parameters: - name: page in: query required: false description: 'Página da listagem. Padrão: 1.' schema: type: integer minimum: 1 default: 1 description: 'Página da listagem. Padrão: 1.' - name: limit in: query required: false description: 'Itens por página. Padrão: 20. Máximo: 100.' schema: type: integer minimum: 1 maximum: 100 default: 20 description: 'Itens por página. Padrão: 20. Máximo: 100.' - name: email in: query required: false description: >- E-mail do recebedor. Correspondência exata, um valor por requisição — envie o endereço completo. schema: type: string format: email description: >- E-mail do recebedor. Correspondência exata, um valor por requisição — envie o endereço completo. - name: document in: query required: false description: >- CPF ou CNPJ do recebedor. Correspondência exata, um valor por requisição — envie exatamente como foi cadastrado, com ou sem pontuação. schema: type: string minLength: 11 description: >- CPF ou CNPJ do recebedor. Correspondência exata, um valor por requisição — envie exatamente como foi cadastrado, com ou sem pontuação. responses: '200': description: Lista paginada de recebedores content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string description: Identificador único do registro. name: type: string description: Nome do registro. email: type: string description: E-mail de contato. document: type: string description: Documento (CPF ou CNPJ) do titular. type: type: string description: >- Tipo do recebedor: `individual` (pessoa física) ou `company` (pessoa jurídica). role: type: string description: 'Papel do recebedor no split (ex.: seller).' status: type: string description: >- Situação da conta bancária. Valores: `active`, `inactive`, `pending`. splitValue: type: number nullable: true description: >- Valor do split do recebedor (percentual ou fixo, conforme splitType). splitType: type: string nullable: true description: >- Tipo do valor de split do recebedor (ex.: percentage, fixed). pixAntecipationDays: type: integer nullable: true description: Prazo de antecipação para PIX, em dias. bankSlipAntecipationDays: type: integer nullable: true description: Prazo de antecipação para boleto, em dias. creditCardAntecipationDays: type: integer nullable: true description: >- Prazo de antecipação para cartão de crédito, em dias. approvedAt: type: string format: date-time nullable: true description: >- Data e hora em que o recebedor foi aprovado (ISO 8601). refusedAt: type: string format: date-time nullable: true description: >- Data e hora em que o recebedor foi recusado (ISO 8601). analysisComplete: type: boolean description: >- Indica se a análise cadastral terminou. `false` enquanto houver rodada de análise aberta para este recebedor na sua conta. pendencies: type: array items: type: object description: >- Pendências apontadas pela análise. Cada item traz `code` (estável, para automação), `field`, `severity` (`blocking` ou `warning`), `status` (`open` ou `resolved`), `message` e `action` (texto traduzido) e as datas do grupo. pendenciesSummary: type: object description: >- Contagem das pendências abertas: `open` (total), `blocking` e `warning`. createdAt: type: string format: date-time description: Data e hora de criação do registro (ISO 8601). updatedAt: type: string format: date-time description: >- Data e hora da última atualização do registro (ISO 8601). description: Lista de registros retornados na página atual. pagination: type: object properties: page: type: integer description: Página atual retornada. limit: type: integer description: Quantidade de itens por página. total: type: integer description: Total de itens que atendem ao filtro. totalPages: type: integer description: Total de páginas disponíveis. description: Dados de paginação do resultado. example: data: - id: rec_gk1o75xv3ioi4eoqosorz9s62 name: Joao da Silva email: joao.silva@example.com document: '12345678901' type: individual role: seller status: active splitValue: 10 splitType: percentage pixAntecipationDays: null bankSlipAntecipationDays: null creditCardAntecipationDays: null approvedAt: '2025-06-20T14:30:00.000Z' refusedAt: null analysisComplete: true pendencies: [] pendenciesSummary: open: 0 blocking: 0 warning: 0 createdAt: '2025-06-18T09:15:00.000Z' updatedAt: '2025-06-20T14:30:00.000Z' pagination: page: 1 limit: 20 total: 1 totalPages: 1 '400': description: >- Requisição inválida — algum parâmetro ou campo do corpo não passou na validação content: application/json: schema: type: object properties: error: type: object properties: code: type: string description: >- Identificador estável do erro. É por ele que você deve ramificar, não pela mensagem. message: type: string description: >- Descrição legível. Pode mudar sem aviso e não deve ser usada em condicional. issues: type: array description: >- Um item por campo rejeitado. Nunca vem vazio: se há 400 de validação, há pelo menos um. items: type: object properties: path: type: string description: >- Campo que falhou. Vem vazio quando o erro é do corpo como um todo. message: type: string description: O que há de errado com esse campo. example: error: code: VALIDATION_ERROR message: Validation failed issues: - path: status message: >- Status inválido. Valores aceitos: pending, waiting_payment, paid, refused, canceled, refunded - path: startDate message: >- Data deve ser ISO 8601 com timezone (ex.: 2026-06-24T00:00:00Z) '401': description: Chave de API ausente, malformada ou inválida content: application/json: schema: type: object properties: error: type: object properties: code: type: string description: >- Identificador estável do erro. É por ele que você deve ramificar, não pela mensagem. message: type: string description: >- Descrição legível. Pode mudar sem aviso e não deve ser usada em condicional. example: error: code: UNAUTHORIZED message: Invalid API key security: - apiKey: [] components: securitySchemes: apiKey: type: apiKey in: header name: x-api-key description: API Key da Credential (gerada no Backoffice) ````