/
MA
masumi-network
/
Masumi Payment Service API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
Docs
History
Schema
Filter operations
api-key
5
balance
1
error-state-recovery
2
fund-distribution
2
fund-wallet
4
health
1
hydra
43
get
/hydra/invite
List head invites. (admin access required)
post
/hydra/invite
Mint a head invite. (admin access required)
delete
/hydra/invite
Revoke an unredeemed invite. (admin access required)
post
/hydra/invite/preview
Inspect an invite without acting on it. (admin access required)
post
/hydra/invite/redeem
Redeem a counterparty invite. (admin access required)
get
/hydra/host
List registered Hydra Hosts. (admin access required)
post
/hydra/host
Register a Hydra Host. (admin access required)
delete
/hydra/host
Remove a Hydra Host. (admin access required)
patch
/hydra/host
Update a Hydra Host. (admin access required)
post
/hydra/host/check
Probe a Hydra Host and record its capabilities. (admin access required)
get
/hydra/wallet-base
List candidate wallets for Hydra participants. (admin access required)
post
/hydra/wallet-base
Ensure a WalletBase exists for a Hydra counterparty. (admin access required)
get
/hydra/relation
List Hydra relations. (admin access required)
delete
/hydra/relation
Delete a Hydra relation. (admin access required)
get
/hydra/head
List or get Hydra heads. (admin access required)
patch
/hydra/head
Enable or disable a Hydra head. (admin access required)
post
/hydra/head/init
Run the Hydra head init lifecycle action. (admin access required)
post
/hydra/head/fanout
Run the Hydra head fanout lifecycle action. (admin access required)
post
/hydra/head/close
Run the Hydra head close lifecycle action. (admin access required)
post
/hydra/head/commit
Commit the local participant funds into the head. (admin access required)
get
/hydra/head/topup
List the deposits made into a head. (admin access required)
post
/hydra/head/topup
Top up additional funds into an open head. (admin access required)
get
/hydra/head/withdraw
List withdrawals from a head. (admin access required)
post
/hydra/head/withdraw
Withdraw funds from an open head back to L1. (admin access required)
get
/hydra/head/balance
Read this node's own in-head balance. (admin access required)
get
/hydra/head/transactions
List a Hydra head's transactions. (admin access required)
post
/hydra/head/topup/recover
Recover a deposit the head never absorbed. (admin access required)
get
/hydra/head/connection
Read the state of this service's connection to the head's node. (admin access required)
get
/hydra/head/errors
List recorded Hydra head errors. (admin access required)
delete
/hydra/head/errors
Clear the recorded errors for a head. (admin access required)
get
/hydra/participant/local/fund
Read a node's own balance and funding history. (admin access required)
post
/hydra/participant/local/fund
Send ADA to a node's own Cardano key. (admin access required)
patch
/hydra/participant/local/fund
Set optional automatic node funding limits. (admin access required)
post
/hydra/participant/local/withdraw
Sweep what a node did not spend back to its wallet. (admin access required)
get
/hydra/low-balance
List Hydra in-head low-balance rules. (admin access required)
post
/hydra/low-balance
Create or update a Hydra in-head low-balance rule. (admin access required)
delete
/hydra/low-balance
Delete a Hydra in-head low-balance rule. (admin access required)
get
/hydra/participant/local
List local Hydra participants. (admin access required)
delete
/hydra/participant/local
Delete a local Hydra participant. (admin access required)
post
/hydra/participant/local/keys
Back up a node's signing keys, once. (admin access required)
get
/hydra/participant/remote
List remote Hydra participants. (admin access required)
delete
/hydra/participant/remote
Delete a remote Hydra participant. (admin access required)
post
/hydra/head/chain-check
Read a Hydra head state on L1. (admin access required)
inbox-agents
8
invoice
4
monitoring
4
payment
10
payment-income
1
payment-source
5
purchase
9
purchase-spending
1
rail-readiness
1
registry
9
reports
7
request-repair
2
rpc-api-keys
1
signature
3
swap
6
tx-sync-quarantine
3
utxos
1
wallet
10
webhooks
5
x402
23
hydra
Copy Markdown
Copied
Copy failed
Changes to Read this node's own in-head balance. (admin access required)
get
/hydra/head/balance
Oct 3, 2026
315a2a763fb7
Revision changes
info
endpoint added
Oct 3, 2026
87b151d07425
Revision changes
breaking
api path removed without deprecation