Overview

Brrndops API 1.0

Create invoices, render branded PDFs and email them to your customers from your own software.

Getting started

1. Sign in to the Brrndops developer dashboard and create your business.
2. Create a sandbox API key (bd_test_…) under Developers → API keys.
3. Make your first request. Sandbox is free, never emails real customers and watermarks PDFs “TEST”.
4. When you’re ready, verify your business and choose a plan to unlock production keys (bd_live_…).

Authentication

Send your secret key as a bearer token on every request:

Authorization: Bearer bd_test_4eC39HqLyjWDarjtT1zdp7dc

Keys are secret. Use them from your server only and never ship them in a browser or mobile app. The key decides the environment: sandbox keys only see sandbox data and production keys only see production data.

Amounts

All money is an integer in the currency’s minor unit: 150000 with NGN is ₦1,500.00, 1500 with USD is $15.00. Zero-decimal currencies such as JPY use whole units.

Idempotency

Send an Idempotency-Key header (any unique string, e.g. a UUID) on POST and PATCH requests. If a request times out you can safely retry with the same key: you get the original response back, with the header Idempotent-Replayed: true, and nothing is created twice. Keys are kept for 24 hours.

Pagination

List endpoints return { "object": "list", "data": [...], "has_more": true, "next_cursor": "inv_…" }, newest first. Pass next_cursor as starting_after to get the next page.

Errors

Errors use conventional HTTP status codes and always have the same shape:

{ "error": { "type": "invalid_request_error", "code": "parameter_missing",
             "message": "currency is required.", "param": "currency", "request_id": "…" } }

Branch on type and code, not on message. Include request_id when contacting support. You can also look the request up in Developers → Request logs.

Information

• OpenAPI version: 3.1.0

Operations

GET

/account

GET

/invoices

POST

/invoices

GET

/invoices/{id}

DELETE

/invoices/{id}

PATCH

/invoices/{id}

GET

/invoices/{id}/pdf

POST

/invoices/{id}/send

Authentication

apiKey

Your secret key: bd_test_… for sandbox or bd_live_… for production.

Security scheme type: http