v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Cancela nova reivindicação/portabilidade de chave Pix

post/pix/dict/claim/cancel

Request body

idstring

Numero de Identificação único também conhecido como Id/ClaimId que retorna na criação da reivindicação/portabilidade

reasonstring

Motivo da solicitação Opcional por default é USER_REQUESTED Os tipos de razão são: "USER_REQUESTED" "ACCOUNT_CLOSURE" "FRAUD" "DEFAULT_OPERATION"

Response

200

versionstring

statusstring

Example response

{
  "version": "1.0.0",
  "status": "CANCELLED",
  "body": {
    "id": "8bbc0ba5-2aee-44a0-a3c9-b897802a9f66",
    "claimType": "OWNERSHIP",
    "key": "fulanodetal@gmail.com",
    "keyType": "EMAIL",
    "claimerAccount": {
      "participant": "30306294",
      "branch": "0001",
      "account": "30053913742139",
      "accountType": "TRAN"
    },
    "claimer": {
      "personType": "NATURAL_PERSON",
      "taxId": "34335125070",
      "name": "João da Silva Juniors"
    },
    "donorParticipant": "30306294",
    "createTimestamp": "2023-05-01T13:05:09",
    "completionPeriodEnd": "2023-05-01T13:05:09",
    "resolutionPeriodEnd": "2023-08-10T17",
    "lastModified": "2023-08-11T17:11:33",
    "cancelledBy": "CLAIMER",
    "cancelReason": "FRAUD"
  }
}