4 - Excluir Chave Pix

Scopes:

api.pix api.chave.excluir

Excluir chave PIX

cURL

curl --request DELETE \
  --url https://api.ext.pix.dbs.moneyp.com.br/api/Chave/Excluir \
  --header 'Authorization: <api-key>'

200

{
  "sucesso": true,
  "mensagem": "<string>"
}

Por meio deste endpoint, o parceiro pode realizar a exclusão das chaves Pix cadastradas, tanto clientes quanto parceiros podem remover uma chave previamente registrada em sua conta e fazer a gestão segura das suas chaves nas transações.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

Endpoint	Mensagem de erro
/api/Chave/Excluir	Código da conta não identificado na requisição. Verifique autenticação AuthCompany
/api/Chave/Excluir	Chave pix não encontrada
/api/Chave/Excluir	Conta não encontrada
/api/Chave/Excluir	Operador não encontrado
/api/Chave/Excluir	Parceiro não autorizado para esta conta
/api/Chave/Excluir	A chave PIX informada não pertence a esta conta
/api/Chave/Excluir	Chave inválida
/api/Chave/Excluir	Chave não encontrada
/api/Chave/Excluir	Conta não encontrada
/api/Chave/Excluir	Existem PIX Cobrança registrados para essa chave. O cancelamento será possível apenas quando essas cobranças forem pagas ou baixadas
/api/Chave/Excluir	Não é possível excluir uma chave com status de portabilidade em aberto. / Não é possível excluir uma chave com status de reivindicação em aberto
/api/Chave/Excluir	Chave inválida

Autorizações

Authorization · string · header · obrigatório

Copie 'Bearer ' + token

Parâmetros de consulta

Chave · string

Chave PIX cadastrada à ser excluida.*

Resposta

200

application/json

Success

sucesso · boolean

mensagem · string | null