How to Integrate Account ID into the Instant Pay API

Integrating the Instant Pay API successfully involves meeting specific requirements for virtual account identification (ID). These requirements ensure that businesses comply with regulatory standards while avoiding errors during account creation. This guide provides a comprehensive explanation of the acceptable IDs, practical examples tailored to various business types, and sample code to streamline the integration process for developers.

When creating a virtual account, developers must include at least one valid form of identification based on the business type. The acceptable forms of identification are:

1. BVN (Bank Verification Number): A unique identifier associated with a customer’s bank account, which is commonly required for financial transactions in Nigeria.
2. NIN (National Identification Number): Issued by the National Identity Management Commission (NIMC), the NIN is widely used for identity verification.
3. Phone Number or Email: Basic contact details that link the account to an individual or business entity.

Including the correct ID ensures that the virtual account is created successfully. Supplying invalid or incorrect IDs will result in errors, disrupting the integration process. Each business category has its own set of acceptable IDs. The detailed table outlining these requirements can be found on the documentation.

Practical Scenarios for Virtual Account Creation

Example 1: Setting Up an Agriculture Business Account

Scenario: A farming business requires a virtual account to receive payments for produce sales.

• Required ID: BVN or NIN.

Request:

Response:

Example 2: Creating an Account for an Educational Institution

Scenario: A school needs to set up a virtual account for tracking tuition payments.

• Required IDs: BVN, NIN, Phone Number, or Email.

Request:

Response:

Example 3: Processing a Virtual Account for a Non-Profit Organisation

Scenario: A non-profit wants to receive donations through a virtual account.

• Required IDs: NIN, Phone Number, or Email.

Request:

Response:

If invalid or incomplete IDs are submitted, the API will return an error response. Ensure that the correct IDs are provided based on the business type to avoid such issues.

Error Response Example:

Final Recommendations

• Always validate the IDs against the acceptable requirements for the business category before submitting the request.
• Include the accountLabel to organise accounts effectively, especially when managing multiple accounts.
• Regularly test your integrations to catch potential issues early.

With this guide, developers can confidently integrate virtual account creation into their systems using the Instant Pay API, ensuring compliance and efficient payment processing for businesses of all sizes.