Guides
Narrative documentation for integrating with the KwiikPay API โ start with Quickstart, then dip into whichever topic you need.
Quickstart
Get an API key and make your first call.
Authentication & scopes
How API keys, scopes, and subject-binding work.
Idempotency
Making mutating requests safe to retry.
Pagination
How list endpoints page through results.
Errors
The shapes an API call can fail with, and how to handle each.
Customers & onboarding
The customer record, its lifecycle, and starting and following KYC/KYB verification.
Sub-customers & parent access
Use a parent's API key to onboard sub-customers, manage their beneficiaries, withdraw fiat and track payments.
Webhooks
Registering an endpoint, verifying signatures, and handling retries.
Crypto wallets & withdrawals
Issuing deposit addresses, whitelisting destinations, sending, and reconciling.
Currencies, rails and providers
Which currency goes with which provider and rail, the account โ beneficiary โ withdrawal chain, and the conversion pair rules.
Beneficiaries
What each currency needs, why 200 is not success, the approval gate, and what update and delete really do.
Payout batches
Paying many beneficiaries in one call: the lifecycle, what each status means, and the traps.
Reconciliation
What the reads let you rebuild after downtime, and what only webhooks carry.