gobtc payDocs

SDK Reference

The reference for the GoBTC Pay SDKs: what each one exposes, from packages down to methods, types, events, and errors.

Available SDKs

SDKPackageReferenceStatus
POS API SDK@gobtcpay/pos-api-sdkPOS API SDK referencePublished
PHP SDKgobtcpay/php-merchant-sdkPHP SDK referencePublished
POS API SDKThe official client for the POS API surface. Create a payment, show the QR, track it to settlement, from a server or the browser.PHP SDKThe PHP client for the POS terminal and the shop backend. Create a payment, verify webhooks, and poll from a background job.Web SDK integration guideHow the terminal key fits into a website checkout.

The POS API SDK is the official client for the POS API surface. The same package works both on a server and in the browser, so you create a payment, show the QR, and track it until it settles from either place.

It uses the Web Crypto API rather than node:crypto, which is why one build covers Node 18+, bundled browser apps, and plain HTML pages. The API version is pinned inside the package, so there is no version string in your URLs.

Note

The SDK signs every request with a fresh HMAC signature and timestamp, so there is no token to manage or refresh. The trade-off is that the terminal key must stay somewhere you control.

See the POS API SDK reference for the full API.