Referência da API

Cadastrar novo cliente

Para que seja possível criar uma cobrança, antes é necessário criar o cliente ao qual ela irá pertencer. Você deve utilizar o Identificador (identifier) retornado nesta requisição na criação da cobrança.

Para criar um registro, forneça um objeto JSON com os dados do seu cliente conforme os campos abaixo.

Você pode enviar apenas os campos desejados neste endpoint, conforme mostrado nos dois exemplos abaixo. No entanto, todos os campos com o atributo "required" são obrigatórios.

Exemplo 1: Cliente apenas com o nome completo e email

{
  "full_name":"John Doe",
  "email":"[email protected]"
}

Exemplo 2: Cliente apenas com o nome completo o número do celular

{
  "full_name":"John Doe",
  "cell_phone":"5583981234567"
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Nome completo
Ex: John Doe

string | null

CPF ou CNPJ do cliente.
Ex: CPF: 12345678901 | CNPJ: 12345678000190

string | null

Endereço de e-mail
Ex: [email protected]

string

Número do celular
Ex: 5583981234567

string | null

CEP do cliente
Ex: 12345678

string | null

Nome do bairro
Ex: Centro

string | null

Nome da rua
Ex: Faria Lima

string | null

Número do endereço Exemplo: 10 Alguns endereços podem conter letras no número. Nosso sistema permite a inclusão de letras neste campo. Para indicar que o endereço não possui número, defina o valor como null ou deixe fora do json.

string | null

Complemento de endereço
Ex: Apto 101

string | null

Nome da cidade
Ex: São Paulo

string | null

Sigla do estado
Ex: SP

string | null

Nome da empresa caso seja pessoa jurídica
Ex: Micro Service S.A

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json