GET
/
v1
/
claims
/
{claimId}
Retrieve claim details
curl --request GET \
  --url http://localhost:4011/v1/claims/{claimId} \
  --header 'Authorization: Bearer <token>'
{
  "claimId": "claim-abc123-def456-789012",
  "key": "12345678901",
  "bankId": "12345678",
  "claimType": 0,
  "status": 0,
  "createdAt": "2024-09-20T10:00:00.000Z",
  "resolutionDeadline": "2024-09-27T10:00:00.000Z",
  "lastUpdated": "2024-09-20T10:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

Path Parameters

​
claimId
string
required

Claim ID to retrieve

Query Parameters

​
account_id
string<uuid>
required

Account ID requesting the claim details

Response

Claim details retrieved successfully

​
claimId
string

Claim identifier

Example:

"claim-abc123-def456-789012"

​
key
string

Pix key being claimed

Example:

"12345678901"

​
bankId
string

Bank identification number

Example:

"12345678"

​
claimType
enum<integer>

Claim type enumeration.

Available options:
0,
1
​
status
enum<integer>

Claim status enumeration (0- OPEN, 1- WAITING_RESOLUTION, 2- CONFIRMED, 3- CANCELLED, 4- CONCLUDED).

Available options:
0,
1,
2,
3,
4
​
createdAt
string<date-time>

Claim creation timestamp

Example:

"2024-09-20T10:00:00.000Z"

​
resolutionDeadline
string<date-time>

Resolution deadline

Example:

"2024-09-27T10:00:00.000Z"

​
lastUpdated
string<date-time>

Last update timestamp

Example:

"2024-09-20T10:00:00.000Z"