PayZu GatewayClientes e cartões

Cadastrar um cliente


Nesta páginaEnvie os dados do clienteCamposErros desta operação

O cadastro retorna o id que identifica o cliente nas faturas e nas assinaturas.

Envie os dados do cliente

bash
curl -X POST https://api.sandbox.payzu.dev/v1/customers \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5b1e7c2a-8d4f-4a3b-9e6c-2f1a0b9c8d7e" \
  -d '{
    "name": "Maria Souza",
    "email": "maria@exemplo.com.br",
    "phone": "11987654321",
    "birthdate": "1990-05-20",
    "document": "52998224725",
    "document_type": "cpf",
    "address": {
      "street": "Avenida Paulista",
      "number": "1000",
      "complement": "Sala 12",
      "district": "Bela Vista",
      "city": "São Paulo",
      "state": "SP",
      "zip_code": "01310100",
      "country": "BR"
    },
    "metadata": { "internal_id": "1234" }
  }'

Referência: Criar um cliente

O documento de um cliente excluído reativa esse cliente.

A resposta é 201 com o mesmo id. Os campos enviados substituem os gravados, o endereço gravado fica quando address não vem, e os cartões salvos não voltam.

Campos

CampoRegraObrigatório
nameDe 1 a 120 caracteres.Sim
emailE-mail válido.Sim
documentCPF ou CNPJ válido, único na conta. Só os dígitos são guardados.Sim
document_typecpf ou cnpj.Sim
phoneDDD e número, com 11 dígitos.Não
birthdateData no formato AAAA-MM-DD, até o dia de hoje.Não
addressO endereço do cliente, que vai com a cobrança no cartão. Os campos estão na aba Endereço.Não
metadataDados do seu sistema, como explica Metadados.Não

Campo fora destas tabelas, na raiz ou em address, responde 400. A Idempotency-Key é opcional: com ela, repetir a mesma chamada em até 24 horas retorna a primeira resposta. Veja Idempotência.

Erros desta operação

CódigoHTTPMensagem
PZ700409Já existe um cliente com este documento.

Os erros de autenticação, de idempotência e de validação estão no Catálogo de erros.