Skip to main content
GET
/
api
/
wallets
/
holds
/
{holdID}
Get a hold
curl --request GET \
  --url http://localhost/api/wallets/holds/{holdID} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "walletID": "<string>",
    "metadata": {},
    "asset": "<string>",
    "description": "<string>",
    "remaining": 10,
    "originalAmount": 100,
    "destination": {
      "type": "<string>",
      "identifier": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.formance.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Holds

data
object
required