PayZu GatewayClientes

Criar um cliente

POST/v1/customers

Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/create-a-customer


Body Params

namestringobrigatório
Nome completo.
emailstringobrigatório
E-mail.
phonestring
Celular com DDD, só números.
birthdatestring
Data de nascimento, que não pode ser futura.
documentstringobrigatório
CPF ou CNPJ, só números.
document_typestring enumobrigatório
Tipo do documento.cpfcnpj
addressobject
Endereço do cliente.
metadataobject
Seus dados, em chave e valor.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
Idempotency-Keystring
Valor único da operação, para repetir a chamada sem duplicar.
acceptstring
Formato da resposta.

Responses

201Cliente criado
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.
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.
409Conflito
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
422Operação recusada
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
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 POST \     --url https://api.sandbox.payzu.dev/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