DELETE /v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
curl -X DELETE "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',
{ method: 'DELETE', headers: { Authorization: `Basic ${credentials}` } },
);
if (response.status === 204) {
// cliente excluído
} else {
const erro = await response.json(); // 401 ou 404
}
import os
import requests
response = requests.request(
"DELETE",
"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 => 'DELETE',
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("DELETE", 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.Delete, "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("DELETE", "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::Delete.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
(sem corpo)
{
"statusCode": 404,
"message": "Customer not found"
}
Clientes
Excluir um cliente
Remove um cliente do sistema por exclusão lógica (soft delete).
DELETE
/
v1
/
customers
/
{id}
DELETE /v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
curl -X DELETE "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',
{ method: 'DELETE', headers: { Authorization: `Basic ${credentials}` } },
);
if (response.status === 204) {
// cliente excluído
} else {
const erro = await response.json(); // 401 ou 404
}
import os
import requests
response = requests.request(
"DELETE",
"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 => 'DELETE',
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("DELETE", 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.Delete, "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("DELETE", "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::Delete.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
(sem corpo)
{
"statusCode": 404,
"message": "Customer not found"
}
Esta rota remove um cliente da sua base. O contrato da API classifica a operação como exclusão lógica (soft delete). Use quando o cliente pede para encerrar o cadastro ou quando você precisa limpar registros duplicados.
Quando usar
| Situação | Como usar esta rota |
|---|---|
| Cliente pediu o encerramento do cadastro no seu serviço | Exclua pelo id |
| Limpeza de cadastros duplicados | Escolha o cadastro que fica e exclua os demais |
| Cliente com documento cadastrado errado | Crie o cadastro correto com Criar cliente e exclua o antigo |
| Remover só o cartão salvo, mantendo o cliente | Use Excluir cartão |
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. - Se o cliente tem assinaturas ativas ou cartões salvos, decida antes o que fazer com eles: cancele as assinaturas em Cancelar assinatura e remova os cartões em Excluir cartão, se for o caso.
A documentação da API não descreve o que acontece com cartões salvos, assinaturas e cobranças de um cliente excluído. Trate esses vínculos de forma explícita, com as rotas próprias de cada recurso, antes de excluir o cliente.
Parâmetros de caminho
Esta rota não tem corpo de requisição nem parâmetros de consulta.Respostas
A resposta de sucesso é204 sem corpo.
| HTTP | Significado | Corpo |
|---|---|---|
204 | Cliente excluído | Sem corpo |
401 | Credencial inválida | {"statusCode": 401, "message": "Unauthorized"} |
404 | Cliente não encontrado | {"statusCode": 404, "message": "Customer not found"} |
Para o desenvolvedor: não tente ler JSON da resposta
204, o corpo vem vazio. Em Node.js, verifique response.status === 204 (ou response.ok) antes de qualquer response.json().Erros comuns
| Sintoma | Causa | Como resolver |
|---|---|---|
| Erro ao interpretar a resposta como JSON | A resposta 204 não tem corpo | Verifique o status e não chame json() |
404 com Customer not found | id incorreto, cliente já excluído ou criado no outro ambiente | Confira o id e a chave usada |
401 Unauthorized | Chave ausente, inválida ou mal codificada | Codifique em Base64 a chave seguida de : |
DELETE /v1/customers/2RhQg9M7ZCg3X3nMb9W1kX8Q HTTP/1.1
Host: api-global.fastpaybrasil.com
Authorization: Basic <base64 de "SUA_CHAVE_SECRETA:">
curl -X DELETE "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',
{ method: 'DELETE', headers: { Authorization: `Basic ${credentials}` } },
);
if (response.status === 204) {
// cliente excluído
} else {
const erro = await response.json(); // 401 ou 404
}
import os
import requests
response = requests.request(
"DELETE",
"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 => 'DELETE',
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("DELETE", 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.Delete, "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("DELETE", "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::Delete.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
(sem corpo)
{
"statusCode": 404,
"message": "Customer not found"
}
Veja também
Guia de clientes
Criação, manutenção e remoção de clientes.
Excluir cartão
Revogar um cartão salvo no cofre.
Ciclo de vida da assinatura
Cancelamento e estorno de assinaturas.
Listar clientes
Encontrar cadastros duplicados.

