WysePayDocs

Cadastrar um cliente

POST
/api/v1/customers

Cadastra o cliente, ou atualiza o que já tem esse CPF ou CNPJ (há um cliente por documento). Campos não enviados ficam como estavam.

Permissão da chave: customers:write.

Autenticação

headerx-api-key<token>

Sua chave de API, criada no painel em Desenvolvedores → Chaves de API.

Corpo da requisição

application/json
  1. body
name*string
Tamanho2 <= length <= 120
document*string

CPF ou CNPJ, com ou sem pontuação.

Tamanho11 <= length <= 18
email?string
Formatoemail
Tamanholength <= 160
phone?string

Com DDD.

Tamanholength <= 20
address?

Corpo da resposta

O cliente.

application/json
  1. response

Um cliente, um por CPF ou CNPJ em cada modo.

id*string
name*string|null
email*string|null
phone*string|null
documentType*string
Valores aceitos"CPF""CNPJ"
document*string

Só dígitos.

address*|

null quando nenhum campo do endereço foi informado.

livemode*boolean
createdAt*string
Formato^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Formatodate-time
updatedAt*string
Formato^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Formatodate-time
curl -X POST "https://example.com/api/v1/customers" \  -H "Content-Type: application/json" \  -d '{    "name": "Ana Souza",    "document": "12345678909",    "email": "[email protected]",    "phone": "11912345678"  }'
{  "id": "cus_01k6g8m2v4x7z9b3c5d7f9h0j2",  "name": "Ana Souza",  "email": "[email protected]",  "phone": "11912345678",  "documentType": "CPF",  "document": "12345678909",  "address": {    "zipCode": "01310100",    "street": "Avenida Paulista",    "number": "1000",    "complement": "string",    "district": "Bela Vista",    "city": "São Paulo",    "state": "SP"  },  "livemode": true,  "createdAt": "2026-10-04T15:30:00.000Z",  "updatedAt": "2026-10-04T15:30:00.000Z"}

Desativar um link POST

O link para de aceitar pagamentos e o checkout mostra que ele não está disponível. Cobranças já geradas continuam valendo. Permissão da chave: `payment_links:write`.

Listar clientes GET

Os clientes da conta, do mais novo para o mais antigo. Filtre por `document` para achar um CPF ou CNPJ. Permissão da chave: `customers:read`.