SwitchApp API
  • Introduction
  • Quick Start
  • Authentication
  • Errors
  • Metadata
  • Pagination
  • Versioning
  • No-code solutions
  • Webhooks
  • Payments
    • Transactions
      • Initialize a transaction
      • Verify transaction
      • List transactions
      • Retrieve Transaction
      • Transaction Webhooks
  • Payment Providers
    • Payment Providers
  • Countries & Currencies
    • Countries
    • Currencies
  • Products
    • Products
      • Create a product
      • Retrieve a product
      • Update a product
      • List all products
      • Delete a product
  • Customers
    • Customers
      • Create Customer
      • List Customers
      • Fetch Customer
      • Update Customer
      • Delete/Archive Customer
  • Payment Links
    • Payment Links
      • Create a payment link
      • Fetch payment link
      • Update a payment link
      • List all payment links
      • Delete a payment link
  • Payouts
    • Payouts
      • List Payouts
      • Fetch Payout
      • Retry Payout
  • BALANCES
    • Balances
      • Fetch all balances
      • Fetch a balance
      • Fetch currency balance
  • DISBURSEMENTS
    • Disbursements (Transfers)
      • Batch Disbursements
        • Initiate A Disbursement
        • List Batch Transfers
        • Fetch A Batch
        • Requeue All Failed Transfers
      • Single Disbursements
        • Fetch List By Batch Reference
        • Fetch All Singles By Page
        • Fetch A Single Disbursement
        • Fetch fee
        • Fetch rate
    • Beneficiaries
      • Create a beneficiary
      • List all beneficiaries
      • Fetch a beneficiary
      • Delete a beneficiary
    • Banks
      • Bank list
      • Bank slugs
      • Resolve account details
  • VIRTUAL ACCOUNTS
    • Virtual Accounts
      • Top-up virtual accounts
        • Fetch providers
        • Create top-up account
        • List accounts
        • Fetch account
        • Requery account
        • Deallocate account
      • Payment virtual accounts
        • Fetch providers
        • Create payment account
        • Update account details
        • List accounts
        • Fetch account
        • Requery account
        • Deallocate account
Powered by GitBook
On this page
  • Welcome to SwitchApp docs
  • Want to jump right in?
  • Not a developer?

Introduction

Developer guide on how to integrate and use the SwitchApp API

NextQuick Start

Last updated 6 months ago

Welcome to SwitchApp docs

SwitchApp is a full-featured payment solution that orchestrates payments across different gateways, payment providers, and countries. We went a step further to integrate all our features into a simple-to-use API that will enable you to make and receive payment from your website or web store with ease. It takes a few minutes to create a profile for your business and you are ready to start making API calls.

SwitchApp allows you to test your integration in your app before allowing access to your customers. This is referred to as TEST MODE. In test mode, your API calls do not require real funds but will deliver the same app flow experience as in LIVE MODE. This enables debugging without having to execute real transactions.

Your API key (found on your dashboard) provides security for your account and must be used to authenticate every request. It also determines whether a request will be resolved as a TEST or LIVE request.

Want to jump right in?

You may start by exploring our Swagger API collection to get an idea of everything that's possible with the SwitchApp API:

Not a developer?

Go ahead and use our no-code solutions to power your business:

REST
Quick Start
No-code solutions