Get the allowance

Auth Node Token or read token
Guide Mandates

GET

/v1/wallets/{walletId}/allowance

What the wallet can still spend: per rule, the limit, what is used and what remains (engine), and the period ceiling read from the wallet’s on-chain datum (chain). discrepancy is true when the two disagree beyond held and signed-but-not-landed amounts.

Authorization

headerAuthorizationBearer <token>

Node Token from the Exchain console. Works for wallets this node registered; the node’s network (preprod or mainnet) decides the network of the request. Use a preprod token in the playground.

Path Parameters

walletId*string

Wallet id returned at registration: wal_ and 26 Crockford base32 characters.

Match^wal_[0-9A-HJKMNP-TV-Z]{26}$

Response Body

The allowance.

application/json

response

walletId*WalletId

Match^wal_[0-9A-HJKMNP-TV-Z]{26}$

engine*

chain*|null

discrepancy*boolean

assets?array<>

A Cardano wallet's engine and chain view per governed asset; engine, chain and discrepancy describe the first.

asOf*string

Match^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\.[0-9]{3}Z$

Formatdate-time

schemaVersion*string

Wire schema version, "1.1" today.

Value in"1.0""1.1"

chainTip*|null

Example Request

curl -X GET 'https://cosign.exchain.network/v1/wallets/wal_01J9XK3M4N5P6Q7R8S9T0V1W2Z/allowance'

Example Request

curl -X GET 'https://cosign.exchain.network/v1/wallets/wal_01J9XK3M4N5P6Q7R8S9T0V1W2Z/allowance'

Example ResponseSchema

{
  "walletId": "wal_01J9XK3M4N5P6Q7R8S9T0V1W2Z",
  "engine": {
    "per_tx_cap": {
      "limit": "200000000",
      "used": "199000000",
      "remaining": "1000000"
    },
    "velocity_burst": {
      "limit": "10",
      "used": "2",
      "remaining": "8",
      "windowResetsAt": "2026-11-05T14:23:07Z"
    },
    "daily_outflow": {
      "limit": "8000000000",
      "used": "3410000000",
      "remaining": "4590000000",
      "windowResetsAt": "2026-11-06T09:12:40Z"
    },
    "per_seller_cap": {
      "limit": "500000000",
      "used": "199000000",
      "remaining": "301000000",
      "windowResetsAt": "2026-11-06T14:22:07Z",
      "scope": "sellerVkeyHash:012fde0a6fa2c5f3233b3cf1a9f4281fc3c766da7feea4310c00718b"
    },
    "per_agent_cap": {
      "limit": "4000000000",
      "used": "1940000000",
      "remaining": "2060000000",
      "windowResetsAt": "2026-11-06T09:12:40Z",
      "scope": "67ab0c92c4ac1610895a1c965ee50aba41a8f1513b15240723b3bd0b6167656e742d7265736561726368"
    },
    "envelope": {
      "limit": "200000000000",
      "used": "3410000000",
      "remaining": "196590000000"
    }
  },
  "chain": {
    "periodLimit": "8000000000",
    "spentInPeriod": "3410000000",
    "periodStart": "2026-11-05T00:00:00Z",
    "periodLength": 86400,
    "asOfSlot": 104118120
  },
  "discrepancy": false,
  "assets": [
    {
      "asset": "lovelace",
      "engine": {
        "per_tx_cap": {
          "limit": "200000000",
          "used": "199000000",
          "remaining": "1000000"
        },
        "velocity_burst": {
          "limit": "10",
          "used": "2",
          "remaining": "8",
          "windowResetsAt": "2026-11-05T14:23:07Z"
        },
        "daily_outflow": {
          "limit": "8000000000",
          "used": "3410000000",
          "remaining": "4590000000",
          "windowResetsAt": "2026-11-06T09:12:40Z"
        },
        "per_seller_cap": {
          "limit": "500000000",
          "used": "199000000",
          "remaining": "301000000",
          "windowResetsAt": "2026-11-06T14:22:07Z",
          "scope": "sellerVkeyHash:012fde0a6fa2c5f3233b3cf1a9f4281fc3c766da7feea4310c00718b"
        },
        "per_agent_cap": {
          "limit": "4000000000",
          "used": "1940000000",
          "remaining": "2060000000",
          "windowResetsAt": "2026-11-06T09:12:40Z",
          "scope": "67ab0c92c4ac1610895a1c965ee50aba41a8f1513b15240723b3bd0b6167656e742d7265736561726368"
        },
        "envelope": {
          "limit": "200000000000",
          "used": "3410000000",
          "remaining": "196590000000"
        }
      },
      "chain": {
        "periodLimit": "8000000000",
        "spentInPeriod": "3410000000",
        "periodStart": "2026-11-05T00:00:00Z",
        "periodLength": 86400,
        "asOfSlot": 104118120
      }
    }
  ],
  "asOf": "2026-11-05T14:22:07.318Z",
  "schemaVersion": "1.1",
  "chainTip": {
    "slot": 104118120,
    "blockHash": "9a301ac2e5747e7ebeeecececd2f114f55695614277514e085211c5417d04c26"
  }
}

