# Interswitch API Documentation Documentation

> All our API's are standardized in RESTFUL format, HTTP/HTTPS calls return json

## Guides
- [Introduction](https://docs.interswitchgroup.com/docs/home.md)
- [The Basics](https://docs.interswitchgroup.com/docs/about-interswitch-apis.md): Learn how to integrate Interswitch <<glossary:API>>s
- [Authentication](https://docs.interswitchgroup.com/docs/authentication.md)
- [Interswitch Business](https://docs.interswitchgroup.com/docs/quickteller-business.md): We recognize that as a Business in the digital age, you require tools to help you thrive and compete globally.  We deliver digital products and services leveraging our suite of APIs combined with business tools that help manage and simplify processes across Africa.
- [KYC Requirements](https://docs.interswitchgroup.com/docs/kyc-requirements.md): For every business need, we have various <<glossary:KYC>> requirements. This enables us to perform our business on the right side of regulation.
- [Sign up as a Developer](https://docs.interswitchgroup.com/docs/how-to-sign-up-as-a-developer.md)
- [Go live with Interswitch APIs](https://docs.interswitchgroup.com/docs/road-to-go-live-with-interswitch-apis.md)
- [QuickStart - Accept Your First Payment in 5 Minutes](https://docs.interswitchgroup.com/docs/quickstart-accept-your-first-payment-in-5-minutes.md): Get from zero to a working test payment on a single page. No account needed — use the sandbox credentials below and follow the steps.
- [Overview](https://docs.interswitchgroup.com/docs/overview.md)
- [Default Test Credentials](https://docs.interswitchgroup.com/docs/default-test-credentials.md): You can use these credentials to integrate to our WEB, API, and Mobile SDK if you dont have your own test credentials.
- [Getting Integration Credentials](https://docs.interswitchgroup.com/docs/getting-integration-credentials.md)
- [Web Checkout](https://docs.interswitchgroup.com/docs/web-checkout.md)
- [Web Checkout (DRC)](https://docs.interswitchgroup.com/docs/web-checkout-drc.md)
- [Card Payments API](https://docs.interswitchgroup.com/docs/payment-api.md)
- [SmartPOS SDK](https://docs.interswitchgroup.com/docs/smartpos-sdk.md)
- [Google Pay ™](https://docs.interswitchgroup.com/docs/pay-with-google.md): Learn how to accept payments with ease using Google Pay payments.
- [Opay integration](https://docs.interswitchgroup.com/docs/opay-integration-1.md)
- [Initialize](https://docs.interswitchgroup.com/docs/initialize-1.md)
- [Initialize-with-paymentId](https://docs.interswitchgroup.com/docs/initialize-with-paymentid-1.md)
- [Status](https://docs.interswitchgroup.com/docs/status-1.md)
- [3D Secure Transactions](https://docs.interswitchgroup.com/docs/visa-transactions.md)
- [Hosted Fields](https://docs.interswitchgroup.com/docs/hosted-fields.md)
- [Non Card Payments](https://docs.interswitchgroup.com/docs/non-card-payments.md)
- [Payment Links](https://docs.interswitchgroup.com/docs/payment-links.md)
- [Pay Bill](https://docs.interswitchgroup.com/docs/pay-bill.md)
- [In Store (POS)](https://docs.interswitchgroup.com/docs/in-store-pos.md)
- [Webhooks](https://docs.interswitchgroup.com/docs/webhooks.md)
- [Refunds](https://docs.interswitchgroup.com/docs/refunds.md)
- [Response codes](https://docs.interswitchgroup.com/docs/payment-response-codes.md)
- [Recurring Payments](https://docs.interswitchgroup.com/docs/recurring-payments.md)
- [Test Cards](https://docs.interswitchgroup.com/docs/test-cards.md)
- [TSA Payments](https://docs.interswitchgroup.com/docs/tsa-payments.md): Accept TSA payments via cards (Verve, Mastercard, Visa) from your customers
- [Dual Messaging](https://docs.interswitchgroup.com/docs/dual-messaging.md): Auth and Capture
- [Product Information](https://docs.interswitchgroup.com/docs/product-information.md)
- [Dashboard and Transaction Report Guide](https://docs.interswitchgroup.com/docs/qtb-report-guide.md)
- [Settlement Report Guide](https://docs.interswitchgroup.com/docs/settlement-report-guide.md)
- [Split Settlement Report Guide](https://docs.interswitchgroup.com/docs/split-settlement-report-guide.md)
- [Report Appendix](https://docs.interswitchgroup.com/docs/appendix-1.md)
- [Frequently Asked Questions](https://docs.interswitchgroup.com/docs/frequently-asked-questions.md)
- [Get a particular Transaction (DRC)](https://docs.interswitchgroup.com/docs/get-a-particular-transaction-drc.md)
- [Wallet Payments API (DRC)](https://docs.interswitchgroup.com/docs/wallet-payments-api-drc.md)
- [Wallet Payments API (KENYA)](https://docs.interswitchgroup.com/docs/wallet-payment-api-kenya.md)
- [Get a Particular Transaction (kenya)](https://docs.interswitchgroup.com/docs/get-a-particular-transaction-kenya.md)
- [Web Checkout (Kenya)](https://docs.interswitchgroup.com/docs/web-checkout-kenya.md)
- [Overview](https://docs.interswitchgroup.com/docs/value-added-services-overview.md)
- [Bills Payment](https://docs.interswitchgroup.com/docs/bills-payment-1.md)
- [Airtime Recharge (Virtual Top up)](https://docs.interswitchgroup.com/docs/airtime-recharge-virtual-top-up.md): Quickteller service v5
- [Response Codes](https://docs.interswitchgroup.com/docs/response-codes.md)
- [Airtime Recharge (E-pins)](https://docs.interswitchgroup.com/docs/airtime-recharge-e-pins-1.md): Quickteller Service v5
- [Overview](https://docs.interswitchgroup.com/docs/overview-3.md): Quickteller Service v5 - Send Money
- [Single Transfer](https://docs.interswitchgroup.com/docs/single-transfer.md)
- [Bulk Transfer](https://docs.interswitchgroup.com/docs/bulk-transfer.md)
- [Agency banking](https://docs.interswitchgroup.com/docs/cash-out-service-1.md)
- [Resolve Bank Code](https://docs.interswitchgroup.com/docs/get-banks-code.md): GetBankCode Method is used to retrieve banks Code
- [Response codes](https://docs.interswitchgroup.com/docs/response-codes-1.md)
- [Overview](https://docs.interswitchgroup.com/docs/overview-4.md): We offer low-to-high credit facilities by connecting loan providers to borrowers via various channels.
- [Nano Loans](https://docs.interswitchgroup.com/docs/nano-loans.md): Lending service provides a platform that allows users borrow small amounts at low interest rates and with ease of repayment.
- [Salary Lending](https://docs.interswitchgroup.com/docs/salary-lending.md)
- [Value Financing](https://docs.interswitchgroup.com/docs/value-financing.md)
- [Customer Insights](https://docs.interswitchgroup.com/docs/customer-insights.md)
- [Demography](https://docs.interswitchgroup.com/docs/demographic-insights.md): This provides insights into an individual's demographic characteristics.
- [Financial History](https://docs.interswitchgroup.com/docs/financial-history.md): Here you gain insights to customer attributes such as average account balance, total count and amount of credit and debit transactions on a month on month basis
- [Financial History - average](https://docs.interswitchgroup.com/docs/financial-history-average.md): This provides financial history, in addition to average values over the period.
- [Financial Habits](https://docs.interswitchgroup.com/docs/financial-habits.md): This endpoint gives you valuable insights to the spending behaviour and patterns of an individual.
- [Response Codes](https://docs.interswitchgroup.com/docs/response-codes-6.md)
- [Overview](https://docs.interswitchgroup.com/docs/cardless-services-1.md)
- [Single Paycode](https://docs.interswitchgroup.com/docs/single-paycode.md)
- [Bulk Paycode](https://docs.interswitchgroup.com/docs/bulk-paycode-1.md)
- [Response codes](https://docs.interswitchgroup.com/docs/response-codes-3.md)
- [Fintech Card Processing](https://docs.interswitchgroup.com/docs/fintech-card-processing-spec-document.md)
- [Debit](https://docs.interswitchgroup.com/docs/debit.md): Request   -  POST /debit
- [Reversal](https://docs.interswitchgroup.com/docs/reversal.md): Request
- [Enquiry](https://docs.interswitchgroup.com/docs/enquiry-1.md): Request
- [Place Lien](https://docs.interswitchgroup.com/docs/place-lien.md): Request
- [Debit Lien](https://docs.interswitchgroup.com/docs/debit-lien.md): e. Debit Lien
- [How to test your Endpoints?](https://docs.interswitchgroup.com/docs/how-to-test-your-endpoints.md)
- [Terminal Type](https://docs.interswitchgroup.com/docs/terminal-type.md)
- [Additional Fields](https://docs.interswitchgroup.com/docs/additional-fields.md)
- [Overview](https://docs.interswitchgroup.com/docs/overview-2.md)
- [Credit Inquiry](https://docs.interswitchgroup.com/docs/business-introduction.md)
- [Credit Completion Processing](https://docs.interswitchgroup.com/docs/credit-processing-bank-confirmation-model.md)
- [Transaction Requery](https://docs.interswitchgroup.com/docs/transaction-requery-1.md)
- [Transaction Search](https://docs.interswitchgroup.com/docs/transaction-search.md): Elevate Your Back Office with Seamless Transaction Search
- [Overview](https://docs.interswitchgroup.com/docs/transaction-search-overview.md)
- [Transaction Set Coverage](https://docs.interswitchgroup.com/docs/transaction-set-coverage.md): What to expect
- [Getting Started](https://docs.interswitchgroup.com/docs/transaction-search-getting-started.md): What to expect
- [Get Access Token](https://docs.interswitchgroup.com/docs/transactionapi-authentication.md)
- [Quick Search](https://docs.interswitchgroup.com/docs/quick-search.md)
- [Reference Search](https://docs.interswitchgroup.com/docs/reference-search.md)
- [Bulk Search](https://docs.interswitchgroup.com/docs/bulk-search.md)
- [Get Transaction Details](https://docs.interswitchgroup.com/docs/get-transaction-details.md)
- [Codes and Statuses](https://docs.interswitchgroup.com/docs/swol-response-codes.md)
- [Additional Resources](https://docs.interswitchgroup.com/docs/resources.md)
- [Card 360 Service](https://docs.interswitchgroup.com/docs/card-management-apis.md)
- [Overview](https://docs.interswitchgroup.com/docs/overview-8.md)
- [Authentication](https://docs.interswitchgroup.com/docs/card360-authentication.md)
- [Client Registration](https://docs.interswitchgroup.com/docs/card360-client-registration.md)
- [Test card data encryption](https://docs.interswitchgroup.com/docs/card360-test-card-data-encryption.md)
- [Create Single Card](https://docs.interswitchgroup.com/docs/card360-create-single-card.md)
- [Retry Single Card Creation](https://docs.interswitchgroup.com/docs/card360-create-single-card-retry.md)
- [Initiate Card Data Prep](https://docs.interswitchgroup.com/docs/card360-initiate-card-data-prep.md)
- [Fetch Data Prep Request](https://docs.interswitchgroup.com/docs/card360-fetch-data-prep-request.md)
- [Fetch Prepared Cards](https://docs.interswitchgroup.com/docs/card360-fetch-prepaid-cards.md)
- [Bulk Card Production and Data Prep](https://docs.interswitchgroup.com/docs/card360-bulk-card-production-and-data-prep.md)
- [Retry Bulk Card Production and Data Prep](https://docs.interswitchgroup.com/docs/card360-retry-bulk-card-production-and-data-prep.md)
- [Reissue Card PIN](https://docs.interswitchgroup.com/docs/card360-reissue-card-pin.md)
- [Change Card PIN](https://docs.interswitchgroup.com/docs/card360-change-card-pin.md)
- [Get PIN](https://docs.interswitchgroup.com/docs/card360-get-pin.md)
- [Block Card](https://docs.interswitchgroup.com/docs/card360-block-card.md)
- [Unblock Card](https://docs.interswitchgroup.com/docs/card360-unblock-card.md)
- [Block Prepaid Card](https://docs.interswitchgroup.com/docs/card360-block-prepaid-card.md)
- [Unblock Prepaid Card](https://docs.interswitchgroup.com/docs/card360-unblock-prepaid-card.md)
- [Link Card to Account](https://docs.interswitchgroup.com/docs/card360-link-card-to-account.md)
- [Confirm Sufficient Balance for Prepaid Cards](https://docs.interswitchgroup.com/docs/card360-confirm-sufficient-balance-for-prepaid-cards.md)
- [Confirm Sufficient Balance for Debit Cards](https://docs.interswitchgroup.com/docs/card360-confirm-sufficient-balance-for-debit-cards.md)
- [Get Card Balance for Prepaid Cards](https://docs.interswitchgroup.com/docs/card360-get-card-balance-for-prepaid-cards.md)
- [Get Account Balance for Debit Card Account](https://docs.interswitchgroup.com/docs/card360-get-account-balance-for-debit-card-account.md)
- [Fetch Multiple Cards by Issuer Number](https://docs.interswitchgroup.com/docs/card360-fetch-multiple-cards-by-issuer.md)
- [Fetch Single Card By PAN](https://docs.interswitchgroup.com/docs/card360-fetch-single-card-by-pan1.md)
- [Fetch Cards By Account](https://docs.interswitchgroup.com/docs/card360-fetch-cards-by-account.md)
- [Fetch Customer Card Details By Account](https://docs.interswitchgroup.com/docs/card360-fetch-customer-card-details-by-account.md)
- [Fetch Request Logs](https://docs.interswitchgroup.com/docs/card360-fetch-request-logs.md)
- [Validate Card](https://docs.interswitchgroup.com/docs/card360-validate-card.md)
- [Onboarding a Client](https://docs.interswitchgroup.com/docs/card360-onboarding-a-client.md)
- [Card PIN Encryption and Decryption](https://docs.interswitchgroup.com/docs/card360-card-pin-encryption-and-decryption.md): This documentation shows how PIN is encrypted and Decrypted
- [Transaction Report API](https://docs.interswitchgroup.com/docs/transaction-report-api.md)
- [Payouts](https://docs.interswitchgroup.com/docs/payouts.md)
- [Receiving Institutions](https://docs.interswitchgroup.com/docs/receiving-institutions.md)
- [Payout Channels](https://docs.interswitchgroup.com/docs/payout-channels.md)
- [Batch Payout Endpoints](https://docs.interswitchgroup.com/docs/bulk-payout.md): Endpoints to initiate payouts to at least two recipients.
- [Error Codes](https://docs.interswitchgroup.com/docs/error-codes.md): Transfer error codes and their meaning.
- [Overview](https://docs.interswitchgroup.com/docs/pos-till-integration.md)
- [Setting Up Connection](https://docs.interswitchgroup.com/docs/setting-up-connection.md)
- [Serial Port Configuration](https://docs.interswitchgroup.com/docs/serial-port-configuration.md)
- [Connecting Serial To Terminal](https://docs.interswitchgroup.com/docs/connecting-serial-to-terminal.md)
- [Transaction Commands](https://docs.interswitchgroup.com/docs/paycode-transaction-command.md)
- [Paycode Transaction Command](https://docs.interswitchgroup.com/docs/paycode-transaction-command-1.md)
- [Card Transaction Command](https://docs.interswitchgroup.com/docs/card-transaction-command.md)
- [Cash Transaction Command](https://docs.interswitchgroup.com/docs/cash-transaction-command.md)
- [QR Transaction Command](https://docs.interswitchgroup.com/docs/qr-transaction-command.md)
- [USSD Transaction Command](https://docs.interswitchgroup.com/docs/ussd-transaction-command.md)
- [Additional Features](https://docs.interswitchgroup.com/docs/additional-features.md)
- [Heartbeat Feature](https://docs.interswitchgroup.com/docs/heartbeat-feature.md)
- [Cancel Last Payment Command](https://docs.interswitchgroup.com/docs/cansel-last-payment-command.md)
- [Till Acceptance Criteria](https://docs.interswitchgroup.com/docs/till-acceptance-criteria-1.md)
- [POS Integration And Device Pairing](https://docs.interswitchgroup.com/docs/pos-integration-and-device-pairing.md)
- [Switching from USB to Bluetooth](https://docs.interswitchgroup.com/docs/switching-from-usb-to-bluetooth.md)
- [Switching from Bluetooth to USB](https://docs.interswitchgroup.com/docs/switching-from-bluetooth-to-usb.md)
- [Bluetooth Integration](https://docs.interswitchgroup.com/docs/bluetooth-integration.md)
- [Con's of Using Bluetooth Connection](https://docs.interswitchgroup.com/docs/cons-of-using-bluetooth-connection.md)
- [Installation Guidelines](https://docs.interswitchgroup.com/docs/installation-guidelines.md)
- [KIMONO And USBDriver APK Installation](https://docs.interswitchgroup.com/docs/kimono-and-usbdriver-apk-installation.md)
- [UPF Payment APIs](https://docs.interswitchgroup.com/docs/upf-payment-apis.md): Overview
- [Card Verification](https://docs.interswitchgroup.com/docs/card-verification.md)
- [Card Payment Initiation](https://docs.interswitchgroup.com/docs/card-payment-initiation.md)
- [IMTO Payment](https://docs.interswitchgroup.com/docs/overview-10.md)
- [ Merchant Wallets](https://docs.interswitchgroup.com/docs/merchant-wallets.md)
- [NRS E-Invoicing](https://docs.interswitchgroup.com/docs/nrs-e-invoicing.md)
- [Overview](https://docs.interswitchgroup.com/docs/overview-11.md): Powering frictionless cross-border payments all across Africa, by utilizing local currencies for seamless transactions between countries.
- [Security](https://docs.interswitchgroup.com/docs/security-1.md): Learn how to securely call the PIPE apis
- [Tools](https://docs.interswitchgroup.com/docs/tools.md): Tools you might need
- [Onboarding](https://docs.interswitchgroup.com/docs/onboarding.md): How to onboard a financial institution?
- [Send Cross Border Payments](https://docs.interswitchgroup.com/docs/send-cross-border-payments.md): Learn how to send cross-border payments on behalf of your customers.
- [Honor Cross-border Payments](https://docs.interswitchgroup.com/docs/honor-cross-border-payments.md): Learn how to honor cross-border payments in PIPE
- [Error Handling](https://docs.interswitchgroup.com/docs/error-handling.md): This document provides a comprehensive reference for all error codes, messages, descriptions, and recommended actions for the PIPE API.
- [Bank Deposits](https://docs.interswitchgroup.com/docs/bank-deposits.md): Learn how deposits by Liquidity Providers and Payment Gateways are being handled in PIPE
- [Get List of Liquidity Providers](https://docs.interswitchgroup.com/docs/get-list-of-liquidity-providers.md): Learn how to get the list of Liquidity Providers.
- [Payment Gateways](https://docs.interswitchgroup.com/docs/payment-gateways.md): Learn how to manage Payment Gateways
- [Liquidity Providers](https://docs.interswitchgroup.com/docs/liquidity-providers.md): This page shows the operations that can be done on a liquidity provider
- [Fees Structure](https://docs.interswitchgroup.com/docs/fees-structure.md)
- [Account Verification Endpoint](https://docs.interswitchgroup.com/docs/account-verification-endpoint.md)
- [Overview](https://docs.interswitchgroup.com/docs/overview-5.md)
- [Mobile SDK](https://docs.interswitchgroup.com/docs/mobile-sdk.md)
- [Overview](https://docs.interswitchgroup.com/docs/plugins-overview.md)

## API Reference
- [How to Generate Auth Data](https://docs.interswitchgroup.com/reference/how-to-generate-auth-data.md)
- [Generate Access Token](https://docs.interswitchgroup.com/reference/generate-access-token.md): Generate unique token to have access to our services.
- [Card Payment API](https://docs.interswitchgroup.com/reference/card-payment-api.md)
- [Authorize Transaction (3D Secure)](https://docs.interswitchgroup.com/reference/authorize-transaction-3d-secure.md)
- [Tokenize Card [Recurrents]](https://docs.interswitchgroup.com/reference/tokenize-card-recurrents.md)
- [Purchase [Recurrents]](https://docs.interswitchgroup.com/reference/purchase-recurrents.md)
- [Get Transactions](https://docs.interswitchgroup.com/reference/get-transactions.md): Search for transactions done over a period
- [Get Transaction Status](https://docs.interswitchgroup.com/reference/get-transaction-status.md): Get Details of a transaction to confirm the status
- [Get Transaction V2](https://docs.interswitchgroup.com/reference/gettransactionv2.md): Get Details of a transaction to confirm the status
- [Get Transaction Status DRC](https://docs.interswitchgroup.com/reference/get-transaction-status-drc.md)
- [Create Bill](https://docs.interswitchgroup.com/reference/create-bill.md)
- [Get Invoice Details](https://docs.interswitchgroup.com/reference/get-invoice-details.md)
- [Get Billers](https://docs.interswitchgroup.com/reference/get-billers.md): This fetches the list of available billers
- [Get Billers by Category](https://docs.interswitchgroup.com/reference/get-billers-by-category-2.md): This fetches the list of billers available under a particular category, the parameter ```id``` refers to the category id being queried.
- [Get Biller Payment Item](https://docs.interswitchgroup.com/reference/get-biller-payment-item.md): This fetches the items available under a biller.
- [Customer Validation](https://docs.interswitchgroup.com/reference/customer-validation-1.md)
- [Get Billers Categories](https://docs.interswitchgroup.com/reference/get-billers-categories.md): This method retrieves all the biller category types
- [Create Voucher (E pins)](https://docs.interswitchgroup.com/reference/create-voucher-e-pin.md)
- [Get Bank Codes](https://docs.interswitchgroup.com/reference/bank-code-copy.md)
- [Single Transfer](https://docs.interswitchgroup.com/reference/fund-transfer.md)
- [Bulk Transfer](https://docs.interswitchgroup.com/reference/bulk-transfer-1.md): This endpoint enables a wallet transfer to multiple wallets.
- [Change Pin](https://docs.interswitchgroup.com/reference/change-pin.md): This endpoint changes pin for a wallet
- [Get Balance](https://docs.interswitchgroup.com/reference/get-balance.md)
- [Get Balance Statement](https://docs.interswitchgroup.com/reference/get-balance-statement.md): This endpoint gives the balance statement for a wallet
- [Get Offer - ILS Call to Providers](https://docs.interswitchgroup.com/reference/get-offer-ils-call-to-providers.md): During the Get Offer processing, a request will be sent from Interswitch Lending Service to Provider to get the offers the Provider has for a User.
- [Get Access Token](https://docs.interswitchgroup.com/reference/post_passport-oauth-token.md)
- [Reference Search](https://docs.interswitchgroup.com/reference/post_switch-online-gateway-service-api-v1-gateway-reference-search.md)
- [Quick Search](https://docs.interswitchgroup.com/reference/post_switch-online-gateway-service-api-v1-gateway-quick-search.md)
- [Get Transaction Details](https://docs.interswitchgroup.com/reference/get_switch-online-gateway-service-api-v1-gateway-transaction.md)
- [Login](https://docs.interswitchgroup.com/reference/login.md): Authenticate the API user and obtain the AUTH token.
- [Create Route](https://docs.interswitchgroup.com/reference/create-bus-route.md): Endpoint to create bus route and set fare
- [Create Vehicle](https://docs.interswitchgroup.com/reference/create-vehicle.md): This API creates a vehicle and assigns it to an existing route
- [Assign Validator](https://docs.interswitchgroup.com/reference/assign-validator.md): Assign a validator to a vehicle