Listar clientes
curl --request GET \
--url https://api-payment.safefypay.com.br/v1/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-payment.safefypay.com.br/v1/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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"
"net/http"
"io"
)
func main() {
url := "https://api-payment.safefypay.com.br/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-payment.safefypay.com.br/v1/customers")
.header("Authorization", "Bearer <token>")
.asString();{
"data": {
"items": [
{
"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": null,
"address": null,
"createdAt": "2025-01-15T15:00:00Z"
}
],
"page": 1,
"pageSize": 20,
"totalItems": 1,
"totalPages": 1,
"hasNextPage": false,
"hasPreviousPage": false
},
"message": null,
"error": null
}{
"data": null,
"message": null,
"error": {
"message": "Token invalido ou expirado.",
"code": "unauthorized"
}
}Clientes
Listar clientes
Liste e filtre seus clientes
GET
/
v1
/
customers
Listar clientes
curl --request GET \
--url https://api-payment.safefypay.com.br/v1/customers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-payment.safefypay.com.br/v1/customers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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"
"net/http"
"io"
)
func main() {
url := "https://api-payment.safefypay.com.br/v1/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-payment.safefypay.com.br/v1/customers")
.header("Authorization", "Bearer <token>")
.asString();{
"data": {
"items": [
{
"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": null,
"address": null,
"createdAt": "2025-01-15T15:00:00Z"
}
],
"page": 1,
"pageSize": 20,
"totalItems": 1,
"totalPages": 1,
"hasNextPage": false,
"hasPreviousPage": false
},
"message": null,
"error": null
}{
"data": null,
"message": null,
"error": {
"message": "Token invalido ou expirado.",
"code": "unauthorized"
}
}Retorna uma lista paginada de clientes com opções de filtragem.
Autorizações
Token JWT obtido via /v1/auth/token
Parâmetros de consulta
Numero da pagina
Exemplo:
1
Itens por pagina (max: 100)
Exemplo:
20
Filtrar por status
Opções disponíveis:
Active, Inactive Exemplo:
"Active"
Filtrar por tipo de documento
Opções disponíveis:
CPF, CNPJ Exemplo:
"CPF"
Buscar por nome, email ou documento
Exemplo:
"joao"
Filtrar por ID externo
Exemplo:
"cliente_123"