PayZu GatewayClientes

Listar os clientes

GET/v1/customers

Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/look-up-customers


Query Params

subscription_statusstring enum
Clientes com assinatura neste status.
plan_idstring
Clientes com assinatura deste plano.
searchstring
Busca no nome, no e-mail, no documento ou no celular do cliente.
cursorstring
next_cursor da página anterior, como veio.
limitintegerPadrão: 100
Itens por página; sem ele, 100.
created_fromstring
Criados a partir deste dia, no horário de Brasília.
created_tostring
Criados até este dia, no horário de Brasília.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.

Responses

200Sucesso
itemsarray of objectsItens da página.
Campos de cada item 11
idstringID do cliente.
namestringNome do cliente.
emailstringE-mail do cliente.
phonestring | nullCelular do cliente.
birthdatestring | nullData de nascimento.
documentstringCPF ou CNPJ do cliente.
document_typestringTipo do documento.
cpfcnpj
created_atstringData e hora da criação.
updated_atstringData e hora da última alteração.
addressobject | nullEndereço; nulo sem endereço.
Campos do objeto 8
streetstringLogradouro.
numberstring | nullNúmero do endereço.
complementstring | nullComplemento.
districtstringBairro.
citystringCidade.
statestringUF.
zip_codestringCEP.
countrystringPaís.
metadataobject | nullSeus dados, em chave e valor; nulo sem metadata.
next_cursorstring | nullCursor da próxima página; nulo na última.
400Requisição inválida
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
fieldsarray of objectsCampos recusados na validação.
Campos de cada item 2
namestringCaminho do campo recusado.
messagestringMotivo da recusa.
401Chave ausente ou inválida
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
403Acesso negado
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
500Erro interno
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
request_idstringID da chamada, para o suporte.

Linguagem

Credenciais Bearer

Token de API

curl --request GET \     --url https://api.sandbox.payzu.dev/v1/customers \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json