Pular para o conteúdo principal
POST
/
v1
/
customers
Criar cliente
curl --request POST \
  --url https://api-payment.safefypay.com.br/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Joao Silva",
  "email": "[email protected]"
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "externalId": "cliente_123",
    "name": "Joao Silva",
    "email": "[email protected]",
    "document": "123.456.789-00",
    "documentType": "CPF",
    "phone": "11999998888",
    "status": "Active",
    "metadata": "{\"plano\": \"premium\"}",
    "address": null,
    "createdAt": "2025-01-15T15:00:00Z"
  },
  "message": "Cliente criado com sucesso.",
  "error": null
}
Cria um novo cliente para associar a transacoes e facilitar o acompanhamento de pagamentos.

​
Parametros

​
name
string
obrigatório
Nome completo do cliente.
​
email
string
obrigatório
Endereco de email do cliente.
​
document
string
Numero do documento (CPF ou CNPJ) sem formatacao.
​
documentType
string
Tipo do documento: CPF ou CNPJ.
​
phone
string
Telefone no formato internacional (ex: +5511999999999).
​
externalId
string
Identificador externo no seu sistema.
​
metadata
string
Dados adicionais em formato JSON string.

Autorizações

​
Authorization
string
header
obrigatório

Token JWT obtido via /v1/auth/token

Corpo

application/json
​
name
string
obrigatório

Nome completo do cliente

Exemplo:

"Joao Silva"

​
email
string
obrigatório

E-mail do cliente

Exemplo:

"[email protected]"

​
externalId
string | null

Seu identificador interno

Exemplo:

"cliente_123"

​
document
string | null

CPF ou CNPJ (apenas numeros)

Exemplo:

"12345678900"

​
documentType
enum<string> | null

Tipo do documento

Opções disponíveis:
CPF,
CNPJ
Exemplo:

"CPF"

​
phone
string | null

Telefone (apenas numeros)

Exemplo:

"11999998888"

​
metadata
string | null

Metadados em JSON

Exemplo:

"{\"plano\": \"premium\"}"

Resposta

Cliente criado com sucesso

​
data
object
​
message
string | null
​
error
object