26 operations · v1.2

GoBTC Pay Wallet API endpoints

For non-custodial web3 wallets. Generated from the OpenAPI specification, grouped by area.

Base URL

https://api.gobtcpay.com/public/api/v1.2

Auth · merchantAuth

Merchant dashboard access token obtained from /merchant/auth/login (or the OAuth / passkey / 2FA login flows). Send it as Authorization: Bearer <accessToken>. Refresh it via /merchant/auth/refresh when it expires.

Auth · walletAuth

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.

Download OpenAPI spec

Areas

Authentication3 endpoints

Challenge-response authentication. Request a message to sign with the wallet key, exchange the signature for a JWT pair, and refresh it.

POSTGet sign-in challengePOSTGet access tokensPOSTRefresh access tokens

Wallet3 endpoints

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

POSTRegister walletPOSTGet wallet addressPOSTGet balances

Payments6 endpoints

Create and inspect payments, list payment history, and build / submit the signed transaction that settles a payment.

POSTGet paymentPOSTList paymentsPOSTBuild payment transactionPOSTSettle paymentPOSTList on-chain transactionsPOSTCancel payment

Multisig Withdrawal3 endpoints

On-chain multisig withdrawal flow: fetch signing data, build a PSBT, and broadcast it once co-signed.

POSTGet withdrawal parametersPOSTBuild withdrawal transactionPOSTBroadcast withdrawal

Self-Custody Wallet11 endpoints

POSTGet network parametersPOSTRegister walletPOSTGet walletPOSTGet balancesPOSTResync with the blockchainPOSTAdd address+5 more