For AI agents: visit https://developers.korapay.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Kora Developer Documentation
HomeGuides
API ReferenceCreate AccountLog InKora Developer Documentation
Guides
API ReferenceCreate AccountLog In
HomeGuides

🟢 Get Started

  • Introduction
  • API Keys
  • Test & Live Modes
    • Testing your Integration
  • Webhooks
  • Errors
  • Uploading Supporting Documents
  • Frequently Asked Questions (FAQ)
    • How do I resend webhook notifications?
    • How do I get the API keys?
    • How do I whitelist payout IP addresses on the merchant dashboard?
    • How do I initiate withdrawals on the merchant dashboard?
    • How do I invite team members?
    • How can I set or modify the payout webhook URL on the dashboard?
    • How can I obtain test data to simulate transactions in the Sandbox environment?

↙️ Pay-Ins

  • Overview
  • Checkouts
    • Checkout Standard
    • Checkout Redirect
  • Payment Links
  • Virtual Bank Accounts
    • Accepting payments with NGN Virtual Bank Accounts
    • Accepting payments with USD Virtual Bank Accounts
  • Pool Accounts
  • Bank Transfers
    • Handling Underpayments and Overpayments for Bank Transfer Payments
  • Card Payments
    • Accept Card Payments with Checkouts
    • Accept Card Payments with APIs
    • Accept Flexible Card Payments with API
  • Pay with Bank
  • Pay with Bank (Instant EFT)
  • Voucher Payments API
    • Overview
    • Voucher Payments on Checkout
    • Integrating Voucher Payments via API
    • Webhooks & Transaction Verification
    • Security & Compliance
  • Mobile Money Payments
    • Accept Mobile Money Payment with Checkout
    • Accept Mobile Money Payment with APIs
  • Pay-ins History API
  • Refunds API
    • Refunds in Sandbox
  • Chargebacks

↗️ Payouts

  • Overview
  • Payout API
    • Creating and Managing Beneficiaries
  • Withdrawals
  • Bulk Payouts via API
  • Payout Utilities

🔃 Direct Debit

  • Overview
  • Creating an Authorization
  • Retrieving an Authorization
  • Debit a Customer's Account (Variable Authorizations Only)
  • Webhooks

💳 Card Issuing

  • Overview
  • Issuing Balance
  • Virtual Card Creation
  • Virtual Card Funding
  • Virtual Card Withdrawals
  • Virtual Card Management
    • Making a payment with a virtual card
    • Card Transactions
    • Suspend or Terminate Virtual Card via Dashboard
    • Activate or Suspend Virtual Card via API
    • Virtual Card Expiration
    • Card Events and Webhook
    • Raising a Chargeback
  • Testing Virtual Cards

👤 Identity

  • Overview
  • KYC Verification (eIDV) in Nigeria
    • Bank Verification Number (BVN)
    • National Identification Number (NIN)
    • Virtual National Identification Number (vNIN)
    • Advanced Phone Number Search
    • Phone Number Verification
  • KYB Verification (eIDV) in Nigeria
    • Certificate of Incorporation (CAC) Verification
  • KYC Verification (eIDV) in South Africa
    • South African ID Number (SAID) Verification
  • KYC Verification (eIDV) in Ghana
    • International Passport Verification (Ghana)
    • Social Security & National Insurance Trust (SSNIT) Verification
    • Ghana Voters Card (GVC) Verification
    • Driver's License Verification (Ghana)
  • KYC Verification (eIDV) in Kenya
    • International Passport Verification (Kenya)
    • National Identification Number Verification
    • Phone Number Verification
    • Tax PIN Verification
  • Testing Identity on the Sandbox Environment
  • Managing Verifications
  • Liveness Check
    • React Native Implementation
    • Web Implementation
    • Flutter Implementation
    • Support & Feedback

💰 Balance

  • Overview
  • Balance API
  • Balance History API

🔀 Conversions

  • Overview
  • Exchange Rate API
  • Currency Conversion API
  • Dynamic Currency Conversion
  • Initiating and Managing Conversions on the Dashboard
  • Testing Conversions on the Sandbox Environment

☑️ Settlements

  • Overview
  • Settlements

🌍 Dashboard

  • Overview
  • Audit Logs

⚡️ Plugins

  • Kora WooCommerce Plugin
Powered by 

Webhooks

    • Authorization Events – direct_debit.auth
    • Debit Outcome Events –charge.success / charge.failed
    • Event Summary
    • Status Reference
    • Debit (Transaction) Status
    • Authorization Type
    • Frequency Values (fixed authorizations only)
    • Common Error Codes