Skip to main content

Retrieve a Claimable Balance REST API Endpoint

Retrieves details about a specific claimable balance in the network

Updated on
Oct 04, 2023

Path Parameters

claimable_balance_id
string
REQUIRED

A unique identifier for this claimable balance

Returns

_links
object

Links related to the claimable balance

self
object

Link to the claimable balance itself

href
string

The URL of the claimable balance

templated
boolean

A boolean value that indicates whether the link is templated or not

transactions
object

Link to the transactions related to the claimable balance

href
string

The URL template for transactions related to the claimable balance

templated
boolean

A boolean value that indicates whether the link is templated or not

operations
object

Link to the operations related to the claimable balance

href
string

The URL template for operations related to the claimable balance

templated
boolean

A boolean value that indicates whether the link is templated or not

id
string

The claimable balance ID

paging_token
string

The paging token for the offer record, aiding in navigation

asset
string

The type of asset in the claimable balance

amount
string

The amount of the asset that can be claimed

sponsor
string

The account id of the sponsor who is paying the reserves for this claimable balance

last_modified_ledger
number | string

Ledger sequence number of the last modification

last_modified_time
string | null

Timestamp of the last modification

claimants
array

The list of claimants for the claimable balance

destination
string

Destination of the claimant

predicate
object

Predicate conditions for the claimant

and
array

An array of AND conditions

flags
object

The flags related to the claimable balance

clawback_enabled
boolean

Clawback enabled flag

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free