Criar Cliente

post

https://api.toktus.com/api/v1/customers/

Cadastra um cliente (customer) no gateway selecionado. O externalId retornado identifica o cliente no gateway e deve ser utilizado em cobranças e assinaturas.

Campos obrigatórios: gateway, name, email
Campos recomendados: document (CPF/CNPJ), phone

Asaas: O cadastro prévio do cliente é obrigatório para processar cobranças. Nos demais gateways (incluindo Pagar.me), o cliente pode ser criado automaticamente junto à cobrança.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

gateway

string

enum

Identificador do gateway de pagamento:

stripe — Gateway internacional com APIs modernas
pagarme — Gateway brasileiro com boa documentação
asaas — Focado em cobranças recorrentes e boletos
mercadopago — Maior gateway da América Latina
pagseguro — Gateway tradicional do Brasil (PagBank)

Allowed:

name

string

required

length between 3 and 100

Nome completo do cliente

string

required

length between 5 and 100

E-mail do cliente

document

string

length between 11 and 14

^[0-9]+$

CPF (11 dígitos) ou CNPJ (14 dígitos), somente números

phone

string

length between 10 and 11

^[0-9]+$

Telefone com DDD (somente números)

address

object

Endereço do cliente. Opcional para cartão de crédito, recomendado para boleto.

metadata

object

Metadados adicionais vinculados ao cliente (pares chave-valor)

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Default Response