Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Claims

Cancel key claim

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.

post/v2/pix/claims/cancel

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Idempotency-Keystring required

A unique ID to ensure the operation remains idempotent, allowing for operation repitition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

Request body

claim_idstring required

Claim ID for key transfer. The Create key claim or Create DICT key claim endpoint returns this field.

reasonstring required

Reason that indicates why the card was added to the Protection Bulletin.

Example request

{
  "claim_id": "123e4567-e89b-12d3-a456-426655440000",
  "reason": "L"
}

Response

Claim cancelled

cancel_reasonstring required

Reason that indicates why the card was added to the Protection Bulletin.

confirm_reasonstring required

Reason that indicates why the card was added to the Protection Bulletin.

bacen_response_timestring 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_idstring

Claim ID for key transfer. The Create key claim or Create DICT key claim endpoint returns this field.

completion_period_end_datetimestring date-time

Completion period end for claim. Present for claim type OWNERSHIP. ISO 8601 format.

correlation_idstring

The Correlation identifier field is used to link related API requests and events. The CID can help the Pismo engineering team track everything related to a call. If not passed, a random one is generated. You can find the CID in the response header.

donor_participantstring

Donor participant's ISPB (Identifcador do Sistema de Pagamento Brazil) number - the Brazilian Payment System identifier, an 8-digit value.

keystring

Pix key value.

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_datetimestring date-time

Last modified datetime. A RFC 3339 date-time value. For example - 2023-04-12T23:20:50.52Z.

resolution_period_end_datetimestring 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.

Example response

{
  "cancel_reason": "L",
  "confirm_reason": "L",
  "bacen_response_time": "2020-08-13T13:49:03Z",
  "claim_id": "123e4567-e89b-12d3-a456-426655440000",
  "claimer": {
    "document_number": "7777888hh",
    "name": "Jerry Atrick",
    "type": "NATURAL_PERSON",
    "trade_name": "Acme Widgets"
  },
  "claimer_account": {
    "account_number": "98765432",
    "account_type": "TRAN",
    "opening_datetime": "2020-08-13T13:49:03Z",
    "branch": "011",
    "participant": "00115678"
  },
  "completion_period_end_datetime": "2020-01-24T10:00:00Z",
  "correlation_id": "c737895c-8159-4c0c-a92a-a4f8600bff37",
  "donor_participant": "99999011",
  "key": "email@email.com",
  "key_type": "EMAIL",
  "last_modified_datetime": "2020-08-13T13:49:03Z",
  "resolution_period_end_datetime": "2020-01-17T10:00:00Z",
  "status": "OPEN",
  "type": "OWNERSHIP"
}