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"
}
'import requests
url = "https://api-payment.safefypay.com.br/v1/customers"
payload = {
"name": "Joao Silva",
"email": "joao@email.com"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Joao Silva', email: 'joao@email.com'})
};
fetch('https://api-payment.safefypay.com.br/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-payment.safefypay.com.br/v1/customers"
payload := strings.NewReader("{\n \"name\": \"Joao Silva\",\n \"email\": \"joao@email.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-payment.safefypay.com.br/v1/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Joao Silva\",\n \"email\": \"joao@email.com\"\n}")
.asString();{
"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
}{
"data": null,
"message": null,
"error": {
"message": "O campo email e obrigatorio.",
"code": "validation_error"
}
}{
"data": null,
"message": null,
"error": {
"message": "Token invalido ou expirado.",
"code": "unauthorized"
}
}{
"data": null,
"message": null,
"error": {
"message": "Ja existe um cliente com o externalId informado.",
"code": "conflict"
}
}Clientes
Criar cliente
Crie um novo cliente
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"
}
'import requests
url = "https://api-payment.safefypay.com.br/v1/customers"
payload = {
"name": "Joao Silva",
"email": "joao@email.com"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Joao Silva', email: 'joao@email.com'})
};
fetch('https://api-payment.safefypay.com.br/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-payment.safefypay.com.br/v1/customers"
payload := strings.NewReader("{\n \"name\": \"Joao Silva\",\n \"email\": \"joao@email.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-payment.safefypay.com.br/v1/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Joao Silva\",\n \"email\": \"joao@email.com\"\n}")
.asString();{
"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
}{
"data": null,
"message": null,
"error": {
"message": "O campo email e obrigatorio.",
"code": "validation_error"
}
}{
"data": null,
"message": null,
"error": {
"message": "Token invalido ou expirado.",
"code": "unauthorized"
}
}{
"data": null,
"message": null,
"error": {
"message": "Ja existe um cliente com o externalId informado.",
"code": "conflict"
}
}Cria um novo cliente para associar a transações e facilitar o acompanhamento de pagamentos.
Autorizações
Token JWT obtido via /v1/auth/token
Corpo
application/json
Nome completo do cliente
Exemplo:
"Joao Silva"
E-mail do cliente
Exemplo:
"joao@email.com"
Seu identificador interno
Exemplo:
"cliente_123"
CPF ou CNPJ (apenas numeros)
Exemplo:
"12345678900"
Tipo do documento
Opções disponíveis:
CPF, CNPJ Exemplo:
"CPF"
Telefone com codigo do pais. Aceita com ou sem '+' no envio e e salvo apenas com digitos.
Exemplo:
"5511999998888"
Metadados em JSON
Exemplo:
"{\"plano\": \"premium\"}"