Pular para o conteúdo principal
POST
Cancel a Key Claim

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Account-Id
string<uuid>
obrigatório

Account ID (UUID format)

X-Reason
enum<string>
obrigatório

Reason for cancellation: USER_REQUESTED, ACCOUNT_CLOSURE, DEFAULT_OPERATION, FRAUD, RECONCILIATION, COURT_ORDER (donor only)

Opções disponíveis:
USER_REQUESTED,
ACCOUNT_CLOSURE,
DEFAULT_OPERATION,
FRAUD,
RECONCILIATION,
COURT_ORDER

Parâmetros de caminho

claim_id
string<uuid>
obrigatório

Claim ID (UUID)

Resposta

OK

accountId
string
obrigatório

Unique identifier of the account associated with this claim

Exemplo:

"550e8400-e29b-41d4-a716-446655440002"

bacenClaimId
string
obrigatório

BACEN DICT identifier for this claim

Exemplo:

"cc91b1b0-8465-44b1-a760-15dd3717ea9b"

cancelReason
string
obrigatório

Reason for cancellation

Exemplo:

"FRAUD"

cancelledBy
string
obrigatório

Who cancelled the claim (DONOR or CLAIMER)

Exemplo:

"DONOR"

claimer
object
obrigatório

Account owner information

claimerAccount
object
obrigatório

Account information of the claimer

completedAt
string<date-time>
obrigatório

Timestamp when the claim was completed (ISO 8601 UTC)

Exemplo:

"2020-08-31T13:48:55.970Z"

completionPeriodEnd
string<date-time>
obrigatório

Deadline for claim completion - D+14 from creation (ISO 8601 UTC)

Exemplo:

"2020-09-14T13:48:55.970Z"

confirmReason
string
obrigatório

Reason the claim was confirmed

Exemplo:

"DEFAULT_OPERATION"

createdAt
string<date-time>
obrigatório

Timestamp when the claim was created (ISO 8601 UTC)

Exemplo:

"2020-08-17T13:48:36Z"

donorParticipant
string
obrigatório

ISPB of the donor PSP (current key holder)

Exemplo:

"30306294"

holderId
string
obrigatório

UUID of the account holder (claimer)

Exemplo:

"550e8400-e29b-41d4-a716-446655440001"

id
string
obrigatório

Internal UUID of the claim

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

key
string
obrigatório

The PIX key value (phone, email, CPF, CNPJ, or EVP)

Exemplo:

"+5561988887777"

keyType
string
obrigatório

Type of PIX key

Exemplo:

"PHONE"

resolutionPeriodEnd
string<date-time>
obrigatório

Deadline for donor response - D+7 from creation (ISO 8601 UTC)

Exemplo:

"2020-08-31T13:48:55.970Z"

status
string
obrigatório

Current status of the claim

Exemplo:

"CANCELLED"

type
string
obrigatório

Type of claim (OWNERSHIP or PORTABILITY)

Exemplo:

"OWNERSHIP"

updatedAt
string<date-time>
obrigatório

Timestamp when the claim was last updated (ISO 8601 UTC)

Exemplo:

"2024-01-20T14:45:00Z"