Skip to main content
POST
/
v1
/
dict
/
claims
/
{claim_id}
/
cancel
Cancel a Claim
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/claims/{claim_id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '{}'
{
  "id": "019c96a0-0c3e-77b5-8321-4807058a67bb",
  "bacenClaimId": "019c96a0-0d16-7184-ad7f-38545eeb671c",
  "key": "+5561988887777",
  "keyType": "PHONE",
  "type": "OWNERSHIP",
  "status": "OPEN",
  "donorParticipant": "30306294",
  "resolutionPeriodEnd": "2024-01-22T10:30:00Z",
  "completionPeriodEnd": "2024-01-29T10:30:00Z",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Account-Id
string
required

Unique identifier of the Midaz Ledger Account (UUID format).

Path Parameters

​
claim_id
string
required

Unique identifier of the claim (UUID format).

Body

application/json

The body is of type object.

Response

Claim cancelled successfully.

​
id
string

Internal UUID of the claim.

Example:

"019c96a0-0c3e-77b5-8321-4807058a67bb"

​
bacenClaimId
string

BACEN DICT identifier for this claim.

Example:

"019c96a0-0d16-7184-ad7f-38545eeb671c"

​
key
string

The Pix key value being claimed.

Example:

"+5561988887777"

​
keyType
string

Type of Pix key.

Example:

"PHONE"

​
type
enum<string>

Type of claim.

Available options:
OWNERSHIP,
PORTABILITY
Example:

"OWNERSHIP"

​
status
enum<string>

Current status of the claim.

Available options:
OPEN,
WAITING_RESOLUTION,
CONFIRMED,
CANCELLED,
COMPLETED
Example:

"OPEN"

​
donorParticipant
string

ISPB of the donor PSP.

Example:

"30306294"

​
resolutionPeriodEnd
string<date-time>

Deadline for donor response (D+7 from creation).

Example:

"2024-01-22T10:30:00Z"

​
completionPeriodEnd
string<date-time>

Deadline for claim completion (D+14 from creation).

Example:

"2024-01-29T10:30:00Z"

​
createdAt
string<date-time>

Timestamp when the claim was created.

Example:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>

Timestamp when the claim was last updated.

Example:

"2024-01-15T10:30:00Z"