---
title: "Cancel key claim"
method: POST
path: "/v2/pix/claims/cancel"
tags: ["Claims"]
---

# Cancel key claim

`POST /v2/pix/claims/cancel`

## Request

- Base URL: `https://sandbox.pismolabs.io/pix-dict`
- URL: `https://sandbox.pismolabs.io/pix-dict/v2/pix/claims/cancel`
- Auth: HTTP bearer

Cancel a key's DICT claim. 

The table below defines, depending on the reason and type, who can cancel. 

For more information, refer to <a href="https://developers.pismo.io/pismo-docs/docs/pix-instant-payments#pix-key-transfer-key-claim" >Pix key transfer (key claim)</a>

* `OWNERSHIP` - Transfer key ownership between users in the same or another bank. 

* `PORTABILITY` - Transfer key ownership for the same user to another bank.


<table border="1">
<tr>
<th> </th>
<th colspan="2"> OWNERSHIP </th>
<th colspan="3"> PORTABILITY </th>
</tr>
<tr>
<th> Reason </th>
<th> Donor </th>
<th> Claimer </th>
<th> Donor </th>
<th colspan="2"> Claimer </th>
</tr>
<tr>
<th colspan=4>&nbsp</td>
<th>WAITING_RESOLUTION</th>
<th>CONFIRMED</th>
<tr bgcolor="#FFFAFA">
<td>USER_REQUESTED</td>
<td></td>
<td align="center">√</td>
<td align="center">√</td>
<td align="center">√</td>
<td aligm="center">&nbsp;</td>
</tr>
<tr>
<td>ACCOUNT_CLOSURE</td>
<td align="center">√</td>
<td align="center">√</td>
<td align="center"></td>
<td align="center">√</td>
</tr>
<tr bgcolor="#FFFAFA">
<td>FRAUD</td>
<td align="center">√</td>
<td align="center">√</td>
<td align="center">√</td>
<td align="center">√</td>
<td align="center">√</td>
</tr>
<tr>
<td>DEFAULT_OPERATION</td>
<td align="center"></td>
<td align="center">√</td>
<td align="center">√</td>
<td align="center"></td>
</tr>
<tr bgcolor="#FFFAFA">
<td>RECONCILIATION</td>
<td align="center"></td>
<td align="center"></td>
<td align="center"></td>
<td align="center">√</td>
 <td align="center">√</td>
</tr>
</table>

On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronously, eventually emitting an event if it succeeds.

This endpoint generates a <a href="https://developers.pismo.io/events/docs/pix-dict-claim-status-change-1" >Pix key claim status changed</a> event.

## Headers

- `Authorization` string, required
- `Idempotency-Key` string, required

## Request body

- ClaimCancelClaimRequest
  - `claim_id` string, required: Claim ID for key transfer. The Create key claim or Create DICT key claim endpoint returns this field.
  - `reason` 'USER_REQUESTED' | 'ACCOUNT_CLOSURE' | 'BRANCH_TRANSFER' | 'RECONCILIATION' | 'FRAUD' | 'DEFAULT_OPERATION' | 'RFB_VALIDATION', required: Reason for request

## Response `200`

Claim cancelled

- ClaimCancelClaimResponse
  - `cancel_reason` 'USER_REQUESTED' | 'ACCOUNT_CLOSURE' | 'BRANCH_TRANSFER' | 'RECONCILIATION' | 'FRAUD' | 'DEFAULT_OPERATION' | 'RFB_VALIDATION', required: Reason for request
  - `confirm_reason` 'USER_REQUESTED' | 'ACCOUNT_CLOSURE' | 'BRANCH_TRANSFER' | 'RECONCILIATION' | 'FRAUD' | 'DEFAULT_OPERATION' | 'RFB_VALIDATION', required: Reason for request
  - `bacen_response_time` string, date-time: Banco Central do Brasil (Central Bank of Brazil) response datetime. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`.
  - `claim_id` string: Claim ID for key transfer. The Create key claim or Create DICT key claim endpoint returns this field.
  - `claimer` ClaimClaimerData
    - `document_number` string, required: A government document number, such as a Social Security number (US) or Cadastro de Pessoas Físicas number (Brazil). Must be numeric with 11-14 digits.
    - `name` string, required: Person's name
    - `type` 'LEGAL_PERSON' | 'NATURAL_PERSON', required: Person type: * `LEGAL_PERSON` - An actual person with legal rights * `NATURAL_PERSON` - An entity, such as an organization or company.
    - `trade_name` string: Name under which the business operates. Not necessarily the same as the legal name.
  - `claimer_account` ClaimClaimerAccountData
    - `account_number` string, required: Account number.
    - `account_type` 'CACC' | 'SLRY' | 'SVGS' | 'TRAN', required: Account type: `CACC` - Checking account `SVGS` - Savings account `TRAN` - Transactional account (Brazil only). Also known as "conta corrente" in Portuguese, this is a bank account type designed for everyday financial transactions and is the most common type individuals and businesses use for day-to-day banking. `SLRY` - Salary account. Employer deposits a fixed amount every month.
    - `opening_datetime` string, date-time, required: Opening date time. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`.
    - `branch` string: Bank-assigned branch ID or ISPB (Identifcador do Sistema de Pagamento Brazil) number - the Brazilian Payment System identifier, an 8-digit value.
    - `participant` string: Participant's ISPB (Identifcador do Sistema de Pagamento Brazil) number - the Brazilian Payment System identifier, an 8-digit value.
  - `completion_period_end_datetime` string, date-time: Completion period end for claim. Present for claim type `OWNERSHIP`. ISO 8601 format.
  - `correlation_id` string, uuid: The correlation identifier is used to link related API requests and events. The Pismo engineering team can use this to track everything related to a call. If one is not passed, it is automatically generated and returned to the client in a response header.
  - `donor_participant` string: Donor participant's ISPB (Identifcador do Sistema de Pagamento Brazil) number - the Brazilian Payment System identifier, an 8-digit value.
  - `key` string: Value, based on a key's type, used to encrypt Pix key.
  - `key_type` 'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'EVP': User information that can be used to create a Pix key: * `CPF` - Cadastro de Pessoas Fisicas (Indiviual Taxpayer Registry) number. Similar to a Social Security number in the US. * `CNPJ` - Cadastro Nacional de Pessoa Juridica (National Registry of Legal Entities) number. Unique ID for legal entities, such as companies and organizations, in Brazil * `EMAIL` - Email * `PHONE` - Phone number * `EVP` - Endereco de pagamento virtual (virtual payment address). A randomly-generated UUID number.
  - `last_modified_datetime` string, date-time: Last modified datetime. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`.
  - `resolution_period_end_datetime` string, date-time: Resolution period end for claim. ISO 8601 format.
  - `status` 'OPEN' | 'WAITING_RESOLUTION' | 'CONFIRMED' | 'CANCELLED' | 'COMPLETED': Claim status
  - `type` 'OWNERSHIP' | 'PORTABILITY': Key claim type: * `OWNERSHIP` - Transfers key ownership between individuals in the same or another bank. * `PORTABILITY`- Transfers key ownership for the same individual to another bank.

## Other responses

- `202`: Accepted
- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal server errpr
- `502`: Bad Gateway
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/pismo/apis/instant-payments-pix-management.md) - [All operations](https://skmtc.dev/pismo/apis/instant-payments-pix-management/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/instant-payments-pix-management/revisions/eb540c289547?raw)