VigiPay Documentation

Welcome to VigiPay! the developer center for integrating your business with us. Get familiar with our tools and products by using the information below.

Step 1 - Sign Up

Create an account on VigiPay. To create an account you need your email address, company name, first name and last name

Step 2 - Set Up

Setup your account by updating your business information, customize your settings such as invoice, adjustment profile, settlement profile and create your customer.

Step 3 - Request API

Go to the API page and select APIs.

Step 4 - Integration

Waiting....

Overview

VigiPay was designed to serve unlimited number of customers with diverse requirements fundamentally solving issues around invoicing, payments, settlements and reconciliations. Our solution is simple to use, flexible and robust. Here you will find detailed information about our APIs and how to them. If you have questions or comments, kindly leave us a message at support@vigipay.co

Get Started

Before you start to plug any of our APIs into your expert system, you will need to create an account with us, do some basic account set up and provide us with your callback URL through our API request from. Providing a callback URL for each of your expert system is a precondition for consuming our APIs. We will be required to validate who you are after agreeing to our terms and conditions. After these things are in place, you are welcome to endless opportunities on VigiPay.

What you need to sign up on VigiPay

  • Visit VigiPay’s website https://gateway.vigipay.co
  • Click on the Sign Up button
  • Fill the signup form with your business email address
  • An email will be sent to you requesting you to validate your email
  • Click on the validation link in your email
  • After we validate your email, you will be redirected to a form to complete your signup process
  • After you must have completed the signup process, you will be redirected to a sign in page
  • Sign in with your correct login details to gain access to your VigiPay account.

How to set up your VigiPay account

  • If you are signing in for the first time, a setup process is required
  • You will need to fill basic information about your business such as your business name, RC number, Tax ID, your basic currency and your address
  • You will also need to upload your business logo
  • Anytime you perform a transaction, there is a transaction charge, you will need to tell us who should bear this transaction charge. You can decide either you or your customer will bear this charge – we call this your Charge Profile
  • We understand that while raising an invoice to your customer, you might need to include some deductibles and inclusions such as discounts and VAT, you will need to inform us by setting VAT as default – we call this your Adjustment Profile
  • You will need to link at least one account number to your VigiPay account. This will be your default account where all your revenues will be collected. We have a provision for you to add multiple bank accounts and split your revenue as you wish – this can be done in the Settlement Profile
  • You will be required to give all the above profiles a general name which we call a Revenue Line
  • The final step allows you to create your first customer. You will need to enter both business details of your customer and add the contact details of who you interface with in their business
  • After doing the above, you have successfully completed setting up your account on VigiPay.

Request API Access

Before you can create an invoice, make payments or use any of VigiPay’s services, you will need to request for API access. The steps below will guide you through the process of gaining access to the APIs:

  • Once the user has signed in, the user clicks on API Documentation
  • You will be able to see the list of all expert systems you have integrated VigiPay with
  • You will be required to fill the API request form with the following details:
    • URL - The full URL of the your application that will call VigiPay API
    • IP Address - The IP Address of your application that will call VigiPay API
    • Callback URL- Call back URL on your website that receives HTTP POST. This is required for VigiPay to send notifications to your expert system.
  • VigiPay will approve your request
  • You will gain access to a list of APIs
  • You can then consume the required APIs
  • At this stage, VigiPay will assign an account manager to you who will be in charge of monitoring your portfolio on VigiPay.

How Do You Want VigiPay To Work For You?

Since we know our customers have various needs, we have tailored our APIs to satisfy your needs and broken the process into steps:

For Basic Invoicing

Do you want VigiPay for basic invoicing, follow the following steps:

  • Sign up on Vigipay using your business email
  • Sets up your account on VigiPay
  • Request API on VigiPay by filling the API request form
  • System admin approves request
  • You gain access to list of APIs. You will require the following APIs for invoicing:
    • AdjustmentItems
    • AdjustmentProfiles
    • ChargeItems
    • ChargeProfiles
    • InvoiceContact
    • InvoiceItems
    • InvoiceReference
    • InvoicesExtended
    • Locations
    • Rates
    • RevenueAdjustmentProfiles
    • RevenueChargeProfiles
    • Revenues
    • RevenueSettlementProfiles
    • RevenuesExtended
    • SettlementItems
    • SettlementProfiles
    • Addresses
    • Contacts
    • CorporateAddresses
    • Corporates
    • CorporatesUsers
    • Currencies
    • CustomerContact
    • Customers
  • Consume the required APIs
  • Raise invoices to your customers
  • VigiPay sends an email notification to your customers.
For Invoicing and Payment (Card services) – Vigi-WebPay

