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

# API reference

> Every endpoint, with its fields, success responses, and failure responses.

## Base URLs

| Environment | Base URL |
| - | - |
| Sandbox | `https://sandbox.core.linkio.world/api` |
| Live | `https://core.linkio.world/api` |

## Headers

| Header | Required | Value |
| - | - | - |
| `X-BRIDGE-API-Key` | Always | Your API key |
| `API-Version` | Always | `2026-10-29-atlas` |
| `Content-Type` | With a body | `application/json` |
| `Idempotency-Key` | Recommended on `POST` | A unique value. See [Retries](https://docs.bridge.linkio.world/before-you-build/safe-requests.md). |

## Endpoints

| Method | Path | What it does |
| - | - | - |
| `POST` | [`/customers/onboard`](https://docs.bridge.linkio.world/api-reference/customers/onboard) | Add a customer |
| `GET` | [`/customers/list`](https://docs.bridge.linkio.world/api-reference/customers/list) | List customers |
| `GET` | [`/customers/{customerId}/details`](https://docs.bridge.linkio.world/api-reference/customers/details) | Get a customer |
| `POST` | [`/quotes/generate`](https://docs.bridge.linkio.world/api-reference/quotes/generate) | Get a quote |
| `GET` | [`/quotes/{quoteId}/refresh`](https://docs.bridge.linkio.world/api-reference/quotes/refresh) | Refresh a quote |
| `POST` | [`/payments/onramp`](https://docs.bridge.linkio.world/api-reference/payments/onramp) | Create an onramp |
| `POST` | [`/payments/offramp`](https://docs.bridge.linkio.world/api-reference/payments/offramp) | Create an offramp |
| `POST` | [`/payments/{paymentId}/otp`](https://docs.bridge.linkio.world/api-reference/payments/otp) | Send a mobile money code |
| `GET` | [`/payments/list`](https://docs.bridge.linkio.world/api-reference/payments/list) | List payments |
| `GET` | [`/payments/{paymentId}/details`](https://docs.bridge.linkio.world/api-reference/payments/details) | Get a payment |
| `GET` | [`/payments/banks`](https://docs.bridge.linkio.world/api-reference/lookups/banks) | List banks |
| `GET` | [`/payments/momo-networks`](https://docs.bridge.linkio.world/api-reference/lookups/momo-networks) | List mobile money networks |
| `GET` | [`/payments/methods`](https://docs.bridge.linkio.world/api-reference/lookups/methods) | List payment methods and their fields |

## Errors that can happen on any endpoint

To keep each page short, these aren't repeated on every endpoint:

| Status | Code | Why |
| - | - | - |
| `400` | `api_version_required`, `api_version_mismatch`, … | Problem with the `API-Version` header. See [API versions](https://docs.bridge.linkio.world/before-you-build/api-versions.md#version-errors). |
| `401` | `authentication_failed` | Problem with the API key. See [API keys](https://docs.bridge.linkio.world/control-app/api-keys.md#key-errors). |
| `403` | `forbidden` | IP not allowlisted, or the key lacks the scope. |
| `413` | `payload_too_large` | Body over 10 KB. |
| `429` | `rate_limit_exceeded` | Too many requests. |
| `500` | `unexpected_error` | Something went wrong on our side. |

See [Error codes](https://docs.bridge.linkio.world/errors/codes.md) for the full list.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.