curl --request POST \
  --url https://api.ext.pix.dbs.moneyp.dev.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>",
    "tipoConta": 1,
    "modeloConta": 1
  }
}'
{
  "sucesso": true,
  "mensagem": "<string>"
}

Through this endpoint, partners can request the cancellation of a Pix key claim.

Requirements
Cancellation is only permitted if the claim has not yet been processed in the system.

Authorizations

Authorization
string
header
required

Copie 'Bearer ' + token

Headers

IdempotencyKey
string
required

Chave única para garantir que uma operação seja executada apenas uma vez.

IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

codigo
string

Identificador UUID da Reivindicação à ser cancelada.

conta
object

Objeto detalhado da Conta Bancária referente à Solicitação de Reivindicação.

Response

200 - application/json
Success
sucesso
boolean

Indica se a operação foi realizada com sucesso.

mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.