API Reference
Endpoint reference for the Partner API, generated from the OpenAPI spec.
The Partner API is a JSON-only surface. Every endpoint is bearer-token-authenticated and scoped to the calling Master Account, and every failure returns the same error envelope.
Servers
| Environment | Base URL | Notes |
|---|---|---|
| Sandbox / development | https://dev.boapi.ppgw.net | Point here while integrating. |
| Production | https://boapi.ppgw.net | Live merchants, live gateway replication. |
Authentication
Every request must include:
Authorization: Bearer <your_partner_token>The token identifies your Master Account; there is no masterid parameter on any request. It is
derived from the token. See Authentication for how tokens are
issued, revoked, and kept safe.
Endpoints
| Endpoint | Purpose |
|---|---|
GET /v1/whoami | Confirm which Master Account your token maps to. |
GET /v1/merchants | List your merchants (paged). |
POST /v1/merchants | Create a merchant (lands pending). |
GET /v1/merchants/{merchantId} | Read one merchant. |
PATCH /v1/merchants/{merchantId} | Update profile fields; suspend/reactivate. |
GET /v1/merchants/{merchantId}/settings | Read EFT gateway settings. |
PUT /v1/merchants/{merchantId}/settings | Update settings, or copy from a sibling. |
GET /v1/merchants/{merchantId}/receiving-accounts | List receiving accounts. |
POST /v1/merchants/{merchantId}/receiving-accounts | Add a receiving account. |
PUT /v1/merchants/{merchantId}/receiving-accounts/{accountId} | Update a receiving account. |
DELETE /v1/merchants/{merchantId}/receiving-accounts/{accountId} | Remove a receiving account (soft). |
GET /v1/merchants/{merchantId}/payment-routing | Read payment routing. |
PUT /v1/merchants/{merchantId}/payment-routing | Set per-bank routing. |
GET /v1/merchants/{merchantId}/banks | List processing banks for the merchant's currency. |
GET /v1/merchants/{merchantId}/receiving-account-banks | List receiving-account banks for the merchant's currency. |
POST /v1/transactions | Query EFT transactions. |
GET /v1/transactions/{token}/status-screen | Payment-confirmation screenshot (image/png, 200) for a successful transaction; JSON error otherwise. |
POST /v1/fnbsb | List FNB Smart Blocked transactions. |
POST /v1/fnbsb/stats | FNB Smart Blocked statistics. |
Detailed endpoint pages (request/response schemas, example payloads, and a try-it panel) are linked from the left sidebar under Endpoints.