PayZu CellTitulares

Consultar um titular

GET/v1/customers/{id}

Path Params

idstringobrigatório
ID do titular.

Headers

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

Responses

200Titular encontrado
idstringIdentificador do titular.
environmentstringAmbiente do dado: produção ou testes.
LIVETEST
partnerIdstring | 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.
ACTIVEBLOCKED
lineCountintegerLinhas 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.
createdAtstringData e hora do registro.
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.
404Titular não encontrado
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.

Linguagem

Credenciais Bearer

Token de API

curl --request GET \     --url https://api.payzucell.com.br/v1/customers/{id} \     --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