Skip to content

docs(express): wallet update api definition #7629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 26, 2025
Merged

docs(express): wallet update api definition #7629

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions modules/express/src/typedRoutes/api/v2/expressWalletUpdate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ export const ExpressWalletUpdateBody = {
signerTlsCert: t.string,
/** (Optional) The signer macaroon for the lighting signer node. */
signerMacaroon: optional(t.string),
/** The wallet passphrase (used locally to decrypt and sign). */
/** The wallet passphrase. This is not uploaded to BitGo, but used to decrypt userAuthKey used to sign the request before sending to BitGo. */
passphrase: t.string,
} as const;

/**
* Response for Express Wallet Update
*/
export const ExpressWalletUpdateResponse = {
/** Updated Wallet - Returns the wallet with updated Lightning signer configuration */
/** Success - Returns the wallet with updated Lightning signer configuration */
200: WalletResponse,
/** Bad Request - Invalid parameters or missing required fields */
400: BitgoExpressError,
Expand All @@ -44,10 +44,11 @@ export const ExpressWalletUpdateResponse = {
/**
* Express - Update Wallet
* The express update wallet route is meant to be used for lightning (lnbtc/tlnbtc).
* It will produced a signed wallet update request that can be used to update the wallet.
* For other coins, use the standard wallet update endpoint.
*
* @operationId express.wallet.update
* @tag express
* @tag Express
*/
export const PutExpressWalletUpdate = httpRoute({
path: '/express/api/v2/{coin}/wallet/{id}',
Expand Down