# Flick

> Payments, payouts, identity and financial data APIs for Africa.

- [Flick API](https://docs.getflick.co/introduction.md): Collections, payouts, identity and financial data, on one set of credentials.
- [Quickstart](https://docs.getflick.co/guides/quickstart.md): Collect your first payment into a virtual account.
- [Authentication](https://docs.getflick.co/guides/authentication.md): How to authenticate requests, and which key to use where.
- [Environments](https://docs.getflick.co/guides/environments.md): How test mode differs from live, and what you can safely exercise.
- [Errors](https://docs.getflick.co/guides/errors.md): How failures are reported.
- [Idempotency](https://docs.getflick.co/guides/idempotency.md): Making writes safe to retry.
- [Collections](https://docs.getflick.co/guides/collections/overview.md): Ways to take money in.
- [Virtual accounts and IBANs](https://docs.getflick.co/guides/collections/virtual-accounts.md): Dedicated account numbers for NGN, GBP and EUR.
- [Checkout](https://docs.getflick.co/guides/collections/checkout.md): Hosted and direct card collection.
- [Direct debit](https://docs.getflick.co/guides/collections/direct-debit.md): Recurring and one-off debits against a mandate.
- [Payouts](https://docs.getflick.co/guides/payouts/overview.md): Sending money out.
- [Beneficiaries](https://docs.getflick.co/guides/payouts/beneficiaries.md): Saved payout destinations.
- [Identity](https://docs.getflick.co/guides/identity/overview.md): KYC, KYB and biometric checks.
- [Financial data](https://docs.getflick.co/guides/financial-data/overview.md): Account linking, balances and credit reports.
- [Webhooks](https://docs.getflick.co/webhooks/overview.md): How Flick notifies you, and why you should not rely on the API response alone.
- [Verifying webhooks](https://docs.getflick.co/webhooks/verifying.md): Check the signature header before you act on a delivery.
- [Event reference](https://docs.getflick.co/webhooks/events.md): The events Flick sends and what each one means.
- [Testing webhooks](https://docs.getflick.co/webhooks/testing.md): Exercise your handler before you depend on it.
- [Bank codes](https://docs.getflick.co/reference/bank-codes.md): Flick bank codes for payouts and account linking.
- [Changelog](https://docs.getflick.co/reference/changelog.md): Notable changes to the Flick API and these docs.
- [Add Payer](https://docs.getflick.co/api-reference/add-payer.md): Adding a payer
- [Create Customer](https://docs.getflick.co/api-reference/create-customer.md): Creating a customer
- [Get Instiution](https://docs.getflick.co/api-reference/get-instiution.md): country Code
- [Add Account](https://docs.getflick.co/api-reference/add-account.md): Adding Account
- [Delete Payer](https://docs.getflick.co/api-reference/delete-payer.md): Delete Payer Account
- [Checkout V2](https://docs.getflick.co/api-reference/checkout-v2.md): Initiating Checkout version2
- [Bank (A2A)](https://docs.getflick.co/api-reference/bank-a2a.md): Inititating A Pay via Bank
- [Checkout](https://docs.getflick.co/api-reference/checkout.md): Initiating Checkout
- [Transation History](https://docs.getflick.co/api-reference/transation-history.md): Inititate a Trans History
- [chargeCard](https://docs.getflick.co/api-reference/card/chargecard.md): Card Charging
- [verifyPin](https://docs.getflick.co/api-reference/card/verifypin.md): Pin verification
- [verifyOtp ](https://docs.getflick.co/api-reference/card/verifyotp.md): Otp verification
- [Card Lookup](https://docs.getflick.co/api-reference/card/card-lookup.md): Card Lookup
- [NGN Ind.](https://docs.getflick.co/api-reference/virtual-accountibans/ngn-ind.md): Inititating A Pay via Permanent Virtual Nuban
- [GBP Ind.](https://docs.getflick.co/api-reference/virtual-accountibans/gbp-ind.md): Create A Pay via GBP individual  Virtual Nuban
- [EUR Ind.](https://docs.getflick.co/api-reference/virtual-accountibans/eur-ind.md): Create A Pay via Euro individual  Virtual Nuban
- [Corporate](https://docs.getflick.co/api-reference/virtual-accountibans/corporate.md): Corporate ibans
- [Retrieve Account / IBAN](https://docs.getflick.co/api-reference/virtual-accountibans/retrieve-account-iban.md): Getting your iban details with Flick
- [Initialize Re-Occcuring](https://docs.getflick.co/api-reference/direct-debit/initialize-re-occcuring.md): Inititating A Pay via Direct debit
- [Initialize  One-Time](https://docs.getflick.co/api-reference/direct-debit/initialize-one-time.md): Inititating A Pay via Direct debit
- [Direct Debit status](https://docs.getflick.co/api-reference/direct-debit/direct-debit-status.md): Direct Debit Transation status
- [Direct Debit History](https://docs.getflick.co/api-reference/direct-debit/direct-debit-history.md): Getting A Pay via Direct debit History
- [Cancel Direct Debit](https://docs.getflick.co/api-reference/direct-debit/cancel-direct-debit.md): Cancel via Direct debit
- [Initiate-Payout-NGN](https://docs.getflick.co/api-reference/initiate-payout-ngn.md): Inititating A Transfer
- [Verify Payout](https://docs.getflick.co/api-reference/verify-payout.md): Verifing A Transfer
- [banks](https://docs.getflick.co/api-reference/banks.md): Getting your commercial banks codes with Flick
- [Name enquiry](https://docs.getflick.co/api-reference/name-enquiry.md): Enquiry Account Name
- [Get Beneficiary](https://docs.getflick.co/api-reference/get-beneficiary.md): Getting user beneficiary
- [Create-Beneficiary-GBP](https://docs.getflick.co/api-reference/create-beneficiary-gbp.md): Inititate a Save-Beneficiary
- [Create-Beneficiary-EUR](https://docs.getflick.co/api-reference/create-beneficiary-eur.md): Inititate a Save-Beneficiary eur
- [Update Beneficiary EUR](https://docs.getflick.co/api-reference/update-beneficiary-eur.md): Inititate an Update-Beneficiary eur
- [Payout Beneficiary](https://docs.getflick.co/api-reference/payout-beneficiary.md): Inititate a Payout to Beneficiary
- [BVN](https://docs.getflick.co/api-reference/individualskyc/bvn.md): Means of Identifications
- [Phone Number](https://docs.getflick.co/api-reference/individualskyc/phone-number.md): Means of Identifications
- [NIN](https://docs.getflick.co/api-reference/individualskyc/nin.md): Means of Identifications
- [ Drivers license](https://docs.getflick.co/api-reference/individualskyc/drivers-license.md): Means of Identifications
- [Int's Passport](https://docs.getflick.co/api-reference/individualskyc/ints-passport.md): Means of Identifications
- [CAC_Basic](https://docs.getflick.co/api-reference/businesseskyb/cac_basic.md): CAC Identifications
- [CAC_Advance](https://docs.getflick.co/api-reference/businesseskyb/cac_advance.md): Advance Identifications
- [tinVerification](https://docs.getflick.co/api-reference/businesseskyb/tinverification.md): tin Identifications
- [Face Comparison](https://docs.getflick.co/api-reference/biometrics/face-comparison.md): Means of Identifications
- [Liveness Check](https://docs.getflick.co/api-reference/biometrics/liveness-check.md): Means of Identifications
- [Connect](https://docs.getflick.co/api-reference/connect.md): initilize bank linking
- [Identity](https://docs.getflick.co/api-reference/identity.md): customer identity
- [Balance](https://docs.getflick.co/api-reference/balance.md): flick balance
- [Transactions ](https://docs.getflick.co/api-reference/transactions.md): fetching transaction
- [Statement](https://docs.getflick.co/api-reference/statement.md): getting statement
- [Authorization](https://docs.getflick.co/api-reference/auth/authorization.md): Getting your banks authorization to be link with Flick
- [Coming Soon](https://docs.getflick.co/api-reference/analytics/coming-soon.md): Flick
- [Individual](https://docs.getflick.co/api-reference/credit-report/individual.md): Getting report with Flick
- [Business](https://docs.getflick.co/api-reference/credit-report/business.md): Getting your Business Enquiry Credit Report with Flick
- [Consent](https://docs.getflick.co/api-reference/account-lookup/consent.md): Getting your Banks with Flick
- [Retrieve Status](https://docs.getflick.co/api-reference/account-lookup/retrieve status.md): Getting your Banks Retrieve Status with Flick
- [NGN Corp](https://docs.getflick.co/api-reference/transmit-kyb/ngn-corp.md): Registration of user
- [Widget](https://docs.getflick.co/api-reference/transmit-kyb/widget.md): Create A Pay via widgets
- [Balance](https://docs.getflick.co/api-reference/balance.md): flick balance
- [Exchange Rate](https://docs.getflick.co/api-reference/exchange-rate.md): flick exchange rate
- [WebHook Resend](https://docs.getflick.co/api-reference/webhook-resend.md): Resinding webhook
- [Transaction Status](https://docs.getflick.co/api-reference/transaction-status.md): Transation

## OpenAPI Specs

- [collections](/openapi/collections.json)
- [connect](/openapi/connect.json)
- [financial-data](/openapi/financial-data.json)
- [identity](/openapi/identity.json)
- [payouts](/openapi/payouts.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.