Integration options
This guide facilitates merchants in seamlessly integrating RecovaPRO into their digital applications, enabling them to secure full consent, establish secure electronic direct debit mandates, and initiate protected direct debit payments from their customers' bank accounts. Once the integration process is finalized, merchants gain the capability to generate secure and consented electronic mandates and initiate both scheduled and one-time debit payments directly from their customer's bank accounts. To integrate RecovaPRO into your web or mobile app, the following steps need to be taken for activation:
Merchant Activation Checklist
To start processing direct debits with RecovaPRO, complete the following onboarding steps:
- Create Merchant Account: Register and verify your business profile on the CreditChek SaaS Portal.
- Obtain API Keys: Generate your
token(API Secret Key) and retrieve yourappIdandbusinessId. - Configure Settlement Payouts: Set up your destination bank account for onward settlements.
- Register Webhook Endpoint: Input your secure webhook URL on the dashboard to receive real-time mandate updates.
- Select Opt-in Services: Enable Spectrum Credit Bureau reporting and ERM Credit Insurance as desired.
- Test in Sandbox: Run the end-to-end flow using the provided test credentials before going live.
SDK vs. API Integration
Merchants have two straightforward ways to integrate RecovaPRO:
- Vanilla JavaScript SDK: An embeddable drop-in client library for web and mobile web apps. It handles the payer consent UI, account selection, and authorization screens directly within your product. (this is coming soon as part of the CreditChek's Approval SDK)
- REST API: Comprehensive server-side endpoints for merchants who want complete control over their application UI, backend scheduler, and automated workflows.
As always, our Product Engineering Support is just an email or a ping away 😉.
SDK
The CreditChek RecovaPRO SDK employs secured & robust vanilla JavaScript technology that enables faster digital integration for any merchant who desires swift tailor-made solution integration for their customers, which includes secured, automated consented electronic mandate setup capabilities, detailed repayment breakdown, and payment schedule from customer’s bank account(s) directly into their existing digital products or applications.
API
The CreditChek RecovaPRO API provides comprehensive endpoints for many forms of digital lending or post-paid service activities to seamlessly integrate secured and reliable automated direct debit functionalities into their platforms and products, through electronic consent or mandates, reliable manual or automated repayment scheduling(collection), onward settlements, and credit-risk management to protect your business and ensure it thrives.
Categories of e-Mandates
To accommodate diverse lending merchants and post-paid services use cases, an e-mandate could be either of the following;
Variable
This offers convenience for both businesses and customers, as it allows for automatic payments to be made without the need for manual intervention or invoice reconciliation. This type of e-mandate covers direct debit arrangements that often require the customer to authorize the merchant or service provider to withdraw funds directly from their bank account, either on an ongoing basis or for specific transactions. This automated arrangement includes the frequency of payments and the maximum or total amounts that can be debited throughout the agreed lifetime of the e-mandate arrangement. However, customers need to monitor their bank statements regularly to ensure that the debited amounts are accurate and authorized.
Fixed
Fixed direct debit arrangements are commonly used for recurring payments, such as rent, mortgage payments, insurance premiums, subscription services, loan repayments, and membership fees. By setting up fixed direct debit payments, customers can automate their recurring financial obligations, ensuring they are paid on time without manual intervention. It outlines the terms and conditions of the payment arrangement, including the frequency of payments and the fixed amount to be debited for each transaction.
Account Types: Personal vs. Corporate
RecovaPRO enables you to configure direct debits for both retail consumers and registered corporate entities:
1. Personal Account (corporateAccount: false)
Designed for individual borrowers, consumers, and retail customers:
- Identification: Verified using the individual's 11-digit Bank Verification Number (
bvn). - Debit Ceiling: Supports debit amounts up to ₦20,000,000.00 per transaction.
- Fields: No corporate CAC registration fields are needed or allowed.
2. Corporate Account (corporateAccount: true)
Tailored for registered business entities, limited liability companies (LTD / PLC), partnerships, and commercial enterprises:
- Identification: Requires an authorized company director/signatory's
bvn, plus the company's verified Corporate Affairs Commission (CAC) credentials. - Elevated Debit Ceiling: Accommodates high-ticket B2B transactions, invoice discounting, equipment leases, and commercial trade finance with debit amounts up to ₦200,000,000.00 per transaction.
- Required Corporate Fields: When
corporateAccountis set totrue, the following business verification fields are strictly required:rcNumber: Registered CAC registration number (e.g.,"RC1829910"or"BN281902").businessName: Registered legal business entity name (e.g.,"ACME LOGISTICS LIMITED").businessEmail: Official company billing or finance email address.businessPhone: Official corporate contact phone number.
e-Mandate Authorization Methods
Payers authorize mandates through one of two channels:
For benefits of flexibility and convenience, there are two(2) ways e-mandates requests are created and authorized on the platform, largely influenced by how the target (debtors) bank accepts honouring such request on record:
Micro-Deposit
Accepting a time-bound, real-time inflow of NGN50 from the target customer's bank account into an auto-generated bank account, which serves as full authorization to consent and place the e-Mandate on the debtor’s bank record. The transfer must be successful within an hour, or else the request with e-Mandate placement expires. e-Mandate authorised with this method typically gets auto-approved within 24 hours.
Request parameters
| Name | Position | Required | Description |
|---|---|---|---|
| token | Headers | True | app secret key |
POST: https://api.creditchek.africa/v1/recova/micro-deposit/bank-list
💡 Supported banks for micro-deposit FIRST BANK OF NIGERIA PLC UNION BANK OF NIGERIA PLC GUARANTY TRUST BANK PLC ACCESS BANK PLC ZENITH INTERNATIONAL BANK PLC EcoBank Plc FIDELITY BANK PLC FIRST CITY MONUMENT BANK PLC Globus Bank Ltd JAIZ Bank KEYSTONE BANK PLC POLARIS BANK LIMITED Providus Bank Stanbic IBTC STANDARD CHARTERED BANK PLC STERLING BANK PLC SUNTRUST BANK TAJBank Ltd TITAN TRUST BANK United Bank for Africa Plc UNITY BANK PLC Wema Bank
Electronic Signature (e-Signature)
This involves the debtor/payer electronically appending their signature to match the signature recognized by the debtor’s bank on record (or file). The system allows up to 48 hours for the debtors' bank to approve this e-mandate request for onward processing.
e-Mandates Debit types
One-time
If the debit type is only a one-time transaction, then there would be no need to pass any frequency enum (string: daily | weekly | monthly) or expect an automated payment breakdown/summary.
Recurring
If the debit type is meant to reoccur over a defined period, you have to specify the ‘frequency’, ‘start date’, and ‘end date’, so the system can automatically generate the payment breakdown summary and respective debit due dates accordingly.
Collection Modes & Automated Scheduler
Automated (collectionMode: "auto")
CreditChek’s intelligent automated collection scheduler monitors the installment schedule and automatically triggers debits from the payer's linked bank account on each due date. If multiple bank accounts are enrolled under a Global Standing Mandate (GSM), the scheduler attempts the primary account first, cascading to backup accounts if the primary has insufficient balance.
Manual (collectionMode: "manual")
Merchants retain full control over when a debit occurs. The mandate is approved and stays active over the validity window, but no debits take place until your application triggers them via the manual collection endpoint.
[!TIP] Direct Debit Guarantee Payers are protected under consumer rights guidelines and are entitled to prompt dispute resolution for unauthorized or incorrect deductions via formal chargeback channels.
Advance Notification System
In compliance with statutory Direct Debit Scheme guidelines, payers must receive advance notification prior to scheduled debits:
- An advance schedule notification is dispatched upon mandate activation.
- A reminder notification is delivered at least 24 hours prior to every debit pull.
- Delivery channels include Email (free), Webhook (Free for all merchants. Can be automated to as part of your workflow to appear in the transaction activity or history or in-app push-notification about the scheduled debit), and optional SMS / WhatsApp channels.
RecovaPRO Automated Notification Preference
To enable the preferred automated email notification system for each mandate-related event required to be sent to the merchant and payer respectively on most transactions(including Advanced Notification before debt collection).
- Webhook Notification (Free for all merchants. Can be automated to as part of your workflow to appear in the transaction activity or history or in-app push-notification about the successful or failed debit).
- Email (Free for all merchants)
- SMS (Charges applies - coming soon)
If the Advance Notification before debt collection is disabled for Payers, Webhook MUST be used as an alternative and as it is required by the Direct Debit Scheme regulated by the central bank to notify any payer within 14 days before any debit is performed on an active e-mandate.
Payouts (onward settlements)
All businesses (merchants) require a dependable method for ensuring the receipt of all recuperated merchant funds to sustain ongoing expansion reliably. Thus, it is easier to provide more credits, recover, “rinse, and repeat” without hassle when onward settlement is reliable and available during operational hours. Our platform allows merchants to request electronic payouts every Monday through Saturday (9 am to 6 pm). It guarantees to get funds in the setup or desired destination bank account (taxes and surcharges excluded) within an SLA(service level agreement) of two hours.
RecovaPRO Webhook event types
For most merchants using the SDK and API integration, we have gone the extra mile to facilitate automating your digital system with RecovaPRO, these asynchronous communications are vital to enforcing desired automated workflows to improve the overall customer experience.
These are webhook events that are triggered when RecovaPRO async operations or actions are executed. We have itemized them down below for your reference:
See Webhooks for the payload and field reference of each mandate event that is live today.
Test Credentials & Sandbox Simulation
Use the following sandbox values to test your integration end-to-end without real bank transfers or database modifications:
| Test Entity | Sandbox Value | Usage & Effect |
|---|---|---|
| Demo BVN | 12345678901 or 09876543212 | Pass in POST /consent/create to receive an instant mock mandate (_id: "77192739b3cf770000000000"). |
| Demo Mandate ID | 77192739b3cf770000000000 | Exercises date-range and breakdown validation without real database persistence. |
| Demo App ID | 730c8be89131cd1111111111 | Application identifier recognized in sandbox test flows. |
| Demo Business ID | 730c8be89121212121212121 | Merchant business ID recognized across sandbox test endpoints. |
| Demo Product ID | 768fc9999999999999999999 | Product / Loan package identifier for test mandates. |
| Demo Reference | 563315af-f0a4-420f-8e5e-df9b1c28973b | Deterministic transaction reference returned across test mandate operations. |
| Demo Accounts | 1234567890 (Access Bank 044)0987654321 (Zenith Bank 057) | Pass in POST /micro-deposit/create/mandate or /gsm to test transfer authorization destinations. |
| Demo Customer | John Smith[email protected] / 08012345678 | Pre-verified mock customer identity linked to sandbox BVN & accounts. |