GET /v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
curl -X GET "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q" \
-u "$FINVIA_API_KEY:"
const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');
const response = await fetch(
'https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q',
{ headers: { Authorization: `Basic ${credentials}` } },
);
if (response.status === 404) {
// cliente não existe neste ambiente
}
const customer = await response.json();
import os
import requests
response = requests.request(
"GET",
"https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q",
auth=(os.environ["FINVIA_API_KEY"], ""),
timeout=30,
)
print(response.status_code)
if response.content:
print(response.json())
<?php
$ch = curl_init('https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('FINVIA_API_KEY') . ':',
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, PHP_EOL;
print_r(json_decode($body, true));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;
public class Exemplo {
public static void main(String[] args) throws Exception {
String credentials = Base64.getEncoder()
.encodeToString((System.getenv("FINVIA_API_KEY") + ":").getBytes());
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q"))
.header("Authorization", "Basic " + credentials)
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
using System.Net.Http.Headers;
using System.Text;
var apiKey = Environment.GetEnvironmentVariable("FINVIA_API_KEY");
var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{apiKey}:"));
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);
var request = new HttpRequestMessage(HttpMethod.Get, "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q");
var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("GET", "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q", nil)
if err != nil {
panic(err)
}
req.SetBasicAuth(os.Getenv("FINVIA_API_KEY"), "")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode)
fmt.Println(string(body))
}
require "net/http"
require "uri"
uri = URI("https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q")
request = Net::HTTP::Get.new(uri)
request.basic_auth(ENV.fetch("FINVIA_API_KEY"), "")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts response.code
puts response.body
{
"statusCode": 404,
"message": "Customer not found"
}
Clientes
Consultar um cliente
Devolve o cadastro completo de um cliente a partir do identificador dele.
GET
/
v1
/
customers
/
{id}
GET /v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
curl -X GET "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q" \
-u "$FINVIA_API_KEY:"
const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');
const response = await fetch(
'https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q',
{ headers: { Authorization: `Basic ${credentials}` } },
);
if (response.status === 404) {
// cliente não existe neste ambiente
}
const customer = await response.json();
import os
import requests
response = requests.request(
"GET",
"https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q",
auth=(os.environ["FINVIA_API_KEY"], ""),
timeout=30,
)
print(response.status_code)
if response.content:
print(response.json())
<?php
$ch = curl_init('https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('FINVIA_API_KEY') . ':',
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, PHP_EOL;
print_r(json_decode($body, true));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;
public class Exemplo {
public static void main(String[] args) throws Exception {
String credentials = Base64.getEncoder()
.encodeToString((System.getenv("FINVIA_API_KEY") + ":").getBytes());
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q"))
.header("Authorization", "Basic " + credentials)
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
using System.Net.Http.Headers;
using System.Text;
var apiKey = Environment.GetEnvironmentVariable("FINVIA_API_KEY");
var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{apiKey}:"));
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);
var request = new HttpRequestMessage(HttpMethod.Get, "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q");
var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("GET", "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q", nil)
if err != nil {
panic(err)
}
req.SetBasicAuth(os.Getenv("FINVIA_API_KEY"), "")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode)
fmt.Println(string(body))
}
require "net/http"
require "uri"
uri = URI("https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q")
request = Net::HTTP::Get.new(uri)
request.basic_auth(ENV.fetch("FINVIA_API_KEY"), "")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts response.code
puts response.body
{
"statusCode": 404,
"message": "Customer not found"
}
Esta rota devolve o cadastro de um cliente. Use quando você já tem o
id (guardado no seu sistema, recebido em Criar cliente ou em Listar clientes) e precisa conferir o cadastro antes de uma operação.
Quando usar
| Situação | Como usar esta rota |
|---|---|
| Conferir se o cliente tem e-mail e CPF ou CNPJ antes de registrar um cartão | Consulte pelo id e confira o e-mail e o documento do cadastro |
| Mostrar os dados do comprador na tela de atendimento | Consulte pelo id guardado no pedido |
| Verificar se uma atualização foi aplicada | Consulte o cliente depois de Atualizar cliente |
| Encontrar um cliente pelo e-mail ou documento | Use Listar clientes com filtro |
Antes de chamar
- Tenha uma chave secreta (
sk_) válida, do mesmo ambiente (teste ou produção) em que o cliente foi criado (Credenciais e ambientes). - Tenha o
iddo cliente.
Parâmetros de caminho
Respostas
A resposta200 traz o cadastro do cliente.
Em validação (V-37): os campos do cliente na resposta e o exemplo estão retidos até o time técnico definir o formato final. Os nomes dos campos vão mudar em relação à versão atual.
| HTTP | Significado | Corpo |
|---|---|---|
200 | Cliente encontrado | Cadastro do cliente |
401 | Credencial inválida | {"statusCode": 401, "message": "Unauthorized"} |
404 | Cliente não encontrado | {"statusCode": 404, "message": "Customer not found"} |
Para o desenvolvedor: para salvar um cartão, o cliente precisa ter e-mail e CPF (11 dígitos) ou CNPJ (14 dígitos). Sem isso, Registrar cartão responde
400. Enquanto os campos desta resposta não são publicados, garanta esses dados no momento em que cria o cliente.Erros comuns
| Sintoma | Causa | Como resolver |
|---|---|---|
404 com Customer not found | id incorreto, cliente excluído ou criado no outro ambiente | Confira o id e use a chave do ambiente em que o cliente foi criado |
401 Unauthorized | Chave ausente, inválida ou mal codificada | Codifique em Base64 a chave seguida de : |
GET /v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
curl -X GET "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q" \
-u "$FINVIA_API_KEY:"
const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');
const response = await fetch(
'https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q',
{ headers: { Authorization: `Basic ${credentials}` } },
);
if (response.status === 404) {
// cliente não existe neste ambiente
}
const customer = await response.json();
import os
import requests
response = requests.request(
"GET",
"https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q",
auth=(os.environ["FINVIA_API_KEY"], ""),
timeout=30,
)
print(response.status_code)
if response.content:
print(response.json())
<?php
$ch = curl_init('https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('FINVIA_API_KEY') . ':',
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, PHP_EOL;
print_r(json_decode($body, true));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;
public class Exemplo {
public static void main(String[] args) throws Exception {
String credentials = Base64.getEncoder()
.encodeToString((System.getenv("FINVIA_API_KEY") + ":").getBytes());
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q"))
.header("Authorization", "Basic " + credentials)
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
using System.Net.Http.Headers;
using System.Text;
var apiKey = Environment.GetEnvironmentVariable("FINVIA_API_KEY");
var credentials = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{apiKey}:"));
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);
var request = new HttpRequestMessage(HttpMethod.Get, "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q");
var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("GET", "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q", nil)
if err != nil {
panic(err)
}
req.SetBasicAuth(os.Getenv("FINVIA_API_KEY"), "")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode)
fmt.Println(string(body))
}
require "net/http"
require "uri"
uri = URI("https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q")
request = Net::HTTP::Get.new(uri)
request.basic_auth(ENV.fetch("FINVIA_API_KEY"), "")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts response.code
puts response.body
{
"statusCode": 404,
"message": "Customer not found"
}
Veja também
Guia de clientes
Ciclo de vida do cadastro do cliente.
Atualizar cliente
Mudar nome, e-mail ou telefone.
Listar cartões
Cartões salvos do cliente, filtrando por
customerId.Cartão salvo
Recompra com o cartão guardado no cofre.

