DELETE
/v1/BankAccount/Pix/QRCode/DeleteQrCodeBanking · PIX
Remover Bank Account
Remove um registro de Bank Account.
Visão geral
Remove um registro de Bank Account.
Autenticação e pré-requisitos
Requer autenticação. Envie o token no header Authorization: Bearer {{token}} (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar X-Api-Key. Todo tráfego é HTTPS e a credencial nunca vai na URL nem em query string.
Request
Parâmetros
| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
qrCode | query | string | opcional | — | valor |
Corpo da requisição
Este endpoint não recebe corpo.
Response
Resposta 200.
Campos
| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
transactionId | string | opcional | — | — | "3fa85f64-5717-4562-b3fc-2c963f66afa6" |
message | string | opcional | — | — | "texto" |
qrCodeId | string | opcional | — | — | "3fa85f64-5717-4562-b3fc-2c963f66afa6" |
qrCode | string | opcional | — | — | "texto" |
txId | string | opcional | — | — | "3fa85f64-5717-4562-b3fc-2c963f66afa6" |
Exemplo de resposta
{
"transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "texto",
"qrCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"qrCode": "texto",
"txId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}Códigos de retorno
| Código | Significado | Detalhe do contrato |
|---|---|---|
200 | Requisição bem-sucedida. | — |
Exemplos
curl -X DELETE "{{baseUrl}}/v1/BankAccount/Pix/QRCode/DeleteQrCode" \
-H "Authorization: Bearer {{token}}"var baseUrl = "{{baseUrl}}";
var token = "{{token}}";
using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", token);
var rota = "/v1/BankAccount/Pix/QRCode/DeleteQrCode";
var resp = await http.DeleteAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();const baseUrl = '{{baseUrl}}';
const token = '{{token}}';
const resp = await fetch(`${baseUrl}/v1/BankAccount/Pix/QRCode/DeleteQrCode`, {
method: 'DELETE',
headers: {
'Authorization': `Bearer ${token}`,
},
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.
Downloads
Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.
Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →
Guia de importação: Como importar no Postman · Todos os downloads: Downloads