> For the complete documentation index, see [llms.txt](https://docs.gobtcpay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gobtcpay.com/api-reference/wallet-api/wallet.md).

# Wallet

Wallet lifecycle and read access: register a device key, resolve the multisig address, and read balances and UTXOs.

## Register wallet

> Registers the user's wallet public key and provisions their multisig wallet — the user's main wallet that all payments are spent from. Call this once after generating the key pair; returns the multisig \`address\`.

```json
{"openapi":"3.1.0","info":{"title":"GoBTC Pay Wallet API","version":"1.45.2"},"tags":[{"name":"Wallet","description":"Wallet lifecycle and read access: register a device key, resolve the multisig address, and read balances and UTXOs."}],"servers":[{"url":"https://api.gobtcpay.com/public/api/v1.1"}],"security":[{"walletAuth":[]}],"components":{"securitySchemes":{"walletAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Wallet access token obtained from `/instant/auth/get-jwt` via the signature challenge flow. Send it as `Authorization: Bearer <accessToken>`. Refresh it via `/instant/auth/refresh-jwt` when it expires."}}},"paths":{"/instant/wallet/register":{"post":{"summary":"Register wallet","description":"Registers the user's wallet public key and provisions their multisig wallet — the user's main wallet that all payments are spent from. Call this once after generating the key pair; returns the multisig `address`.","tags":["Wallet"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userPubKeyHex":{"type":"string","description":"Public key of the user's Bitcoin wallet — compressed secp256k1 key, hex (33 bytes). Becomes a signer of the new multisig wallet."}},"required":["userPubKeyHex"],"additionalProperties":false,"$schema":"http://json-schema.org/draft-07/schema#"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"object","properties":{"$case":{"type":"string","const":"success"},"success":{"type":"object","properties":{"address":{"type":"string","description":"The user's newly provisioned multisig wallet address."}},"required":["address"],"additionalProperties":false}},"required":["$case","success"],"additionalProperties":false}},"required":["id","result"],"additionalProperties":false,"$schema":"http://json-schema.org/draft-07/schema#"}}}},"500":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"number","description":"Numeric error status code."},"description":{"type":"string","description":"Human-readable description."},"statusMessage":{"type":"string","description":"Short machine-readable error message."}},"required":["statusCode","description","statusMessage"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"$schema":"http://json-schema.org/draft-07/schema#"}}}}}}}}}
```

## Get wallet address

> Returns the authenticated user's multisig wallet \`address\`.

```json
{"openapi":"3.1.0","info":{"title":"GoBTC Pay Wallet API","version":"1.45.2"},"tags":[{"name":"Wallet","description":"Wallet lifecycle and read access: register a device key, resolve the multisig address, and read balances and UTXOs."}],"servers":[{"url":"https://api.gobtcpay.com/public/api/v1.1"}],"security":[{"walletAuth":[]}],"components":{"securitySchemes":{"walletAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Wallet access token obtained from `/instant/auth/get-jwt` via the signature challenge flow. Send it as `Authorization: Bearer <accessToken>`. Refresh it via `/instant/auth/refresh-jwt` when it expires."}}},"paths":{"/instant/wallet/get":{"post":{"summary":"Get wallet address","description":"Returns the authenticated user's multisig wallet `address`.","tags":["Wallet"],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"object","properties":{"$case":{"type":"string","const":"success"},"success":{"type":"object","properties":{"address":{"type":"string","description":"The user's multisig wallet address."}},"required":["address"],"additionalProperties":false}},"required":["$case","success"],"additionalProperties":false}},"required":["id","result"],"additionalProperties":false,"$schema":"http://json-schema.org/draft-07/schema#"}}}},"500":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"number","description":"Numeric error status code."},"description":{"type":"string","description":"Human-readable description."},"statusMessage":{"type":"string","description":"Short machine-readable error message."}},"required":["statusCode","description","statusMessage"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"$schema":"http://json-schema.org/draft-07/schema#"}}}}}}}}}
```

## Get balances

> Returns the wallet's balances broken down by state — on-chain (confirmed / unconfirmed), signed, locked, and the spendable \`leftBalance\` — all in satoshis. \`leftBalanceInUsd\` / \`leftBalanceInCurrency\` give the fiat equivalent (null when a rate is unavailable). Pass \`currency\` to choose the fiat conversion.

```json
{"openapi":"3.1.0","info":{"title":"GoBTC Pay Wallet API","version":"1.45.2"},"tags":[{"name":"Wallet","description":"Wallet lifecycle and read access: register a device key, resolve the multisig address, and read balances and UTXOs."}],"servers":[{"url":"https://api.gobtcpay.com/public/api/v1.1"}],"security":[{"walletAuth":[]}],"components":{"securitySchemes":{"walletAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Wallet access token obtained from `/instant/auth/get-jwt` via the signature challenge flow. Send it as `Authorization: Bearer <accessToken>`. Refresh it via `/instant/auth/refresh-jwt` when it expires."}}},"paths":{"/instant/wallet/get-balances":{"post":{"summary":"Get balances","description":"Returns the wallet's balances broken down by state — on-chain (confirmed / unconfirmed), signed, locked, and the spendable `leftBalance` — all in satoshis. `leftBalanceInUsd` / `leftBalanceInCurrency` give the fiat equivalent (null when a rate is unavailable). Pass `currency` to choose the fiat conversion.","tags":["Wallet"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string","description":"Optional fiat currency for the converted balance fields (e.g. `USD`)."}},"additionalProperties":false,"$schema":"http://json-schema.org/draft-07/schema#"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"object","properties":{"$case":{"type":"string","const":"success"},"success":{"type":"object","properties":{"onChainBalance":{"type":"number","description":"Total balance seen on-chain (confirmed + unconfirmed), in satoshis."},"confirmedOnChainBalance":{"type":"number","description":"On-chain balance with at least one confirmation, in satoshis."},"unconfirmedOnChainBalance":{"type":"number","description":"On-chain balance still in the mempool (0-conf), in satoshis."},"signedBalance":{"type":"number","description":"Balance reserved by transactions that have been signed but not yet broadcast, in satoshis."},"lockedBalance":{"type":"number","description":"Balance locked in pending payments / withdrawals, in satoshis."},"leftBalance":{"type":"number","description":"Spendable balance available for new transactions, in satoshis."},"leftBalanceInUsd":{"type":["number","null"],"description":"`leftBalance` converted to USD (null if no rate is available)."},"leftBalanceInCurrency":{"type":["number","null"],"description":"`leftBalance` converted to the requested `currency` (null if no rate is available)."}},"required":["onChainBalance","confirmedOnChainBalance","unconfirmedOnChainBalance","signedBalance","lockedBalance","leftBalance","leftBalanceInUsd","leftBalanceInCurrency"],"additionalProperties":false}},"required":["$case","success"],"additionalProperties":false}},"required":["id","result"],"additionalProperties":false,"$schema":"http://json-schema.org/draft-07/schema#"}}}},"500":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"number","description":"Numeric error status code."},"description":{"type":"string","description":"Human-readable description."},"statusMessage":{"type":"string","description":"Short machine-readable error message."}},"required":["statusCode","description","statusMessage"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"$schema":"http://json-schema.org/draft-07/schema#"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.gobtcpay.com/api-reference/wallet-api/wallet.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.