WysePayDocs

Clientes

A carteira de clientes da conta, um por CPF ou CNPJ.

Cada cliente é identificado pelo CPF ou CNPJ: há um por documento, em cada modo (teste e produção). Ele é criado sozinho quando alguém paga ou preenche o checkout, e você também pode cadastrar e consultar pela API.

Cadastrar

POST /api/v1/customers (permissão customers:write):

curl -X POST https://api.wysepay.com.br/api/v1/customers \
  -H "x-api-key: wyp_test_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ana Souza",
    "document": "123.456.789-09",
    "email": "[email protected]",
    "phone": "11912345678",
    "address": { "zipCode": "01310-100", "number": "1000" }
  }'

Se já existe um cliente com esse CPF ou CNPJ, ele é atualizado em vez de duplicado. Campos que você não envia ficam como estavam. Um documento inválido responde 400.

Achar pelo CPF ou CNPJ

curl "https://api.wysepay.com.br/api/v1/customers?document=12345678909" \
  -H "x-api-key: wyp_test_sua_chave"

A resposta é uma lista com no máximo um cliente.

Atualizar

PATCH /api/v1/customers/{id} muda só os campos enviados. O CPF ou CNPJ não muda.

O que fica de fora

As notas internas e as tags que você escreve no painel não aparecem na API.

Nesta página