APIs
Sub-processorsAbout PismoContact us

Cancel key claim

post
https://sandbox.pismolabs.io/pix-dict/v2/pix/claims/cancel

Cancel a key's DICT claim.

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

For more information, refer to Pix key transfer (key claim)

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

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

OWNERSHIP PORTABILITY
Reason Donor Claimer Donor Claimer
  WAITING_RESOLUTIONCONFIRMED
USER_REQUESTED√√√ 
ACCOUNT_CLOSURE√√√
FRAUD√√√√√
DEFAULT_OPERATION√√
RECONCILIATION√ √

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 Pix key claim status changed event.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Register DICT key request body

string
required

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

string
enum
required

Reason for request

Allowed:
Headers
string
required

Account token - token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

string
required

A unique UUID identifier 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.

Responses

Updated 21 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 21 days ago