Pular para o conteúdo principal

Listar pagadores

GET/api/payers

Retorna os pagadores cadastrados e vinculados à sua conta.

Parâmetros da URL (Query Params)​

NomeTipoDescriçãoObrigatório
limitnumberQuantidade máxima de pagadores retornados por requisiçãoSim
cursorstringCursor para paginação. Deve ser informado somente para buscar a próxima página de resultados.Não

Paginação por cursor​

A listagem utiliza paginação baseada em cursor para garantir desempenho e consistência. Na primeira requisição, informe apenas o limit. A resposta retornará a lista de pagadores e indicará se existem mais registros por meio do campo hasNext. Se hasNext for true, utilize o valor de nextCursor na próxima requisição.

Exemplos de requisição​

  • /api/payers?limit=10
  • /api/payers?limit=10&cursor=019ae060-0b50-74bf-bfc6-fe2b78427391

Exemplo de resposta​

{
  "hasNext": false,
  "nextCursor": null,
  "payers": [
    {
      "id": "019ae095-cd95-77ea-bc11-2a123b1eff40",
      "name": "Empresa de pagamentos",
      "cnpj": "00000000000000",
      "phone": "00000000000",
      "email": "pagamentos@mail.com",
      "fullAddress": "Rua da Jóia, Nº883, Empresa azul",
      "neighborhood": "Rochdale",
      "zipcode": "06220250",
      "city": "São Paulo",
      "uf": "SP"
    }
  ]
}