{  "walletId": "wal_01J9XK3M4N5P6Q7R8S9T0V1W2Z",  "engine": {    "per_tx_cap": {      "limit": "200000000",      "used": "199000000",      "remaining": "1000000"    },    "velocity_burst": {      "limit": "10",      "used": "2",      "remaining": "8",      "windowResetsAt": "2026-11-05T14:23:07Z"    },    "daily_outflow": {      "limit": "8000000000",      "used": "3410000000",      "remaining": "4590000000",      "windowResetsAt": "2026-11-06T09:12:40Z"    },    "per_seller_cap": {      "limit": "500000000",      "used": "199000000",      "remaining": "301000000",      "windowResetsAt": "2026-11-06T14:22:07Z",      "scope": "sellerVkeyHash:012fde0a6fa2c5f3233b3cf1a9f4281fc3c766da7feea4310c00718b"    },    "per_agent_cap": {      "limit": "4000000000",      "used": "1940000000",      "remaining": "2060000000",      "windowResetsAt": "2026-11-06T09:12:40Z",      "scope": "67ab0c92c4ac1610895a1c965ee50aba41a8f1513b15240723b3bd0b6167656e742d7265736561726368"    },    "envelope": {      "limit": "200000000000",      "used": "3410000000",      "remaining": "196590000000"    }  },  "chain": {    "periodLimit": "8000000000",    "spentInPeriod": "3410000000",    "periodStart": "2026-11-05T00:00:00Z",    "periodLength": 86400,    "asOfSlot": 104118120  },  "discrepancy": false,  "assets": [    {      "asset": "lovelace",      "engine": {        "per_tx_cap": {          "limit": "200000000",          "used": "199000000",          "remaining": "1000000"        },        "velocity_burst": {          "limit": "10",          "used": "2",          "remaining": "8",          "windowResetsAt": "2026-11-05T14:23:07Z"        },        "daily_outflow": {          "limit": "8000000000",          "used": "3410000000",          "remaining": "4590000000",          "windowResetsAt": "2026-11-06T09:12:40Z"        },        "per_seller_cap": {          "limit": "500000000",          "used": "199000000",          "remaining": "301000000",          "windowResetsAt": "2026-11-06T14:22:07Z",          "scope": "sellerVkeyHash:012fde0a6fa2c5f3233b3cf1a9f4281fc3c766da7feea4310c00718b"        },        "per_agent_cap": {          "limit": "4000000000",          "used": "1940000000",          "remaining": "2060000000",          "windowResetsAt": "2026-11-06T09:12:40Z",          "scope": "67ab0c92c4ac1610895a1c965ee50aba41a8f1513b15240723b3bd0b6167656e742d7265736561726368"        },        "envelope": {          "limit": "200000000000",          "used": "3410000000",          "remaining": "196590000000"        }      },      "chain": {        "periodLimit": "8000000000",        "spentInPeriod": "3410000000",        "periodStart": "2026-11-05T00:00:00Z",        "periodLength": 86400,        "asOfSlot": 104118120      }    }  ],  "asOf": "2026-11-05T14:22:07.318Z",  "schemaVersion": "1.1",  "chainTip": {    "slot": 104118120,    "blockHash": "9a301ac2e5747e7ebeeecececd2f114f55695614277514e085211c5417d04c26"  }}

Errors

Status	Code	Meaning
`401`	`unauthorized`	The bearer credential is missing, unknown or revoked.
`404`	`not_found`	The wallet does not exist, this node did not register it, or the read token is for another wallet.

Every code and what to do about it: Errors and codes.

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

ErrorsCopy Anchor Link

Authorization

Path Parameters

Response Body

Errors