PUT /v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
Content-Type: application/json
{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}
curl -X PUT "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q" \
-u "$FINVIA_API_KEY:" \
-H "Content-Type: application/json" \
-d '{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}'
const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');
const response = await fetch(
'https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q',
{
method: 'PUT',
headers: {
Authorization: `Basic ${credentials}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ email: '[email protected]' }),
},
);
if (!response.ok) {
const erro = await response.json(); // 401 ou 404
}
import os
import requests
payload = {
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321",
}
response = requests.request(
"PUT",
"https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q",
auth=(os.environ["FINVIA_API_KEY"], ""),
json=payload,
timeout=30,
)
print(response.status_code)
if response.content:
print(response.json())
<?php
$payload = [
'name' => 'Joao da Silva',
'email' => '[email protected]',
'phoneNumber' => '+5511987654321',
];
$ch = curl_init('https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('FINVIA_API_KEY') . ':',
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
]);
$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());
String payload = """
{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q"))
.header("Authorization", "Basic " + credentials)
.header("Content-Type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString(payload))
.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 payload = """
{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}
""";
var request = new HttpRequestMessage(HttpMethod.Put, "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");
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"
"strings"
)
func main() {
payload := strings.NewReader(`{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}`)
req, err := http.NewRequest("PUT", "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q", payload)
if err != nil {
panic(err)
}
req.SetBasicAuth(os.Getenv("FINVIA_API_KEY"), "")
req.Header.Set("Content-Type", "application/json")
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 "json"
require "net/http"
require "uri"
uri = URI("https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q")
request = Net::HTTP::Put.new(uri)
request.basic_auth(ENV.fetch("FINVIA_API_KEY"), "")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
"name" => "Joao da Silva",
"email" => "[email protected]",
"phoneNumber" => "+5511987654321",
})
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
Atualizar um cliente
Altera nome, e-mail ou telefone de um cliente. O documento não pode ser alterado depois da criação.
PUT
/
v1
/
customers
/
{id}
PUT /v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
Content-Type: application/json
{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}
curl -X PUT "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q" \
-u "$FINVIA_API_KEY:" \
-H "Content-Type: application/json" \
-d '{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}'
const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');
const response = await fetch(
'https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q',
{
method: 'PUT',
headers: {
Authorization: `Basic ${credentials}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ email: '[email protected]' }),
},
);
if (!response.ok) {
const erro = await response.json(); // 401 ou 404
}
import os
import requests
payload = {
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321",
}
response = requests.request(
"PUT",
"https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q",
auth=(os.environ["FINVIA_API_KEY"], ""),
json=payload,
timeout=30,
)
print(response.status_code)
if response.content:
print(response.json())
<?php
$payload = [
'name' => 'Joao da Silva',
'email' => '[email protected]',
'phoneNumber' => '+5511987654321',
];
$ch = curl_init('https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('FINVIA_API_KEY') . ':',
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
]);
$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());
String payload = """
{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q"))
.header("Authorization", "Basic " + credentials)
.header("Content-Type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString(payload))
.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 payload = """
{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}
""";
var request = new HttpRequestMessage(HttpMethod.Put, "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");
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"
"strings"
)
func main() {
payload := strings.NewReader(`{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}`)
req, err := http.NewRequest("PUT", "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q", payload)
if err != nil {
panic(err)
}
req.SetBasicAuth(os.Getenv("FINVIA_API_KEY"), "")
req.Header.Set("Content-Type", "application/json")
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 "json"
require "net/http"
require "uri"
uri = URI("https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q")
request = Net::HTTP::Put.new(uri)
request.basic_auth(ENV.fetch("FINVIA_API_KEY"), "")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
"name" => "Joao da Silva",
"email" => "[email protected]",
"phoneNumber" => "+5511987654321",
})
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 mantém o cadastro do cliente em dia: quando o comprador troca de e-mail, corrige o nome ou muda de telefone no seu sistema, você reflete a mudança aqui.
Quando usar
| Situação | Como usar esta rota |
|---|---|
| Cliente alterou o e-mail no perfil do seu site | Envie só email |
| Correção de nome digitado errado | Envie só name |
| Novo número de telefone | Envie só phoneNumber |
| CPF ou CNPJ cadastrado errado | Esta rota não altera documento. Crie um novo cliente com Criar cliente |
Antes de chamar
- Tenha uma chave secreta (
sk_) válida, do mesmo ambiente em que o cliente foi criado (Credenciais e ambientes). - Tenha o
iddo cliente.
documentId e documentType não podem ser alterados depois da criação. O corpo desta rota aceita apenas name, email e phoneNumber.Parâmetros de caminho
Corpo da requisição
O corpo é obrigatório, mas nenhum campo dele é obrigatório: envie apenas os que vão mudar.E-mail do cliente (formato
email). Ex.: [email protected].Para o desenvolvedor: o contrato não marca nenhum campo como obrigatório no corpo. Para evitar sobrescrever dados por engano, envie só os campos que o usuário de fato alterou e trate qualquer
200 como alteração aplicada.Respostas
A resposta200 traz o cadastro do cliente, no mesmo formato de Consultar cliente. Os campos desse cadastro ainda não estão publicados: o time técnico vai definir o formato final.
| HTTP | Significado | Corpo |
|---|---|---|
200 | Cliente atualizado | Cadastro do cliente |
401 | Credencial inválida | {"statusCode": 401, "message": "Unauthorized"} |
404 | Cliente não encontrado | {"statusCode": 404, "message": "Customer not found"} |
Para o negócio: como o documento fica fixo, um erro de CPF ou CNPJ no cadastro só se resolve com um cliente novo. Vale validar o documento no seu formulário antes de criar 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 a chave usada |
| Documento continua igual depois da chamada | documentId e documentType não são alteráveis | Crie um novo cliente com o documento correto |
401 Unauthorized | Chave ausente, inválida ou mal codificada | Codifique em Base64 a chave seguida de : |
PUT /v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
Content-Type: application/json
{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}
curl -X PUT "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q" \
-u "$FINVIA_API_KEY:" \
-H "Content-Type: application/json" \
-d '{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}'
const credentials = Buffer.from(`${process.env.FINVIA_API_KEY}:`).toString('base64');
const response = await fetch(
'https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q',
{
method: 'PUT',
headers: {
Authorization: `Basic ${credentials}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ email: '[email protected]' }),
},
);
if (!response.ok) {
const erro = await response.json(); // 401 ou 404
}
import os
import requests
payload = {
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321",
}
response = requests.request(
"PUT",
"https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q",
auth=(os.environ["FINVIA_API_KEY"], ""),
json=payload,
timeout=30,
)
print(response.status_code)
if response.content:
print(response.json())
<?php
$payload = [
'name' => 'Joao da Silva',
'email' => '[email protected]',
'phoneNumber' => '+5511987654321',
];
$ch = curl_init('https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('FINVIA_API_KEY') . ':',
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
]);
$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());
String payload = """
{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q"))
.header("Authorization", "Basic " + credentials)
.header("Content-Type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString(payload))
.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 payload = """
{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}
""";
var request = new HttpRequestMessage(HttpMethod.Put, "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");
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"
"strings"
)
func main() {
payload := strings.NewReader(`{
"name": "Joao da Silva",
"email": "[email protected]",
"phoneNumber": "+5511987654321"
}`)
req, err := http.NewRequest("PUT", "https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q", payload)
if err != nil {
panic(err)
}
req.SetBasicAuth(os.Getenv("FINVIA_API_KEY"), "")
req.Header.Set("Content-Type", "application/json")
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 "json"
require "net/http"
require "uri"
uri = URI("https://api-global.fastpaybrasil.com/v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q")
request = Net::HTTP::Put.new(uri)
request.basic_auth(ENV.fetch("FINVIA_API_KEY"), "")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
"name" => "Joao da Silva",
"email" => "[email protected]",
"phoneNumber" => "+5511987654321",
})
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
Boas práticas de cadastro.
Consultar cliente
Conferir o cadastro depois da alteração.
Ciclo de vida da assinatura
O que muda e o que não muda em uma assinatura ativa.
Cofre de cartões
Cartões vinculados ao cliente.

