GoBTC Pay Merchant Account API endpoints

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

Merchant dashboard sign-in: email/password, OAuth, passkeys, TOTP 2FA, sessions, token refresh, and switching the active merchant context.

Manage the merchant's stores: create, read, update, and delete.

Manage POS terminals within a store, including issuing and rotating their API keys.

Team members, roles, and invitations for the merchant account.

Sales summaries, transaction and aggregated reports, and async exports.

Configure outbound webhook endpoints (URL, scope, signing secret) so your backend is notified when a payment's status changes, an alternative to polling Get payment.

Aggregated home-screen summary: balance, today's metrics, the 7-day chart, and recent payments in a single call.

The merchant's public business profile, display name, description, category, support email, and logo.

Link a receiving wallet by scanning a QR with the mobile app: start a link session and poll its status.

Issue, list, rotate, and revoke Web SDK integration keys (publishable / secret).

Per-event notification preferences across email, in-app, and SMS channels.

Read the merchant's audit log of account actions.

Custodial merchants only: manage saved BTC destination wallets and withdraw the Uphold balance to them, including the Uphold Travel Rule verification a held withdrawal may require.

Custodial merchants only, register, list, inspect, and remove ACH bank accounts (Uphold External Accounts) used as off-ramp destinations.

Custodial merchants only, sell BTC from the Uphold account and send USD to a registered bank account, including the Travel Rule compliance step when required. Amounts are denominated in satoshi (BTC debit) and USD (bank destination).