Skip to content

Hosted checkout

Every invoice and deposit has a ready-made payment page. Send the customer the payment_url returned by the API once the address is available.

The page shows the token, network, address, QR code and payment status. You do not need to build a checkout yourself.

Use payment_url exactly as returned. Do not build a URL from the issuance ID or assume a fixed format for public_id.

The customer must send the displayed token on the displayed network. Sending a different token or using a different network does not pay the invoice.

Edit branding in the dashboard or use an owner session:

PATCH /api/v1/shops/{shop_id}/branding
Authorization: Bearer <owner-session-token>
Idempotency-Key: <saved-unique-key>
Content-Type: application/json
{"name":"My shop"}

Branding controls the displayed shop name and logo. Set a payment’s return_url when creating the invoice or deposit. Neither changes the payout recipient.

The return link is for navigation. A customer opening it is not proof of payment.

Use Invoice and deposit status to read the status from your backend, or verify a signed webhook. Keep API keys on the server; never put them in the payment link or browser code.