24 - Cancelar Reivindicação

Scopes:

api.pix api.reivindicacao.cancelar

Cancela uma Reivindicação de Chave PIX.

cURL

curl --request POST \
  --url https://api.ext.pix.dbs.moneyp.com.br/api/Reivindicacao/Cancelar \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conta": {
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPgto": "<string>"
  }
}
'

200

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

Por meio deste endpoint, o parceiro pode solicitar o cancelamento de uma reinvindicação de chave Pix.

Requisitos
O cancelamento é permitido somente em casos em que a reivindicação ainda não tenha sido efetivada no sistema.

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/Reivindicacao/Cancelar	Não foi encontrada nenhuma reivindicacao pendente para a conta informada
/api/Reivindicacao/Cancelar	A reivindicação não pode ser cancelada

Autorizações

Authorization · string · header · obrigatório

Copie 'Bearer ' + token

Cabeçalhos

IdempotencyKey · string · obrigatório

IgnoraHandshake · boolean · padrão: true · obrigatório

(somente em homologação)

Corpo

application/jsontext/jsonapplication/*+json

codigo · string<uuid>

Identificador UUID da reivindicação à ser cancelada.*

conta · object

Objeto detalhado da conta bancária referente à solicitação de reivindicação.*

Show child attributes

Resposta

200

application/json

Success

sucesso · boolean

mensagem · string | null