This allows you inform VigiPay to deduct money from your customers and credit your account – this requires your client to pay with their bank cards. Do you want VigiPay for invoicing and Payment, follow the following steps:

  • Sign up on Vigipay using a company email
  • Sets up your account on VigiPay
  • Requests API on VigiPay by filling the API request form
  • When you gain access to list of APIs, you will require the following APIs for invoicing and payment:
    • AdjustmentItems
    • AdjustmentProfiles
    • ChargeItems
    • ChargeProfiles
    • InvoiceContact
    • InvoiceItems
    • InvoiceReference
    • InvoicesExtended
    • Locations
    • Rates
    • RevenueAdjustmentProfiles
    • RevenueChargeProfiles
    • Revenues
    • RevenueSettlementProfiles
    • RevenuesExtended
    • SettlementItems
    • SettlementProfiles
    • Addresses
    • Contacts
    • CorporateAddresses
    • Corporates
    • CorporatesUsers
    • Currencies
    • CustomerContact
    • Customers
    • PaymentChannel
    • PaymentChannelAccount
    • FinanceSummaries
    • PaymentChannelCharges
    • PaymentChannelChargesExtended
    • PaymentExtended
    • Payments
    • PaymentStagings
  • Consumes the required APIs
  • Since you are not opting for the direct debit, you will be required to activate your preferred payment channels through which you will like to receive money from your customers
  • You can then raise invoices to your client
  • A notification email will be sent to your client
  • Your client will be required to initiate payment from the notification email. This action will redirect them to the payments channel page
  • Your client will select a desire payment channel from the payment channel(s) you must have activated for your account
  • Your client’s account will be debited and your account will be credited.
For Invoicing and Payment (Direct Debit) – Vigi-InvoicePay

This allows you inform VigiPay to automatically deduct money from your customers and credit your account – this is called direct debit. Do you want VigiPay for invoicing, directly debit your customers and credit you? Follow the following steps:

  • Sign up on Vigipay using a company email
  • Set up your account on VigiPay
  • RequestsAPI on VigiPay by filling the API request form
  • When you gain access to a list of APIs, you will require the following APIs for invoicing and payment:
    • AdjustmentItems
    • AdjustmentProfiles
    • ChargeItems
    • ChargeProfiles
    • InvoiceContact
    • InvoiceItems
    • InvoiceReference
    • InvoicesExtended
    • Locations
    • Rates
    • RevenueAdjustmentProfiles
    • RevenueChargeProfiles
    • Revenues
    • RevenueSettlementProfiles
    • RevenuesExtended
    • SettlementItems
    • SettlementProfiles
    • Addresses
    • Contacts
    • CorporateAddresses
    • Corporates
    • CorporatesUsers
    • Currencies
    • CustomerContact
    • Customers
    • PaymentChannel
    • PaymentChannelAccount
    • FinanceSummaries
    • PaymentChannelCharges
    • PaymentChannelChargesExtended
    • PaymentExtended
    • Payments
    • PaymentStagings
  • Consume the required APIs
  • You will need to create a mandate request
  • Your client will be required to sign up on VigiPay
  • Your client will also be required to create a mandate request
  • An account manager handles all mandate request for you and your client
  • When you get your mandate code, you can then proceed to raise invoices to your client
  • A notification email will be sent to your client
  • Your client’s account will be debited and your account will be credited.
For Payouts –

If your business is such that requires you to frequently disburse money to many accounts (e.g salaries) VigiPay has a Payouts feature for you. This allows you to upload the list of all the accounts you would like to send money to, all these accounts will be validated and credited on a single click. Do you want VigiPay to handle your payouts for you, follow the following steps:

  • Sign up on Vigipay using a company email
  • Set up your account on VigiPay
  • Request API on VigiPay by filling the API request form
  • You gain access to list of APIs. You will require the following APIs for payouts:
    • PayoutItems
    • Payouts
    • PayoutsExtended
  • Consume the required APIs
  • You will be required to create a payout by filling a simple form which involved downloading the payout schedule template from VigiPay (on the create payouts page) in an excel format, filling the document with the details and uploading the document.
  • You will also be required to name that particular schedule, select your mandate code, give a remark and upload the list of accounts you want to send money to, this list is called a payout schedule
  • When a payout is initiated, a notification email will be sent to your client
  • Your account will be debited and all the accounts for all beneficiaries of the payout will be credited.

Organization – serves as a repo for organizations. Organizations can search for other organizations they do business with and add them to their customer base on VigiPay. If such organization is not found, VigiPay has a provision to add new organizations.

Invoicing – this enables corporates/individuals create invoices, save invoices, view receivable and payable invoices.

Payment – are made against raised invoices and allows easy movement of money across different accounts.

Settlement – allows corporates/individuals settle funds to different parties seamlessly.

Corporate Lounge – provides a single view corporates to view all their accounts.