Listar clientes

Listar e filtrar clientes

curl --request GET \
  --url https://api-sandbox.fortalpay.tech/v1/customers \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api-sandbox.fortalpay.tech/v1/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api-sandbox.fortalpay.tech/v1/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.fortalpay.tech/v1/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.fortalpay.tech/v1/customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

using RestSharp;


var options = new RestClientOptions("https://api-sandbox.fortalpay.tech/v1/customers");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "data": {
    "page": 123,
    "size": 123,
    "numberOfElements": 123,
    "totalElements": 123,
    "totalPages": 123,
    "content": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "status": "ACTIVE",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "document": "***.***.***-25",
        "phone": "<string>"
      }
    ]
  },
  "success": true,
  "error": null
}

{
  "data": null,
  "success": false,
  "error": {
    "timestamp": "2023-11-07T05:31:56Z",
    "status": 123,
    "message": "<string>",
    "path": "<string>",
    "fields": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "data": null,
  "success": false,
  "error": {
    "timestamp": "2023-11-07T05:31:56Z",
    "status": 123,
    "message": "<string>",
    "path": "<string>",
    "fields": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

GET

customers

Listar e filtrar clientes

curl --request GET \
  --url https://api-sandbox.fortalpay.tech/v1/customers \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api-sandbox.fortalpay.tech/v1/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api-sandbox.fortalpay.tech/v1/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.fortalpay.tech/v1/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.fortalpay.tech/v1/customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

using RestSharp;


var options = new RestClientOptions("https://api-sandbox.fortalpay.tech/v1/customers");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "data": {
    "page": 123,
    "size": 123,
    "numberOfElements": 123,
    "totalElements": 123,
    "totalPages": 123,
    "content": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "status": "ACTIVE",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "document": "***.***.***-25",
        "phone": "<string>"
      }
    ]
  },
  "success": true,
  "error": null
}

{
  "data": null,
  "success": false,
  "error": {
    "timestamp": "2023-11-07T05:31:56Z",
    "status": 123,
    "message": "<string>",
    "path": "<string>",
    "fields": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "data": null,
  "success": false,
  "error": {
    "timestamp": "2023-11-07T05:31:56Z",
    "status": 123,
    "message": "<string>",
    "path": "<string>",
    "fields": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Exemplos de filtro

Busca geral

Use search para procurar simultaneamente por nome, e-mail, documento ou telefone:

curl --request GET 'https://api-sandbox.fortalpay.tech/v1/customers?search=Maria&page=0&size=20' \
  --header 'Authorization: ApiKey <api_key>'

O exemplo encontra clientes como Maria Silva e também registros cujo e-mail, documento ou telefone contenha o valor pesquisado.

Filtros combinados

É possível combinar filtros específicos. Todos os parâmetros informados precisam corresponder ao cliente:

curl --request GET 'https://api-sandbox.fortalpay.tech/v1/customers?name=Maria&email=example.com&document=529.982&status=ACTIVE&page=0&size=20' \
  --header 'Authorization: ApiKey <api_key>'

Documento e telefone podem ser enviados com ou sem formatação. Nome e e-mail não diferenciam maiúsculas de minúsculas.

Exemplo em JavaScript

const params = new URLSearchParams({
  name: 'Maria',
  document: '529.982',
  status: 'ACTIVE',
  page: '0',
  size: '20'
});

const response = await fetch(`https://api-sandbox.fortalpay.tech/v1/customers?${params}`, {
  headers: {
    Authorization: `ApiKey ${process.env.FORTALPAY_API_KEY}`
  }
});

const result = await response.json();

Authorizations

Authorization

string

header

required

Todas as requisições devem incluir sua API key no cabeçalho Authorization usando o formato ApiKey <sua_api_key>. Não use o esquema Bearer. Sem esse cabeçalho, a requisição será rejeitada.

Use fpay_sk_test_... no ambiente de teste e fpay_sk_live_... em produção. Saiba como criar e usar uma API key.

Query Parameters

page

integer

default:0

Índice da página, começando em zero.

Required range: x >= 0

size

integer

default:20

Quantidade de registros solicitada por página.

Required range: x >= 1

sort

string[]

Expressão de ordenação do Spring Data. Cada serviço aplica a ordenação fixa documentada.

string

Busca parcial por nome, e-mail, documento e telefone, sem diferenciar maiúsculas de minúsculas. A formatação do documento e do telefone é ignorada.

name

string

Filtro parcial por nome, sem diferenciar maiúsculas de minúsculas.

string

Filtro parcial por e-mail, sem diferenciar maiúsculas de minúsculas.

document

string

Filtro parcial por CPF ou CNPJ. Os caracteres de formatação são ignorados.

phone

string

Filtro parcial por telefone. Os caracteres de formatação são ignorados.

status

enum<string>

Filtro exato por situação, sem diferenciar maiúsculas de minúsculas.

Available options:

ACTIVE

Response

Página de clientes retornada com sucesso.

data

object

required

Show child attributes

success

boolean

required

error

null

required

Checkouts

Clientes

Produtos

Cupons

Exemplos de filtro

Busca geral

Filtros combinados

Exemplo em JavaScript

Authorizations

Query Parameters

Response

​Exemplos de filtro

​Busca geral

​Filtros combinados

​Exemplo em JavaScript

Authorizations

Query Parameters

Response

Exemplos de filtro

Busca geral

Filtros combinados

Exemplo em JavaScript