get_wallet_balance
Retrieve confirmed and unconfirmed balance for a BTCPay Server on-chain wallet to monitor payment method funds.
Instructions
Get wallet balance for a payment method (on-chain wallet).
Args: payment_method_id: Payment method ID (e.g., 'BTC' for the store's default BTC wallet). Leave empty to use the first BTC-like method.
Returns confirmed/unconfirmed balance for the wallet.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| payment_method_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |