Excluir Chaves Pix de uma Conta

Importante:

Para usar esta API, é necessário estar autenticado e incluir seu token de autenticação no cabeçalho da requisição. Consulte a documentação de Autenticação na plataforma para mais informações.

Autenticação.

O Sistema Cliente deve utilizar esta API para excluir uma Chave de Endereçamento. Antes de fazer uso desta API, é essencial garantir que o Cliente que solicitou a exclusão da Chave:

• Possua autorização para solicitar esse tipo de ação.

• Seja o Titular da Conta Transacional ou tenha autoridade legal para operá-la.

Sobre os parâmetros:

1. key (Chave): Este campo representa a chave Pix que você deseja excluir da conta. No exemplo, "[phone]" é o número de telefone celular que está sendo usado como chave Pix.

2. ispb (Código ISPB): O Código ISPB (Identificador de Sistema de Pagamentos Brasileiro) é um número que identifica uma instituição financeira no sistema de pagamentos do Brasil. No exemplo, "646612970" é um exemplo de Código ISPB.

Para o campo "reason" (Motivo):

• SOLICITACAO_CLIENTE: Este motivo indica que a criação da chave Pix foi solicitada pelo cliente.

• RECONCILIACAO: Utilize este motivo quando a criação da chave Pix for parte de um processo de reconciliação.

Como utilizar?

Para utilizar essa funcionalidade, siga estes passos simples. Abaixo, você encontrará exemplos de como realizar o processo de abertura de conta.

Requisição de exemplo

Excluir Chaves Pix de uma Conta

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"key":"03294996101","ispb":11165756,"reason":"SOLICITACAO_CLIENTE"}

Responses

200

successful

No content

401

authorization failed

422

validation failed

500

unknown server error

delete

/internal/api/v1/keys

HTTPcURLJavaScriptPython

DELETE /internal/api/v1/keys HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "key": "03294996101",
  "ispb": 11165756,
  "reason": "SOLICITACAO_CLIENTE"
}

No content

JSON Retorno Sucesso

{
   "key": "[phone]"
}