Developer Hub

Build on BIPRA.
Faster.

REST APIs, SDKs, a full sandbox, and comprehensive docs. Everything you need to integrate payments, auditing, billing, and ERP workflows into your product.

Get API keys

Node.js SDKPython SDKAPI ReferenceChangelogDeveloper support

Products with APIs

Official SDKs

99.99%

API uptime SLA

<200ms

Avg response time

bipra-quickstart.js

// 1. Install
$ npm install @bipra/sdk

// 2. Initialise
import { Bipra } from '@bipra/sdk';
const client = new Bipra('sk_live_...');

// 3. Send a payment
const payment = await client
  .payments.create({
    amount: 150000,
    currency: 'ZAR',
    reference: 'INV-0091',
  });

// 4. Audit trail auto-created — auto

Why build on BIPRA

The developer experience you deserve

We build for developers first. Clear APIs, predictable behaviour, and docs that actually explain things.

Sub-200ms responses

Every API endpoint is optimised for speed. P99 latency under 200ms. We publish our performance metrics publicly.

View SLA →

Predictable error codes

Consistent error format across all endpoints. Machine-readable codes, human-readable messages. No surprises.

Error reference →

Idempotent by default

All write operations accept an idempotency key. Retry safely without duplicating payments or audit records.

Read the guide →

Webhook reliability

Webhooks retry automatically with exponential backoff. Delivery guaranteed or we page you. Signed with HMAC-SHA256.

Webhook guide →

Full sandbox parity

Sandbox mirrors production exactly — same API version, same error codes, same webhook payloads. No surprises at go-live.

Open sandbox →

Developer support

Slack community, GitHub issues, and a dedicated developer success team. Response SLA: 4 hours on business days.

Join dev community →

Quick start resources

Everything you need to ship faster

Postman collection

All endpoints, pre-configured

OpenAPI spec

Download YAML / JSON

Sandbox environment

Free, no card required

Developer community

Slack + GitHub

Getting started

Quickstart
Authentication
Webhooks
Error handling
Rate limits

BipraPay

Create a payment
Instant payments
Bulk disbursements & payroll
Audit trail events
Reconciliation
Payment status

VeriBills

Meter data ingestion
Bill generation
Bill delivery

Morr ERP

Budget API
HR endpoints
Document management

Quickstart5 min read

Get started with the BIPRA API

Install the SDK, authenticate, and make your first API call in under 5 minutes.

1. Install the SDK

Node.jsPythonJavaPHP
$ npm install @bipra/sdk
$ pip install bipra-sdk
<dependency>
  <groupId>io.bipra</groupId>
  <artifactId>bipra-sdk</artifactId>
</dependency>
$ composer require bipra/sdk

2. Authenticate

Pass your secret key as a Bearer token or initialise the SDK:

import { Bipra } from '@bipra/sdk';

const client = new Bipra({
  apiKey: process.env.BIPRA_SECRET_KEY,
  environment: 'sandbox', // or 'production'
});

3. Create your first payment

const payment = await client.payments.create({
  amount: 150000, // cents (R1,500.00)
  currency: 'ZAR',
  method: 'eft', // eft | card | swift | mobile
  reference: 'INV-2025-0091',
  metadata: { orderId: 'ORD-8821' },
});

console.log(payment.id); // pay_KwJm9xBzqL7PdQ2
console.log(payment.auditId); // aud_XmP3rQvNs8LkT1 (auto-created)

ℹ Audit trail

Every payment automatically generates an auditId. Query via client.audit.list({ paymentId }).

4. Listen for webhooks

app.post('/webhooks/bipra', (req, res) => {
  const event = client.webhooks.construct(
    req.body, req.headers['bipra-signature']
  );
  switch (event.type) {
    case 'payment.completed': ...
    case 'audit.flagged': ...
    case 'bill.delivered': ...
  }
});

Environment	Key prefix	Base URL	Real money
Sandbox	`sk_test_...`	`sandbox.bipra.io/v1`	No
Production	`sk_live_...`	`api.bipra.io/v1`	Yes

Status	Meaning
`200`	OK — request succeeded
`201`	Created — resource created
`400`	Bad request — invalid parameters
`401`	Unauthorised — invalid or missing API key
`402`	Payment required — insufficient funds or limit reached
`403`	Forbidden — API key lacks permission
`404`	Not found — resource does not exist
`409`	Conflict — idempotency key reused with different params
`422`	Unprocessable — semantic validation failed
`429`	Too many requests — rate limit exceeded
`500`	Server error — BIPRA-side issue (auto-alerted)

Plan	Requests / min	Burst / sec	Bulk batch size
Starter	300	10	1,000 items
Business	1,200	40	10,000 items
Enterprise	Custom	Custom	50,000 items

Stay informed

Product updates & insights

Get the latest from BIPRA — product releases, compliance updates, and fintech insights for African businesses.

No spam. Unsubscribe anytime.

Build on BIPRA.
Faster.

The developer experience you deserve

Everything you need to ship faster

Get started with the BIPRA API

1. Install the SDK

2. Authenticate

3. Create your first payment

4. Listen for webhooks

Authentication

API key types

Sending an authenticated request

Sandbox vs production

Rotating API keys

Webhooks

Supported events

Register an endpoint

Verify and handle events

Webhook payload structure

Error handling

HTTP status codes

Error response format

Handling errors in code

Machine-readable error codes

Rate limits

Limits by plan

Rate limit headers

Retry logic

Best practices

Official SDKs

API Reference

Test in our sandbox

Changelog

Product updates & insights

Build on BIPRA.Faster.

The developer experience you deserve

Everything you need to ship faster

Get started with the BIPRA API

1. Install the SDK

2. Authenticate

3. Create your first payment

4. Listen for webhooks

Authentication

API key types

Sending an authenticated request

Sandbox vs production

Rotating API keys

Webhooks

Supported events

Register an endpoint

Verify and handle events

Webhook payload structure

Error handling

HTTP status codes

Error response format

Handling errors in code

Machine-readable error codes

Rate limits

Limits by plan

Rate limit headers

Retry logic

Best practices

Official SDKs

API Reference

Test in our sandbox

Changelog

Product updates & insights

Chat on WhatsApp

Build on BIPRA.
Faster.