PayZu CellTitulares

Cadastrar um titular

POST/v1/customers

Body Params

namestringobrigatório
Nome do titular.
documentstringobrigatório
CPF ou CNPJ, com ou sem máscara.
emailstringobrigatório
E-mail; domínio com erro de digitação comum é recusado com a sugestão.
phonestringobrigatório
Celular com DDD, só dígitos (11 dígitos).
zipCodestring
CEP do titular; a API completa cidade e UF pela BrasilAPI.

Headers

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

Responses

201Titular cadastrado
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.
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.
409Conflito
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.
422Operação recusada
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.
429Limite de requisições atingido
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 POST \     --url https://api.payzucell.com.br/v1/customers \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json' \     --header 'content-type: application/json' \     --data '{}'
Resposta

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

application/json