Resources

Changelog and versioning

How the API changes over time, and what changed when.

Versioning#

The version is in the path: /api/v1.

• v1 changes only by addition. New endpoints, new optional request fields, new response fields and new event types can appear without a new version.
• Your code must ignore fields and event types it doesn't know, and must not depend on the order of fields.
• A breaking change, such as removing or renaming a field or changing its meaning, would come as /api/v2, announced here first.

v1#

Released: v1 launch date

• Customers: create, update, get, list by externalRef, enrollments and statement.
• Invoices: raise into the approval workflow (idempotent on externalRef), get and list.
• Receipts for paid invoices.
• Signed PDF and payment links.
• Online payment: checkout and payment attempts (Paystack).
• Webhooks: 22 event types, signed deliveries, retries, delivery log and redelivery.