Retrieve a Claimable Balance

The single claimable balance endpoint provides information on a claimable balance.

Path Parameters

• claimable_balance_id string required

  A unique identifier for this claimable balance.

Responses

• 200

---

Success

application/json

• Schema
• Example (from schema)
• RetrieveAClaimableBalance

---

Schema

• _links object

  self object

  href link

  templated boolean

  operations object

  href link

  templated boolean

  transactions object

  href link

  templated boolean
• id string
• asset string
• amount string
• sponsor string
• last_modified_ledger string
• last_modified_time string
• claimants object[]

  Array [

  destination string

  Possible values: Value must match regular expression G[A-Z0-9]{55}

  predicate object

  and object[]

  Array [

  or object[]

  Array [

  relBefore string

  absBefore string

  absBeforeEpoch string

  ]

  not object

  unconditional boolean

  relBefore string

  absBefore string

  absBeforeEpoch string

  ]

  ]
• flags integer
• paging_token string

{
  "_links": {
    "self": {
      "href": "string",
      "templated": true
    },
    "operations": {
      "href": "string",
      "templated": true
    },
    "transactions": {
      "href": "string",
      "templated": true
    }
  },
  "id": "string",
  "asset": "string",
  "amount": "string",
  "sponsor": "string",
  "last_modified_ledger": "string",
  "last_modified_time": "string",
  "claimants": [
    {
      "destination": "string",
      "predicate": {
        "and": [
          {
            "or": [
              {
                "relBefore": "string",
                "absBefore": "string",
                "absBeforeEpoch": "string"
              }
            ],
            "not": {
              "unconditional": true,
              "relBefore": "string",
              "absBefore": "string",
              "absBeforeEpoch": "string"
            }
          }
        ]
      }
    }
  ],
  "flags": 0,
  "paging_token": "string"
}

{
  "_links": {
    "self": {
      "href": "https://horizon.stellar.org/claimable_balances/000000000102030000000000000000000000000000000000000000000000000000000000"
    },
    "operations": {
      "href": "https://horizon.stellar.org/claimable_balances/000000000102030000000000000000000000000000000000000000000000000000000000/operations{?cursor,limit,order}",
      "templated": true
    },
    "transactions": {
      "href": "https://horizon.stellar.org/claimable_balances/000000000102030000000000000000000000000000000000000000000000000000000000/transactions{?cursor,limit,order}",
      "templated": true
    }
  },
  "id": "000000000102030000000000000000000000000000000000000000000000000000000000",
  "paging_token": "000000000102030000000000000000000000000000000000000000000000000000000000",
  "asset": "native",
  "amount": "10.0000000",
  "claimants": [
    {
      "destination": "GC3C4AKRBQLHOJ45U4XG35ESVWRDECWO5XLDGYADO6DPR3L7KIDVUMML",
      "predicate": {
        "and": [
          {
            "or": [
              {
                "relBefore": "12"
              },
              {
                "absBefore": "2020-08-26T11:15:39Z",
                "absBeforeEpoch": "1598440539"
              }
            ]
          },
          {
            "not": {
              "unconditional": true
            }
          }
        ]
      }
    }
  ],
  "last_modified_ledger": 28411995,
  "last_modified_time": "2020-02-26T19:29:16Z"
}

Loading...