API Reference
Programmatic access to the Bleepay payment protocol — vouchers, widgets, on-chain settlement.Bleepay’s REST API lets you create payment vouchers, manage widget integrations, monitor on-chain settlement, and configure business accounts. The API is organized around the core payment primitives: contexts, vouchers, and sessions.
Base URL
Environments
API reference
Introduction
- Authentication — API keys and bearer tokens
Auth
- Sign in — Authenticate as a user to obtain a JWT bearer token
- Sign up — Create a new user account
- Get challenge — Get a verification challenge
Vouchers
- Open context — Start a payment context
- Get context — Retrieve a context by ID
- Query contexts — List all contexts
- Close context — Close a payment context
- Reserve voucher — Reserve a voucher from a context code
- Redeem voucher — Set payment terms (SIMPLE or CUSTOM)
- Resolve voucher — Submit signed transaction receipts
- Negotiate voucher — Propose an alternative payment
- Sign voucher — Sign a voucher with a public key
- Discard voucher — Discard an unused voucher
- Get voucher — Retrieve a voucher by ID
- Query vouchers — List all vouchers
- Submit interop signature — Cross-chain signature submission
- Get interop status — Check cross-chain signature status
Sessions
- Open session — Start a multi-voucher session
- Get session — Retrieve a session by ID
- Join session — Join a session as payer
- Close session — Close a session
- Reserve voucher in session — Reserve a voucher within a session
Finance
- Get networks — Supported blockchain networks
- Get currencies — Supported currencies and tokens
- Convert amount — Convert an amount between currencies
Widgets
Management
- Create widget — Configure a new widget
- Get widget — Retrieve a widget by ID
- Query widgets — List business widgets
- Update widget — Update widget configuration
- Enable widget — Enable a widget
- Disable widget — Disable a widget
- Delete widget — Delete a widget
Public
- Get public config — Get public widget configuration
- Create deposit session — Start a customer deposit
- Create session voucher — Create deposit session with reserved voucher
- Get deposit session — Check deposit session status
- Cancel deposit session — Cancel a deposit session
Deposits
- Query deposit sessions — List deposit sessions
- Search deposit sessions — Search deposit sessions
- Query deposits — List on-chain payments
- Get deposit — Retrieve a payment by ID
- Query widget events — List widget events
- Get widget event — Retrieve a widget event by ID
Charts
- Get charts — Retrieve aggregated payment chart data
Refunds
- Create refund session — Create a refund session
- Create refund session voucher — Create refund session with reserved voucher
- Query refund sessions — List refund sessions
- Get refund session — Retrieve a refund session by ID
- Cancel refund session — Cancel a refund session
Webhooks
- Create endpoint — Register a webhook endpoint
- Get endpoint — Retrieve an endpoint by ID
- Query endpoints — List webhook endpoints
- Update endpoint — Update endpoint configuration
- Rotate secret — Rotate the signing secret
- Enable endpoint — Enable an endpoint
- Disable endpoint — Disable an endpoint
- Delete endpoint — Delete an endpoint
- Query deliveries — List webhook deliveries
- Get delivery — Retrieve a delivery by ID
- Retry delivery — Retry a failed delivery
Accounts
- Get account — Retrieve an account by ID
- Query accounts — List business accounts