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

# API Reference

> Objects, operations, statuses and events of the Broco integration specification.

This reference describes Broco's integration specification. Production API access is not available at this stage. The requests on these pages are illustrative examples and do not point to an active environment. See [Integration access](/get-started/integration-access).

## Resources

| Resource | Use case | Operations |
| - | - | - |
| [Payments](/api-reference/payments) | Broco Pay | Create, retrieve, cancel |
| [Cash payments](/api-reference/cash-payments) | Cash checkout | Create, retrieve, cancel |
| [Supplier payments](/api-reference/supplier-payments) | Supplier payments | Retrieve a beneficiary; create, retrieve, list, cancel a payment |
| [Collections](/api-reference/collections) | Marketplace cash reconciliation | Create, retrieve |

## Base URL

```text theme={null}
https://api.broco.example/v1
```

`api.broco.example` is a reserved example domain.

## Authentication

Every request is sent from your server with the integration secret.

```bash Request header theme={null}
Authorization: Bearer $BROCO_SECRET_KEY
```

The connection of the account involved goes in the request body or query. See [Authentication & account connections](/developer/authentication).

## Conventions

| Topic | Rule |
| - | - |
| Format | JSON request and response bodies, `Content-Type: application/json` |
| Amounts | Integers in the minor unit of the currency. 50 000 DZD is `5000000`. See [Currencies & amounts](/developer/currencies-and-amounts). |
| Currency | `DZD`, `MAD`, `TND` or `XOF`. One currency per operation. |
| Timestamps | ISO 8601 in UTC, such as `2026-10-12T10:00:00Z` |
| Empty values | Fields not yet known are `null` |
| Idempotency | `Idempotency-Key` header on every creation |
| Identifiers | Prefixed by object: `pay_`, `cpay_`, `spay_`, `ben_`, `col_`, `evt_` |

## Errors and events

* Error format and codes: [Errors & retries](/developer/errors-and-retries).
* Event types and payloads: [Events & webhooks](/developer/events-and-webhooks).


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