Get a hold

GET /api/wallets/holds/{holdID}

Try it

Get a hold

cURL

curl --request GET \
  --url http://localhost/api/wallets/holds/{holdID} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "walletID": "<string>",
    "metadata": {},
    "asset": "<string>",
    "description": "<string>",
    "remaining": 10,
    "originalAmount": 100,
    "destination": {
      "type": "<string>",
      "identifier": "<string>"
    }
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

holdID · string · required

The hold ID

Response

200

application/json

Holds

data · object · required

Show child attributes

data. id · string<uuid> · required

The unique ID of the hold.

data. walletID · string · required

The ID of the wallet the hold is associated with.

data. metadata · object · required

Metadata associated with the hold.

Show child attributes

data.metadata. {key} · string

data. asset · string · required

data. description · string · required

data. remaining · integer<bigint> · required

Remaining amount on hold

Example:

10

data. originalAmount · integer<bigint> · required

Original amount on hold

Example:

100

data. destination · object

Option 1

Show child attributes

data.destination. type · string · required

data.destination. identifier · string · required