Developer Platform & Gateway API
Unified REST API, SDKs, authentication, payments, virtual NUBAN accounts, subscriptions, invoices, and webhooks. (135 articles)
Developer Gateway: Getting Started in Test Mode
Explains developer account provisioning, portal access and why Test Mode is the starting environment.
Developer Gateway: Live Mode Verification Gates
Documents the checks required before a developer can switch to Live Mode.
Developer API Key Types and Environment Prefixes
Explains publishable and secret keys across test and live environments.
Developer API Key Rotation, Disable and Revoke
Explains the API-key lifecycle actions exposed by the developer platform.
Developer API Authentication Headers
Shows how the gateway authenticates API calls with secret keys.
Developer API Scopes and Least-Privilege Access
Explains the permission scopes available to DeveloperApiKey records.
Developer API IP Allowlisting
Explains optional IP restrictions available on API keys and the webhook-side network restriction for Paystack.
Developer API Rate Limiting
Explains the key/IP rate-limit tracking used by the gateway API.
Initialize a Developer Gateway Payment
Documents the payment initialization request and response lifecycle.
Verify a Developer Gateway Payment
Explains the verification step that turns a pending payment into a successful wallet credit path.
List and Paginate Developer Payments
Explains filtered payment history and cursor pagination in the developer API.
Repeat Charges and Stored Authorization
Explains the repeat-charge endpoint that uses a customer's authorization code.
Bulk Payment Initialization
Explains batch payment submission and asynchronous processing for larger batches.
Full and Partial Refunds
Explains the refund endpoint and its wallet-impact rules.
Developer Customer Records
Explains customer read/write access and customer references in gateway responses.
Developer Transfers and Payouts
Explains developer-initiated bank transfers and their completion/failure states.
Dedicated Virtual NUBAN Accounts
Explains dedicated virtual account provisioning and credit handling.
No-Code Payment Links
Explains the developer API's payment-link resource for checkout without custom payment-page code.
Subscriptions and Recurring Billing
Explains the subscription API and its relationship to repeat charges and webhooks.
Developer Invoicing
Explains the invoice API and payment-state events associated with invoices.
Scheduled Payments
Explains delayed payment charging through the gateway scheduling endpoint.
Multi-Currency Developer Payments
Explains the currencies exposed by the gateway integration guide.
Split Payments
Explains the split-payment input available during payment initialization.
Developer Wallet and Immutable Ledger
Explains wallet balances and the ledger that records their changes.
Developer Settlements
Explains settlement as a separate downstream finance concept from individual payment success.
Webhook Endpoint Creation and Event Subscriptions
Create a developer webhook endpoint and choose the events BursaPay should deliver.
Webhook HMAC Signature Verification
Verify BursaPay webhook signatures before trusting incoming event data.
Webhook Event Modes and Versioning
Control whether a webhook receives test, live or all events and which payload version it expects.
Webhook Delivery Logs and Failure Diagnosis
Use webhook delivery logs to identify failed deliveries, response codes and retry state.
Retrying Failed Webhook Deliveries
Retry a failed webhook delivery safely after correcting the receiving endpoint.
Idempotent Webhook Event Processing
Prevent duplicate webhook deliveries from causing duplicate business operations.
Paystack Webhook IP Allowlist and HMAC Security
Explain the two main security checks on the internal Paystack webhook receiver.
Gateway API Key Security and Storage Rules
Explain how developer API keys are stored and which key material must never be exposed.
API Key Rotation, Disable and Revocation
Manage the lifecycle of developer API keys without unnecessarily exposing credentials.
Live Mode Verification Gates
Understand the conditions that unlock production API access.
Test Mode Isolation and Safe Sandbox Behavior
Use Test Mode to exercise integrations without mixing test data into live financial records.
Sandbox Playground for API Testing
Use the BursaPay developer sandbox playground to try API requests before integrating them into code.
API Request Logging and Audit Trail
Understand what the gateway records about API requests for support, audit and debugging.
Rate Limits and API Throttling
Understand API rate-limit tracking and how applications should respond to throttling.
API Error Envelope and Validation Failures
Interpret validation, authentication, permission, rate-limit and business errors returned by the gateway.
Developer Webhook Event Catalog
Map the major webhook event names to the business operations they represent.
Webhook Secret Rotation and Endpoint Changes
Handle webhook endpoint changes without breaking event verification.
Developer Dispute Event Handling
Explain the developer-side handling of dispute-created, won and lost events.
Payment and Transfer Webhook State Reconciliation
Reconcile payment and transfer webhooks with the gateway's authoritative transaction states.
Virtual Account Credit Event Handling
Explain how dedicated NUBAN credit events reach a developer wallet.
Webhook Security: HTTPS, Secrets and Minimal Payload Exposure
Apply secure engineering practices to webhook receivers.
Gateway Risk Engine and Suspicious Activity Checks
Understand the role of the gateway risk engine in post-payment and developer activity monitoring.
Developer Verification and KYC Wizard
Explain the developer verification path required before production access and sensitive operations.
OpenAPI Schema and Interactive API Documentation
Use the public API documentation and OpenAPI contract to build accurate integrations.
Gateway API Changelog and Upgrade Discipline
Use the API changelog to understand version changes before upgrading an integration.