PayZu CellTitulares
Listar os titulares
GET/v1/customers
Requisições recentes
Query Params
cursorstring
Cursor retornado em nextCursor da página anterior; vazio vale como ausente.
limitintegerPadrão: 20
Quantidade de itens por página.
searchstring
Nome, e-mail ou documento.
documentstring
CPF ou CNPJ inteiro, com ou sem máscara.
statusstring enum
Situação do titular.
ACTIVEBLOCKEDsortstring enumPadrão: created-desc
Ordem por data de cadastro ou por nome; o cursor vale só para a ordem que o gerou.
Headers
Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.
Responses
200Lista de titulares
dataarray of objectsItens da página.
Campos de cada item 11
idstringIdentificador do titular.
environmentstringAmbiente do dado: produção ou testes.
LIVETESTpartnerIdstring | nullID do integrador dono do titular.
documentstringCPF ou CNPJ, sem máscara; CNPJ alfanumérico com letras em maiúscula.
namestringNome do titular.
emailstringE-mail do titular.
phonestring | nullTelefone de contato.
statusstringSituação do titular.
ACTIVEBLOCKEDlineCountintegerLinhas do titular, sem contar a compra que espera o pagamento ou venceu sem ele.
documentVerifiedAtstring | nullQuando o documento foi conferido na Receita; nulo = não conferido.
createdAtstringInstante ISO 8601 com fuso.
nextCursorstring | nullCursor da próxima página; nulo na última.
400Requisição inválida
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
401Chave ausente ou inválida
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
403Acesso negado
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
Esta página ajudou?