Referência

Clientes

Cadastro de pagadores reaproveitado em cobranças e assinaturas.

GET/v1/customers

Lista clientes

Escopo charges.read

Parâmetros de consulta

page

inteiroPágina (começa em 1).

pageSize

inteiro ≤ 200Itens por página (padrão 25).

POST/v1/customers

Cria cliente

Escopo charges.create

Corpo (JSON)

nameobrigatório

stringNome ou razão social.

document

CPF/CNPJValidado.

e-mailE-mail.

phone

stringTelefone com DDD.

externalId

string ≤ 120Seu identificador.

metadata

objetoPares chave/valor (string, número ou booleano). Chaves até 40 caracteres.

GET/v1/customers/:id

Consulta cliente

Escopo charges.read