Payaza Collections covers every way your business can accept money: hosted
checkout, API-driven card and wallet flows, bank-transfer rails via virtual
accounts, and regional mobile money. This page maps each rail to how you
integrate and where to go next in these docs.
Payaza Collections
Full product overview of every collection channel Payaza supports.
Payaza Checkout
Hosted checkout experience for low-code online payments.
API Reference
Full endpoint list from the Payaza OpenAPI spec.
Choose your collection rail
Pick the channel that matches your customer journey. Many integrations combine
rails — for example checkout for web, virtual accounts for bank transfers, and
mobile money for wallet-first markets.
Hosted Checkout
Low-code online payments with Payaza-hosted pages.
API & payment gateway
Server-side collections: cards, wallets, and status APIs.
Virtual accounts
Receive bank transfers into dynamic or reserved account numbers.
Mobile money & regional
MoMo, XOF, ZAR, SLE, and OTP-assisted collections.
Apple Pay & Google Pay
Wallet-based mobile and web payments.
Hosted Checkout
Payaza Checkout is the hosted checkout experience for selling online with
minimal front-end work — ideal when you want fast time-to-market and Payaza to
handle payment UI and security presentation.
When to use: ecommerce, invoices with a redirect link, or any flow where
you do not need a fully custom card form on your own domain.
Align on currency and pricing
Confirm supported currencies and commercial terms with your Payaza contact
before go-live.
Configure your checkout profile
Set branding, return URLs, and success or failure handling to match your
customer journey.
API & payment gateway
For full control, integrate the payment gateway APIs: direct card charges,
optional auth/capture/void, refund and chargeback handling, and transaction
status queries.
When to use: custom checkout, mobile apps with native UX, or server-side
orchestration with your own risk and retry policies.
Card collection
Charge, 3DS checks, and status queries.
Auth / capture / void
Pre-authorise and settle in separate steps.
Refunds & chargebacks
Post-payment reversals and disputes.
API reference
Full endpoint list from the Payaza OpenAPI spec.
Virtual account collections
Virtual accounts let customers pay via bank transfer into a unique account
number tied to an invoice, customer, or session. You generate accounts via
API, monitor funding, and reconcile using transaction queries and
notifications.
When to use: large-ticket B2B, collections where cards are costly or
unavailable, or when bank transfer is the preferred local rail.
Virtual accounts guide
Create reserved or dynamic accounts, check status, and test funding in
non-production environments.
Mobile money & regional collections
Mobile money and regional rails cover operator-led collections (including
OTP steps) and multi-currency contexts such as XOF, ZAR, and SLE, using the
subsidiary collections API for process and status.
When to use: wallet-first markets, telco-led payments, or where card
penetration is lower than mobile money.
Momo, XOF & ZAR collections
Process collection, OTP, and status by transaction reference and country code.
Supports GHS, KES, UGX, TZS, XAF, XOF, ZAR, and SLE.
Apple Pay & Google Pay
Apple Pay and Google Pay provide tokenised wallet payments initiated via
the mobile payment API, with transaction status available through the standard
collection query endpoints.
When to use: high-conversion mobile web and app checkout where customers
expect one-tap wallet payment.
Apple Pay & Google Pay
Initiate wallet payments and poll for final status.
Cross-cutting practices (all rails)
Apply these regardless of channel so production behaviour stays predictable
and auditable.
Idempotency and references
Idempotency and references
Generate a unique reference per collection attempt on your side; reuse it
only when you intend a true retry of the same logical payment.
Status and webhooks
Status and webhooks
Treat gateway responses as provisional until your reconciliation layer
confirms success. Poll status APIs where webhooks are delayed or missed.
Security
Security
Keep API keys server-side, rotate credentials on schedule, and log without
exposing PAN or secrets.
Authentication
All Payaza API requests require anAuthorization header using your Base64-encoded public API key.
| Rail | Authorization | X-TenantID | X-ProductID | Content-Type |
|---|---|---|---|---|
| Card Collections | Payaza <base64-key> | Not required | Not required | application/json |
| Momo / XOF / ZAR / SLE | Payaza <base64-key> | test / live | app | application/json |
| Apple Pay / Google Pay | Payaza <base64-key> | Not required | Not required | application/json |
| Virtual Accounts | Payaza <base64-key> | Not required | Not required | application/json |
| Refunds & Chargebacks | Payaza <base64-key> | Not required | Not required | application/json |
Authentication guide
Full setup instructions — retrieve your key, encode it, and make your first
authenticated request.