Exclusão de chaves

stable scopes: pix.entries.delete

Para excluir o vínculo de uma chave com uma conta, é necessário que a chave não esteja em um processo de reinvindicação.

Etapas

Endpoint

Para consumo deste endpoint, no path da requisição, preencha o campo addressingKeyValue com o valor da chave que deseja excluir.

Além disso, informe o x-correlation-id com um GUID v4, gerado randomicamente. A cada requisição, deve-se gerar um novo GUID v4.

Dependendo do tipo de chave, insira um dos seguintes valores:

  • CPF: 11 dígitos, sem formatação;
  • CNPJ: 14 dígitos, sem formatação;
  • E-mail: todos os caracteres em minúsculo. Tamanho máximo de 72 caracteres;
  • Número de telefone celular: formado por símbolo ‘+’, seguido pelo código do país, DDD e número de celular com até nove dígitos. Exemplo: +5511912345678;
  • EVP: tamanho máximo de 36 caracteres. Exemplo: 123e4567-e89b-12d3-a456-426655440000.
--location --request DELETE 'https://api-mtls.sandbox.bankly.com.br/pix/entries/{{addressingKeyValue}}'\
--header 'Accept: application/json' \
--header 'api-version: 1' \
--header 'Authorization: Bearer {{accessToken}}'\
--header 'x-correlation-id: {{correlationId}}' \

Retorno

O retorno 204 indicará que sua chave foi excluída com sucesso.

Erros

Status codeCódigoDescrição
400INVALID_ENTRY_STATUS_FOR_EXCLUSIONA chave só pode ser excluída por seu proprietário.
404ENTRY_NOT_FOUNDChave não encontrada.
422ENTRY_REGISTERED_TO_ANOTHER_PARTNERA chave foi cadastrada para outro parceiro Bankly e é por ele que ela deve ser excluída.
422ENTRY_LOCKED_BY_CLAIMA chave está em processo de reivindicação e, portanto, não pode ser excluída.

Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados