> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bleepay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

```text theme={null}
https://payments.bleepay.com/api/v1
```

## Environments

| Environment    | Base URL                              | Use case               |
| -------------- | ------------------------------------- | ---------------------- |
| **Sandbox**    | `https://sandbox.bleepay.com/api/v1`  | Testing; no real funds |
| **Production** | `https://payments.bleepay.com/api/v1` | Live payments          |

## API reference

### Introduction

* [Authentication](/api-reference/introduction/authentication) — API keys, bearer tokens, and resource-based auth

### Auth

* [Sign in](/api-reference/auth/sign-in) — Authenticate as a user or with a resource
* [Sign up](/api-reference/auth/sign-up) — Create a new user account
* [Get challenge](/api-reference/auth/get-challenge) — Get a verification challenge

### Vouchers

* [Open context](/api-reference/vouchers/contexts/open-context) — Start a payment context
* [Get context](/api-reference/vouchers/contexts/get-context) — Retrieve a context by ID
* [Query contexts](/api-reference/vouchers/contexts/query-contexts) — List all contexts
* [Close context](/api-reference/vouchers/contexts/close-context) — Close a payment context
* [Reserve voucher](/api-reference/vouchers/reserve-voucher) — Reserve a voucher from a context code
* [Redeem voucher](/api-reference/vouchers/redeem-voucher) — Set payment terms (SIMPLE or CUSTOM)
* [Resolve voucher](/api-reference/vouchers/resolve-voucher) — Submit signed transaction receipts
* [Negotiate voucher](/api-reference/vouchers/negotiate-voucher) — Propose an alternative payment
* [Sign voucher](/api-reference/vouchers/sign-voucher) — Sign a voucher with a public key
* [Discard voucher](/api-reference/vouchers/discard-voucher) — Discard an unused voucher
* [Get voucher](/api-reference/vouchers/get-voucher) — Retrieve a voucher by ID
* [Query vouchers](/api-reference/vouchers/query-vouchers) — List all vouchers
* [Submit interop signature](/api-reference/vouchers/submit-interop) — Cross-chain signature submission
* [Get interop status](/api-reference/vouchers/get-interop-status) — Check cross-chain signature status

#### Sessions

* [Open session](/api-reference/vouchers/sessions/open-session) — Start a multi-voucher session
* [Get session](/api-reference/vouchers/sessions/get-session) — Retrieve a session by ID
* [Join session](/api-reference/vouchers/sessions/join-session) — Join a session as payer
* [Close session](/api-reference/vouchers/sessions/close-session) — Close a session
* [Reserve voucher in session](/api-reference/vouchers/sessions/reserve-voucher) — Reserve a voucher within a session

### Finance

* [Get networks](/api-reference/finance/get-networks) — Supported blockchain networks
* [Get currencies](/api-reference/finance/get-currencies) — Supported currencies and tokens
* [Convert amount](/api-reference/finance/convert-amount) — Convert an amount between currencies

### Widgets

* [Create widget](/api-reference/widgets/management/create-widget) — Configure a new widget
* [Get widget](/api-reference/widgets/management/get-widget) — Retrieve a widget by ID
* [Query widgets](/api-reference/widgets/management/query-widgets) — List business widgets
* [Update widget](/api-reference/widgets/management/update-widget) — Update widget configuration
* [Enable widget](/api-reference/widgets/management/enable-widget) — Enable a widget
* [Disable widget](/api-reference/widgets/management/disable-widget) — Disable a widget
* [Delete widget](/api-reference/widgets/management/delete-widget) — Delete a widget
* [Get public config](/api-reference/widgets/public/get-config) — Get public widget configuration
* [Create deposit session](/api-reference/widgets/public/create-session) — Start a customer deposit
* [Get deposit session](/api-reference/widgets/public/get-session) — Check deposit session status
* [Cancel deposit session](/api-reference/widgets/public/cancel-session) — Cancel a deposit session

### Webhooks

* [Create endpoint](/api-reference/webhooks/create-endpoint) — Register a webhook endpoint
* [Get endpoint](/api-reference/webhooks/get-endpoint) — Retrieve an endpoint by ID
* [Query endpoints](/api-reference/webhooks/query-endpoints) — List webhook endpoints
* [Update endpoint](/api-reference/webhooks/update-endpoint) — Update endpoint configuration
* [Rotate secret](/api-reference/webhooks/rotate-secret) — Rotate the signing secret
* [Enable endpoint](/api-reference/webhooks/enable-endpoint) — Enable an endpoint
* [Disable endpoint](/api-reference/webhooks/disable-endpoint) — Disable an endpoint
* [Delete endpoint](/api-reference/webhooks/delete-endpoint) — Delete an endpoint
* [Query deliveries](/api-reference/webhooks/query-deliveries) — List webhook deliveries
* [Get delivery](/api-reference/webhooks/get-delivery) — Retrieve a delivery by ID
* [Retry delivery](/api-reference/webhooks/retry-delivery) — Retry a failed delivery

### Businesses

* [Create business](/api-reference/businesses/create-business) — Register a new business
* [Get business](/api-reference/businesses/get-business) — Retrieve a business by ID
* [Query businesses](/api-reference/businesses/query-businesses) — List user businesses
* [Update business](/api-reference/businesses/update-business) — Update business details
* [Update business status](/api-reference/businesses/update-status) — Change business status
* [Get business role](/api-reference/businesses/get-role) — Get current user's role
* [Query business users](/api-reference/businesses/query-users) — List business members
* [Update user status](/api-reference/businesses/update-user-status) — Change a user's role status