REST API Reference Overview

Hosted checkout sessions (checkout.rafiqpay.net/c/{id}). The customer pays by card, by bank transfer to a one-time account, or from their rafiqPay wallet, and your balance is credited when the payment is confirmed.

The canonical record of every payment attempt across Checkout, Direct Debit Mandates, and Virtual Account inflows.

Full or partial refunds of succeeded charges.

Bank transfers to a checkout’s one-time account that were the wrong amount, or arrived after it closed. Each is held out of your available balance until you accept it as a payment or return it to the customer.

Customer profiles linked to charges, subscriptions, wallets, and mandates.

Cards customers saved with your business at checkout, with their consent. Charge one without the customer present. The card number and the token used to charge it are never returned.

No-code shareable payment links (/pl/{slug}).

Invoices with line items, an optional VAT amount you set, and optional part payments.

Reusable catalog products and flat, per-seat, tiered, or metered prices.

Recurring customer subscriptions on flat or per-seat plans, with zero-penalty dunning.

Usage metering for pay-as-you-go billing. Not working yet: events are not recorded and usage is not billed.

Feature flags and quota entitlements computed from active subscriptions.

Direct-debit mandates on a customer’s GTBank account. The customer approves on a rafiqPay page with a code from their bank; you then debit it, up to a total and between two dates.

Proposed embedded NGN wallets for your customers. Not built.

Permanent account numbers for your customers. Every transfer into one is credited to you as a charge from that customer, with the usual fee.

Single and batch bank payouts, made by signed-in team members, with a second approver for large amounts. API keys cannot pay out.

Proposed multi-party payment splits across connected accounts. Not built: no payment is split today.

Sub-merchant records for platforms and marketplaces. Records only for now: no invitation is emailed and no money is settled to them.

Proposed pre-funded virtual and physical debit cards with blocked merchant categories. Not live: no card processor is connected, so no real card is issued.

Verified individuals or employees eligible to hold issued rafiqPay cards.

Proposed card authorization holds and synchronous JIT decisions. Not built.

Your available balance, and the double-entry journal lines behind it.

HTTPS webhook listeners, signing secrets and deliveries. Today these are managed in the dashboard (Developers, Webhooks), where you can also send a test event and replay a delivery.

Proposed log of the events sent to your webhooks. Not built: there is no events API yet.

Test-mode-only routes to simulate payments and bank transfers in. The card, delivery and clock helpers are proposed. In test mode, a saved-card charge or mandate debit for an amount ending in 99 kobo is declined, and the mandate code is 123456.

Configure approval thresholds, hold durations, and solo caps within your KYB tier bounds (ACCESS_RULES).

Read-only, append-only security and activity log entries (ACCESS_RULES §1).

Two-step ownership transfer initiation, acceptance, and cancellation. (Owner recovery has no API endpoint by design.)