Criar cliente

POST /api/v1/clientes

Cria um cliente vinculado ao produtor autenticado. O CPF/CNPJ deve ser válido.

POST Requisição

bash

curl -X POST "https://ev.paylog.cash/api/v1/clientes" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "cpf": "string",
    "nome": "string",
    "email": "[email protected]",
    "telefone": "string",
    "cep": "string",
    "endereco": "string",
    "numero": "string",
    "bairro": "string",
    "cidade": "string",
    "estado": "string",
    "pais": "string",
    "data_nascimento": "string",
    "sexo": "string",
    "complemento": "string",
    "celular": "string",
    "referencia_externa": "string",
    "inscricao_estadual": "string"
  }'

php

use Illuminate\Support\Facades\Http;

$response = Http::withToken('YOUR_TOKEN')
    ->acceptJson()
    ->post('https://ev.paylog.cash/api/v1/clientes', [
    'cpf' => 'string',
    'nome' => 'string',
    'email' => '[email protected]',
    'telefone' => 'string',
    'cep' => 'string',
    'endereco' => 'string',
    'numero' => 'string',
    'bairro' => 'string',
    'cidade' => 'string',
    'estado' => 'string',
    'pais' => 'string',
    'data_nascimento' => 'string',
    'sexo' => 'string',
    'complemento' => 'string',
    'celular' => 'string',
    'referencia_externa' => 'string',
    'inscricao_estadual' => 'string'
  ]);

javascript

const response = await fetch("https://ev.paylog.cash/api/v1/clientes", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "cpf": "string",
    "nome": "string",
    "email": "[email protected]",
    "telefone": "string",
    "cep": "string",
    "endereco": "string",
    "numero": "string",
    "bairro": "string",
    "cidade": "string",
    "estado": "string",
    "pais": "string",
    "data_nascimento": "string",
    "sexo": "string",
    "complemento": "string",
    "celular": "string",
    "referencia_externa": "string",
    "inscricao_estadual": "string"
  }),
});

python

import requests

response = requests.post(
    "https://ev.paylog.cash/api/v1/clientes",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
    "cpf": "string",
    "nome": "string",
    "email": "[email protected]",
    "telefone": "string",
    "cep": "string",
    "endereco": "string",
    "numero": "string",
    "bairro": "string",
    "cidade": "string",
    "estado": "string",
    "pais": "string",
    "data_nascimento": "string",
    "sexo": "string",
    "complemento": "string",
    "celular": "string",
    "referencia_externa": "string",
    "inscricao_estadual": "string"
  },
)

ruby

require "net/http"
require "json"
require "uri"

uri = URI("https://ev.paylog.cash/api/v1/clientes")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = {
  "cpf" => "string",
  "nome" => "string",
  "email" => "[email protected]",
  "telefone" => "string",
  "cep" => "string",
  "endereco" => "string",
  "numero" => "string",
  "bairro" => "string",
  "cidade" => "string",
  "estado" => "string",
  "pais" => "string",
  "data_nascimento" => "string",
  "sexo" => "string",
  "complemento" => "string",
  "celular" => "string",
  "referencia_externa" => "string",
  "inscricao_estadual" => "string"
}.to_json

response = http.request(request)

200 Resposta

json

{
  "code": 0,
  "message": "string",
  "cliente": 0
}

Corpo da requisição

application/json

object

cpf string Obrigatório

Obrigatório. CPF/CNPJ válido, com ou sem pontuação.
nome string Obrigatório

Obrigatório. Nome completo ou razão social.
email string email Obrigatório

Obrigatório. E-mail válido.
telefone string Obrigatório

Obrigatório. Telefone principal.
cep string Obrigatório

Obrigatório. CEP do endereço.
endereco string Obrigatório

Obrigatório. Logradouro.
numero string Obrigatório

Obrigatório. Número do endereço.
bairro string Obrigatório

Obrigatório. Bairro.
cidade string Obrigatório

Obrigatório. Cidade.
estado string Obrigatório

Obrigatório. UF ou estado.
pais string Obrigatório

Obrigatório. País.
data_nascimento string

Opcional. Quando enviado, use DD/MM/AAAA.
sexo string

Opcional. Quando enviado, não pode ser vazio.
complemento string

Opcional. Complemento do endereço.
celular string

Opcional. Telefone celular.
referencia_externa string

Opcional. ID do cliente no sistema de origem.
inscricao_estadual string

Opcional. Inscrição estadual.

Respostas

200

Cliente criado.

application/json

object

code integer Obrigatório
message string Obrigatório
cliente integer Obrigatório

ID do cliente criado.

400

Requisição inválida.

application/json

object

code integer

Código legado do erro, normalmente 400.
message string Obrigatório

Resumo do erro de validação.
erros object

Erros por campo retornados pelos endpoints legados.
errors object

Erros por campo retornados por validadores no formato atual.

401

Token Bearer ausente ou inválido.

application/json

object

Mensagem de erro ou informação. Alguns erros legados omitem code.

code integer

Código numérico quando fornecido pelo endpoint.
message string

Mensagem legível.

403

O token é válido, mas a conta não possui a permissão necessária para esta operação. O envelope é gerado pelo tratador global de exceções e usa a chave errors (string), não message.

application/json

object

Envelope produzido pelo tratador global de exceções para falhas HTTP que não são geradas pelos controladores — principalmente 403 (permissão ausente) e 405 (verbo não suportado). Difere dos erros dos controladores por usar errors no lugar de message.

errors string Obrigatório

Mensagem da exceção HTTP.
code integer Obrigatório

Código HTTP repetido no corpo.

500

Falha interna durante o processamento.

application/json

object

Mensagem de erro ou informação. Alguns erros legados omitem code.

code integer

Código numérico quando fornecido pelo endpoint.
message string

Mensagem legível.