Skip to main content
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": "joao@email.com"
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "externalId": "cliente_123",
    "name": "Joao Silva",
    "email": "joao@email.com",
    "document": "123.456.789-00",
    "documentType": "CPF",
    "phone": "5511999998888",
    "status": "Active",
    "metadata": "{\"plano\": \"premium\"}",
    "address": null,
    "createdAt": "2025-01-15T15:00:00Z"
  },
  "message": "Cliente criado com sucesso.",
  "error": null
}
Creates a new customer associated with your merchant account. Customers can be linked to transactions for better reporting and payment pre-filling.

Authorizations

​
Authorization
string
header
required

Token JWT obtido via /v1/auth/token

Body

application/json
​
name
string
required

Nome completo do cliente

Example:

"Joao Silva"

​
email
string
required

E-mail do cliente

Example:

"joao@email.com"

​
externalId
string | null

Seu identificador interno

Example:

"cliente_123"

​
document
string | null

CPF ou CNPJ (apenas numeros)

Example:

"12345678900"

​
documentType
enum<string> | null

Tipo do documento

Available options:
CPF,
CNPJ
Example:

"CPF"

​
phone
string | null

Telefone com codigo do pais. Aceita com ou sem '+' no envio e e salvo apenas com digitos.

Example:

"5511999998888"

​
metadata
string | null

Metadados em JSON

Example:

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

Response

Cliente criado com sucesso

​
data
object
​
message
string | null
​
error
object