Webhooks

Instead of polling Get payment, register a webhook endpoint in the merchant dashboard and GoBTC Pay will notify you when a payment's status changes. The payment.status.updated event is delivered as an HTTP POST wrapped in a thin envelope, { eventId, type, createdAt, data }, where data matches the Get payment response.

Each delivery is signed. Verify the X-GoBTCPay-Signature: t=<unix>,v1=<hmac> header, where v1 = HMAC-SHA256(signingSecret, "{t}.{rawBody}") and the signingSecret is shown once when you create the endpoint. Delivery is at-least-once, so de-duplicate on eventId. Respond with any 2xx to acknowledge; non-2xx responses are retried.

This is the POS terminal surface of the GoBTC Pay API. Backwards compatibility is preserved across published versions.

Found an error in the docs? Email [email protected].