Skip to main content
The Guild Partner API gives banks, microfinance institutions, and credit fintechs programmatic access to:
  • Consent-gated snapshots of users’ standing tiers and ledger aggregates.
  • Disbursement of approved credit over OPay payout rails.
  • Webhook subscriptions for real-time consent and repayment events.
This is the technical reference. For the conceptual overview, start at Partner Portal → Overview.

​
Base URLs

All endpoints are HTTPS.
The live sandbox isn’t active yet. We’re finalising the synthetic-user dataset and the sandbox webhook delivery infrastructure. The endpoints and shapes below are the spec we’re shipping against; if you’re integrating, talk to us and we’ll arrange a sandbox handshake when it’s ready.
The sandbox, once live, will be a fully-isolated environment with seeded synthetic users for development and testing.

​
API versioning

The current API version is v1. Versioning is in the URL path (/partner/v1/...). Breaking changes go in a new version (e.g., /partner/v2/...) with deprecation notice for the old version on a documented timeline (minimum 12 months). Non-breaking changes (new optional fields, new endpoints, new event types) can ship within the same version. We announce them in the changelog.

​
Content type

All requests and responses are application/json. POST and PATCH bodies must be valid JSON.

​
Identifier shape

Every entity ID is a ULID — Crockford Base32, 26 characters, sortable by creation time, unambiguous. The prefix is part of the ID. Don’t strip it; pass identifiers as you receive them.

​
Currency

All monetary amounts are in kobo. Naira × 100 = kobo. Stored and transmitted as strings to preserve precision on large values.
Never floats. Never naira directly. The reason is precision: floating-point representations of decimal money cause cumulative drift in calculations. String-encoded BigInts of kobo are exact.

​
Timestamps

ISO-8601 with timezone. Always UTC unless explicitly noted.

​
Required headers

​
Where to start

Authentication

Bearer tokens, scopes, IP allowlisting, rotation.

Errors

Status codes, error codes, retry guidance.

Snapshots

The primary endpoint — fetch a signed user snapshot.

Webhooks

Event subscriptions and payload reference.