Criar Cliente | Dom Docs

Endpoint: POST https://{apiUrl}/customers

Toda cobrança criada na Dom Pagamentos está vinculada a um cliente. Use este endpoint para cadastrar novos clientes que poderão receber cobranças, criar assinaturas ou realizar pagamentos via PIX.

Parâmetros

POSThttps://{apiUrl}/customers

URL base da API

Token de autenticação

Body Params

namestringrequired

Nome completo do cliente (máx. 80 caracteres)

emailemailrequired

E-mail único por conta (máx. 80 caracteres)

documentstringrequired

CPF ou CNPJ (máx. 14 caracteres)

document_typestringrequired

"CPF" ou "CNPJ"

mobile_phonestringrequired

DDD + número, ex: 48999999999

code_externalstringoptional

Código de referência externo (máx. 80 caracteres)

genderstringoptional

"male", "female" ou "other"

birthdatedateoptional

Data de nascimento no formato YYYY-MM-DD

addressobjectoptional

Endereço do cliente (street, number, neighborhood, zip_code, city, state)

curl --request POST \
  --url "https://{apiUrl}/customers" \
  --header "Content-Type: application/json" 
  --data '{}'

Response

Choose an example:

application/json

E-mail único

O campo email é único por conta. Caso seja requisitada a criação de um cliente com um e-mail já cadastrado, a API retorna o erro EMAIL_EXIST junto com o id do cliente existente.

json

{
  "status": "FAIL",
  "error": "EMAIL_EXIST",
  "id": "abc-123-..."
}

Objeto `address`

Campo	Tipo	Descrição
`street`	string	Nome da rua/avenida
`number`	string	Número do endereço
`neighborhood`	string	Bairro
`zip_code`	string	CEP (somente números)
`city`	string	Cidade
`state`	string	UF (sigla com 2 letras)

Exemplo de resposta

json

{
  "id": "4bfc6124-ceee-4f6f-9f29-75059b3f5d9c",
  "name": "João da Silva",
  "email": "joao@dopagamentos.com",
  "document": "11111111111",
  "document_type": "CPF",
  "status": "active",
  "created_at": "2024-10-01T15:36:00Z"
}

Responses

Exemplo de requisição

curl --request POST \
  --url "https://{apiUrl}/customers" \
  --header "Authorization: Bearer {token}" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "João da Silva",
    "email": "joao@exemplo.com",
    "document": "11111111111",
    "document_type": "CPF",
    "mobile_phone": "48999999999"
  }'

Parâmetros

E-mail único

Objeto address

Exemplo de resposta

Exemplo de requisição

Objeto `address`