flickpaysdk v1.1.9

paymentsdk

Flick PaymentSDK is a secure and quick way to for customer to access accounts and interacting with Flick API (Identity, Financial Data, Payout, Collections, Misc) Flick Payment SDK is a drop-in framework that handles connecting a financial institution to your app (multi-factor authentication, error handling, credential validation, etc). It works with all major Typescript and javascript frameworks.

Getting Started

• Register on the Flick website and get your public and secret keys.

• Setup a server to exchange tokens to access user financial data with your Flick secret key.

Installation

• You can install the package using NPM or Yarn;

 npm install flickpaysdk

or

yarn add flickpaysdk

• Then add it into your project;

const  Flickpay = require('flickpay-sdk');

• Or if you're using ES6 modules

import Flickpay  from 'flickpaysdk'

Initializing Flickpay

• To initialize the Flickpay SDK, create a new instance of the Flickpay class with your secret key:

const flickpay = new Flickpay('YOUR_SECRET_KEY');

Checkout Process

• You can initiate a checkout process using the flickCheckOut method:

const checkoutRequest = {
    amount: '1000',
    Phoneno: '1234567890',
    currency_collected: 'NGN',
    currency_settled: 'USD',
    email: < 'example@example.com',
    redirectUrl:'https://example.com/redirect',
    webhookUrl: 'https://example.com/webhook',
    transactionId:'1234567890'
};

flickpay.flickCheckOut(checkoutRequest)
    .then(response => {
        console.log(response);
    })
    .catch(error => {
        console.error(error);
    });

Bank List Retrieval

• You can retrieve a list of supported banks using the flickBankListSdk method:

flickpay.flickBankListSdk()
    .then(bankList => {
        console.log(bankList);
    })
    .catch(error => {
        console.error(error);
    });

Bank Name Inquiry

• You can perform a bank name inquiry using the flickBankNameInquirySdk method:

const bankNameRequest = {
     account_number: '1234567890',
     bank_code: '012'
};

flickpay.flickBankNameInquirySdk(bankNameRequest)
    .then(bankName => {
        console.log(bankName);
    })
    .catch(error => {
        console.error(error);
    });

Payout Initialization

• You can initiate a payout using the flickInitiatPayoutSdk method:

const payoutRequest = {
    bank_name: 'Example Bank',
    bank_code: '012',
    account_number: '1234567890',
    amount: '1000',
    narration: 'Payout for services',
    currency: 'NGN',
    beneficiary_name: 'John Doe',
    reference: '1234567890',
    debit_currency: 'USD',
    emai: 'example@example.com',
    mobile_number: '1234567890'
};

flickpay.flickInitiatPayoutSdk(payoutRequest)
    .then(payoutResponse => {
        console.log(payoutResponse);
    })
    .catch(error => {
        console.error(error);
    });

Payout Verification

• You can verify a payout using the flickVerifyPayoutSdk method:

const transactionId = '1234567890';

flickpay.flickVerifyPayoutSdk(transactionId)
    .then(verificationResponse => {
        console.log(verificationResponse);
    })
    .catch(error => {
        console.error(error);
    });

Identity Verification

• You can perform various identity verifications using the corresponding methods:

BVN (Bank Verification Number): flickIdentityBvnSdk
NIN (National Identification Number): flickIdentityNinSdk
CAC (Corporate Affairs Commission) Basic: flickIdentityCacBasicSdk
CAC (Corporate Affairs Commission) Advance: flickIdentityCacAdvanceSdk
KYB (Know Your Business) TIN (Tax Identification Number): flickpayKYBTINVerification

Best Practices

• Always handle errors returned by API calls. • Securely store and handle secret keys to prevent unauthorized access.

Troubleshooting

• If you encounter authentication errors, double-check your secret key and ensure it is correctly configured.

Support

• If you're having general trouble with flick paymentsdk or your Flick integration, please reach out to us or come chat with us on Slack channel. We will be more than happy to help you out with your integration to Flick