@grtsnx/payba3 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/CODE_OF_CONDUCT.md +24 -0
  3. package/CONTRIBUTING.md +149 -0
  4. package/LICENSE +21 -0
  5. package/README.md +282 -0
  6. package/SECURITY.md +53 -0
  7. package/SUPPORT.md +27 -0
  8. package/assets/payba3-logo.svg +17 -0
  9. package/dist/index.d.ts +18 -0
  10. package/dist/index.js +24 -0
  11. package/dist/lib/lib.module.d.ts +2 -0
  12. package/dist/lib/lib.module.js +37 -0
  13. package/dist/lib/lib.module.js.map +1 -0
  14. package/dist/lib/monnify/config/monnify.helper.d.ts +24 -0
  15. package/dist/lib/monnify/config/monnify.helper.js +234 -0
  16. package/dist/lib/monnify/config/monnify.helper.js.map +1 -0
  17. package/dist/lib/monnify/config/monnify.types.d.ts +93 -0
  18. package/dist/lib/monnify/config/monnify.types.js +3 -0
  19. package/dist/lib/monnify/config/monnify.types.js.map +1 -0
  20. package/dist/lib/monnify/monnify.module.d.ts +2 -0
  21. package/dist/lib/monnify/monnify.module.js +22 -0
  22. package/dist/lib/monnify/monnify.module.js.map +1 -0
  23. package/dist/lib/monnify/monnify.service.d.ts +19 -0
  24. package/dist/lib/monnify/monnify.service.js +113 -0
  25. package/dist/lib/monnify/monnify.service.js.map +1 -0
  26. package/dist/lib/mono/config/mono.helper.d.ts +11 -0
  27. package/dist/lib/mono/config/mono.helper.js +78 -0
  28. package/dist/lib/mono/config/mono.helper.js.map +1 -0
  29. package/dist/lib/mono/config/mono.types.d.ts +48 -0
  30. package/dist/lib/mono/config/mono.types.js +3 -0
  31. package/dist/lib/mono/config/mono.types.js.map +1 -0
  32. package/dist/lib/mono/mono.module.d.ts +2 -0
  33. package/dist/lib/mono/mono.module.js +22 -0
  34. package/dist/lib/mono/mono.module.js.map +1 -0
  35. package/dist/lib/mono/mono.service.d.ts +15 -0
  36. package/dist/lib/mono/mono.service.js +77 -0
  37. package/dist/lib/mono/mono.service.js.map +1 -0
  38. package/dist/lib/opay/config/opay.helper.d.ts +17 -0
  39. package/dist/lib/opay/config/opay.helper.js +175 -0
  40. package/dist/lib/opay/config/opay.helper.js.map +1 -0
  41. package/dist/lib/opay/config/opay.types.d.ts +73 -0
  42. package/dist/lib/opay/config/opay.types.js +3 -0
  43. package/dist/lib/opay/config/opay.types.js.map +1 -0
  44. package/dist/lib/opay/opay.module.d.ts +2 -0
  45. package/dist/lib/opay/opay.module.js +22 -0
  46. package/dist/lib/opay/opay.module.js.map +1 -0
  47. package/dist/lib/opay/opay.service.d.ts +17 -0
  48. package/dist/lib/opay/opay.service.js +104 -0
  49. package/dist/lib/opay/opay.service.js.map +1 -0
  50. package/dist/lib/payba3.service.d.ts +16 -0
  51. package/dist/lib/payba3.service.js +59 -0
  52. package/dist/lib/payba3.service.js.map +1 -0
  53. package/dist/lib/payba3.types.d.ts +18 -0
  54. package/dist/lib/payba3.types.js +13 -0
  55. package/dist/lib/payba3.types.js.map +1 -0
  56. package/dist/lib/paystack/config/paystack.helper.d.ts +15 -0
  57. package/dist/lib/paystack/config/paystack.helper.js +134 -0
  58. package/dist/lib/paystack/config/paystack.helper.js.map +1 -0
  59. package/dist/lib/paystack/config/paystack.types.d.ts +92 -0
  60. package/dist/lib/paystack/config/paystack.types.js +3 -0
  61. package/dist/lib/paystack/config/paystack.types.js.map +1 -0
  62. package/dist/lib/paystack/paystack.module.d.ts +2 -0
  63. package/dist/lib/paystack/paystack.module.js +22 -0
  64. package/dist/lib/paystack/paystack.module.js.map +1 -0
  65. package/dist/lib/paystack/paystack.service.d.ts +33 -0
  66. package/dist/lib/paystack/paystack.service.js +328 -0
  67. package/dist/lib/paystack/paystack.service.js.map +1 -0
  68. package/dist/lib/qoreid/config/qoreid.helper.d.ts +19 -0
  69. package/dist/lib/qoreid/config/qoreid.helper.js +132 -0
  70. package/dist/lib/qoreid/config/qoreid.helper.js.map +1 -0
  71. package/dist/lib/qoreid/config/qoreid.types.d.ts +35 -0
  72. package/dist/lib/qoreid/config/qoreid.types.js +3 -0
  73. package/dist/lib/qoreid/config/qoreid.types.js.map +1 -0
  74. package/dist/lib/qoreid/qoreid.module.d.ts +2 -0
  75. package/dist/lib/qoreid/qoreid.module.js +22 -0
  76. package/dist/lib/qoreid/qoreid.module.js.map +1 -0
  77. package/dist/lib/qoreid/qoreid.service.d.ts +10 -0
  78. package/dist/lib/qoreid/qoreid.service.js +63 -0
  79. package/dist/lib/qoreid/qoreid.service.js.map +1 -0
  80. package/dist/lib/safehaven/config/safe.helper.d.ts +16 -0
  81. package/dist/lib/safehaven/config/safe.helper.js +136 -0
  82. package/dist/lib/safehaven/config/safe.helper.js.map +1 -0
  83. package/dist/lib/safehaven/config/safe.types.d.ts +50 -0
  84. package/dist/lib/safehaven/config/safe.types.js +3 -0
  85. package/dist/lib/safehaven/config/safe.types.js.map +1 -0
  86. package/dist/lib/safehaven/safe.module.d.ts +2 -0
  87. package/dist/lib/safehaven/safe.module.js +22 -0
  88. package/dist/lib/safehaven/safe.module.js.map +1 -0
  89. package/dist/lib/safehaven/safe.service.d.ts +14 -0
  90. package/dist/lib/safehaven/safe.service.js +77 -0
  91. package/dist/lib/safehaven/safe.service.js.map +1 -0
  92. package/dist/lib/seerbit/config/seerbit.helper.d.ts +11 -0
  93. package/dist/lib/seerbit/config/seerbit.helper.js +88 -0
  94. package/dist/lib/seerbit/config/seerbit.helper.js.map +1 -0
  95. package/dist/lib/seerbit/config/seerbit.types.d.ts +49 -0
  96. package/dist/lib/seerbit/config/seerbit.types.js +3 -0
  97. package/dist/lib/seerbit/config/seerbit.types.js.map +1 -0
  98. package/dist/lib/seerbit/seerbit.module.d.ts +2 -0
  99. package/dist/lib/seerbit/seerbit.module.js +22 -0
  100. package/dist/lib/seerbit/seerbit.module.js.map +1 -0
  101. package/dist/lib/seerbit/seerbit.service.d.ts +11 -0
  102. package/dist/lib/seerbit/seerbit.service.js +83 -0
  103. package/dist/lib/seerbit/seerbit.service.js.map +1 -0
  104. package/dist/lib/shared/index.d.ts +1 -0
  105. package/dist/lib/shared/index.js +18 -0
  106. package/dist/lib/shared/index.js.map +1 -0
  107. package/dist/lib/shared/response.helper.d.ts +15 -0
  108. package/dist/lib/shared/response.helper.js +39 -0
  109. package/dist/lib/shared/response.helper.js.map +1 -0
  110. package/llms.txt +25 -0
  111. package/package.json +169 -0
  112. package/src/lib/monnify/monnify_llm.txt +429 -0
  113. package/src/lib/mono/mono_llm.txt +372 -0
  114. package/src/lib/opay/opay_llm.txt +1022 -0
  115. package/src/lib/paystack/paystack_llm.txt +382 -0
  116. package/src/lib/qoreid/qoreid_llm.txt +68 -0
  117. package/src/lib/safehaven/safehaven_llm.txt +77 -0
  118. package/src/lib/seerbit/seerbit_llm.txt +61 -0
@@ -0,0 +1,372 @@
1
+ # Mono Banking API Documentation
2
+
3
+ > Mono is an African open banking platform that provides APIs for accessing financial data, initiating payments, and verifying identities. Mono enables fintechs, lenders, and businesses to securely connect to users' bank accounts across Nigeria, Ghana, Kenya, and South Africa.
4
+
5
+ Important notes:
6
+
7
+ - All API requests require authentication using the `mono-sec-key` header with your App secret key
8
+ - Mono provides two environments: Sandbox (free testing) and Live (production with wallet funding required)
9
+ - Currency values in API responses are in the lowest denomination (NGN: kobo, GHC: pesewa, KSH/ZAR: cents)
10
+ - The Mono Connect Widget is used to securely link user accounts via SDK or Connect Link
11
+
12
+ ## Getting Started
13
+
14
+ - [Definitions](https://docs.mono.co/docs/definitions): Key terms including Account ID, Token, Public Key, Secret Key, and Enrolment process
15
+ - [Use Cases](https://docs.mono.co/docs/use-cases): Common implementation scenarios for lending, banking, payments, wealth management, and accounting
16
+ - [Creating an App](https://docs.mono.co/docs/create-app): How to create applications on the Mono dashboard and retrieve API keys
17
+ - [Environments](https://docs.mono.co/docs/environments): Understanding Sandbox vs Live environments and switching between them
18
+ - [Sandbox](https://docs.mono.co/docs/sandbox): Test credentials and sample data for development without affecting real accounts
19
+ - [Webhooks](https://docs.mono.co/docs/webhooks): Configure webhook URLs to receive real-time transaction and account update notifications
20
+ - [Go Live Checklist](https://docs.mono.co/docs/go-live): Requirements and steps to transition from sandbox to production
21
+ - [Quick Start](https://docs.mono.co/docs/quickstart): Step-by-step guide to get your first integration running
22
+ - [Errors](https://docs.mono.co/docs/errors): Common error codes, their meanings, and how to handle them
23
+ - [FAQs](https://docs.mono.co/docs/faqs): Frequently asked questions about Mono APIs and integration
24
+
25
+ ## Customer Management
26
+
27
+ - [Customer Overview](https://docs.mono.co/docs/customers): Managing individual and business customers, linking accounts, and tracking transactions
28
+
29
+ ## Financial Data (Mono Connect)
30
+
31
+ - [Overview](https://docs.mono.co/docs/financial-data/overview): Introduction to Mono Connect for accessing bank account data with user permission
32
+
33
+ ### Integration Guides
34
+
35
+ - [SDK Integration Guide](https://docs.mono.co/docs/financial-data/integration-guide): Step-by-step guide to integrate Mono Connect SDK into your application
36
+ - [Connect Link Guide](https://docs.mono.co/docs/financial-data/connect-link): Use Mono-hosted links for account linking without SDK integration
37
+ - [Reauth Link Guide](https://docs.mono.co/docs/financial-data/reauth-link): Re-authenticate expired or disconnected account sessions
38
+ - [SDK Config Guide](https://docs.mono.co/docs/financial-data/sdk): Advanced SDK configuration options and customization
39
+
40
+ ### Real-time Data
41
+
42
+ - [Real-time Data](https://docs.mono.co/docs/financial-data/realtime-data): Manually refresh and retrieve current balance and transaction data from linked accounts
43
+
44
+ ### Partners API Guide
45
+
46
+ - [Partners API Overview](https://docs.mono.co/docs/financial-data/partners-api-guide/overview): Direct API integration without the Connect Widget for custom implementations
47
+ - [Partners Integration Guide](https://docs.mono.co/docs/financial-data/partners-api-guide/integration-guide): Detailed steps for Partners API implementation
48
+ - [Reauthorisation Guide](https://docs.mono.co/docs/financial-data/partners-api-guide/reauth-guide): Handle session expiry and re-authentication flows
49
+ - [Sandbox Guide](https://docs.mono.co/docs/financial-data/partners-api-guide/sandbox-guide): Testing Partners API with sandbox credentials
50
+
51
+ ### Data Enrichment
52
+
53
+ - [Enrichment Overview](https://docs.mono.co/docs/financial-data/enrichment/overview): AI-powered transaction analysis and categorization features
54
+ - [Transaction Categorisation](https://docs.mono.co/docs/financial-data/enrichment/transaction-categorisation): Automatically categorize transactions into spending categories
55
+ - [Transaction Metadata](https://docs.mono.co/docs/financial-data/enrichment/transaction-metadata): Extract merchant names, logos, and additional transaction context
56
+ - [Statement Insights](https://docs.mono.co/docs/financial-data/enrichment/statement-insights): Generate financial health insights from bank statements
57
+
58
+ ### Endpoints
59
+
60
+ - [Authorization](https://docs.mono.co/docs/financial-data/authorization): Exchange authorization codes for permanent Account IDs
61
+ - [Account Information](https://docs.mono.co/docs/financial-data/account-information): Retrieve account details including type, currency, balance, and holder information
62
+ - [Transactions](https://docs.mono.co/docs/financial-data/transactions): Fetch transaction history with filtering by date, type, and narration
63
+ - [Statements](https://docs.mono.co/docs/financial-data/statements): Generate and download bank statements in PDF or JSON format
64
+ - [Identity](https://docs.mono.co/docs/financial-data/identity): Retrieve verified user identity information for KYC purposes
65
+ - [Income](https://docs.mono.co/docs/financial-data/income): Analyze income patterns including monthly average, salary estimates, and income sources
66
+ - [Assets](https://docs.mono.co/docs/financial-data/assets): Access investment portfolio holdings across linked accounts
67
+ - [Earnings](https://docs.mono.co/docs/financial-data/earnings): Retrieve earnings and returns on investment assets
68
+ - [Credit Worthiness](https://docs.mono.co/docs/financial-data/credit-worthiness): Generate credit scores and affordability assessments
69
+
70
+ ### Webhook Events
71
+
72
+ - [Webhook Introduction](https://docs.mono.co/docs/financial-data/webhook-introduction): Overview of Financial Data webhook events and payload structure
73
+ - [Auth (Connection)](https://docs.mono.co/docs/financial-data/auth-connection): Webhook triggered when a user successfully links their account
74
+ - [Account Update (Balance)](https://docs.mono.co/docs/financial-data/account-update): Webhook triggered when account data is refreshed
75
+ - [Unlink (Disconnection)](https://docs.mono.co/docs/financial-data/unlink): Webhook triggered when a user disconnects their account
76
+
77
+ ## Payments
78
+
79
+ - [Overview](https://docs.mono.co/docs/payments/overview): Introduction to Mono Payment APIs for direct bank debits and transfers
80
+ - [Payouts](https://docs.mono.co/docs/payments/payouts): Send money from your Mono wallet to bank accounts
81
+
82
+ ### One-time DirectPay
83
+
84
+ - [One-time Overview](https://docs.mono.co/docs/payments/onetime/overview): Single charge payments directly from customer bank accounts
85
+ - [Integration Guide](https://docs.mono.co/docs/payments/onetime/integration-guide): Step-by-step DirectPay implementation
86
+ - [SDK Guide](https://docs.mono.co/docs/payments/sdk-guide): Integrate DirectPay using Mono SDKs
87
+ - [Webhook Events](https://docs.mono.co/docs/payments/onetime/webhook-events): Payment status notifications and event handling
88
+ - [Payment Status](https://docs.mono.co/docs/payments/onetime/payment-status): Understanding payment states and verification
89
+
90
+ ### Recurring Direct Debit
91
+
92
+ - [Direct Debit Overview](https://docs.mono.co/docs/payments/direct-debit/overview): Set up mandates for recurring and subscription payments
93
+ - [Integration Guide](https://docs.mono.co/docs/payments/direct-debit/integration-guide): Complete Direct Debit implementation walkthrough
94
+ - [Step 1: Create Customers](https://docs.mono.co/docs/payments/direct-debit/integration-guide-create-customers): Register customers before mandate setup
95
+ - [Step 2: Mandate Setup Explained](https://docs.mono.co/docs/payments/direct-debit/mandate-setup-explained): Understanding mandate types and authorization
96
+ - [Step 2a: Variable Mandate Setup](https://docs.mono.co/docs/payments/direct-debit/mandate-setup-variable): Flexible debit amounts within a total limit
97
+ - [Step 2b: Fixed Mandate Setup](https://docs.mono.co/docs/payments/direct-debit/mandate-setup-fixed): Fixed recurring debit amounts
98
+ - [Step 3: Debit Account](https://docs.mono.co/docs/payments/direct-debit/debit-an-account): Execute debits against approved mandates
99
+ - [Global Standing Mandate](https://docs.mono.co/docs/payments/direct-debit/global-standing-mandate): GSM mandate type for certain banks
100
+ - [Mandate Biometrics Verification](https://docs.mono.co/docs/payments/direct-debit/mandate-biometric-verification): Enhanced security with biometric authorization
101
+ - [Direct Debit Webhook Events](https://docs.mono.co/docs/payments/direct-debit/webhook-events): Mandate and debit status notifications
102
+
103
+ ### Split Payments
104
+
105
+ - [Split Payments](https://docs.mono.co/docs/payments/split-payments): Allocate payments across multiple accounts in a single transaction
106
+
107
+ ### WhatsApp Payment (Owo)
108
+
109
+ - [WhatsApp Payment Overview](https://docs.mono.co/docs/whatsapp-payment/overview): Collect payments via WhatsApp using Owo Direct Charge
110
+ - [Integration Guide](https://docs.mono.co/docs/whatsapp-payment/integration-guide): Implement WhatsApp-based payment collection
111
+ - [Webhook Events](https://docs.mono.co/docs/whatsapp-payment/webhook-events): WhatsApp payment status notifications
112
+
113
+ ### Disburse
114
+
115
+ - [Disburse Overview](https://docs.mono.co/docs/disburse/overview): Bulk and scheduled payouts to bank accounts
116
+ - [Integration Guide](https://docs.mono.co/docs/disburse/integration-guide): Implement instant and scheduled disbursements
117
+ - [Webhook Events](https://docs.mono.co/docs/disburse/webhook-events): Disbursement status notifications
118
+
119
+ ## Identity Verification (Lookup)
120
+
121
+ - [Overview](https://docs.mono.co/docs/lookup/overview): Verify and validate user and business data for KYC compliance
122
+
123
+ ### Lookup Integration Guides
124
+
125
+ - [BVN iGree](https://docs.mono.co/docs/lookup/bvn-igree): Bank Verification Number lookup with consent-based verification
126
+ - [CAC Lookup](https://docs.mono.co/docs/lookup/cac-lookup): Verify Nigerian business registration with Corporate Affairs Commission
127
+ - [Account Number](https://docs.mono.co/docs/lookup/account-number): Validate and verify bank account numbers
128
+ - [House Address Verification](https://docs.mono.co/docs/lookup/house-address): Confirm physical address validity and ownership
129
+ - [Int'l Passport Lookup](https://docs.mono.co/docs/lookup/intl-passport): Verify international passport documents
130
+ - [TIN Lookup](https://docs.mono.co/docs/lookup/tin-lookup): Tax Identification Number verification
131
+ - [Driver's License Lookup](https://docs.mono.co/docs/lookup/drivers-license): Verify driver's license information
132
+ - [NIN Lookup](https://docs.mono.co/docs/lookup/nin-lookup): National Identification Number verification
133
+ - [Credit History Lookup](https://docs.mono.co/docs/lookup/credit-history-lookup): Retrieve credit bureau reports using BVN
134
+ - [Mashup Lookup](https://docs.mono.co/docs/lookup/mashup): Combined NIN, BVN, and DOB verification in one API call
135
+
136
+ ### Prove (eKYC)
137
+
138
+ - [Prove Overview](https://docs.mono.co/docs/lookup/prove/overview): Multi-tier KYC verification with facial recognition
139
+ - [Prove Integration Guide](https://docs.mono.co/docs/lookup/prove/integration-guide): Implement tiered identity verification flows
140
+
141
+ ## Developer Tools
142
+
143
+ - [Brand Assets](https://docs.mono.co/docs/brand-assets): Mono logos, icons, and branding guidelines for your integration
144
+ - [Libraries](https://docs.mono.co/docs/libraries): Server-side libraries for Node.js, Python, PHP, Ruby, and more
145
+ - [SDKs](https://docs.mono.co/docs/sdks): Client-side SDKs for Web, React Native, iOS, Android, and Flutter
146
+ - [Postman Collection](https://docs.mono.co/docs/postman): Pre-configured Postman collection for testing Mono APIs
147
+
148
+ ## Optional
149
+
150
+ - [API Reference](https://docs.mono.co/api): Complete API endpoint documentation with request/response examples
151
+ - [Coverage](https://docs.mono.co/docs/coverage): Supported financial institutions across Nigeria, Ghana, Kenya, and South Africa
152
+ - [Changelog](https://docs.mono.co/docs/changelog): API updates, new features, and breaking changes
153
+ - [API Status](https://status.mono.co): Real-time status of Mono APIs and services
154
+ - [Support Center](https://support.mono.co/en): Help articles, guides, and customer support
155
+ - [Developer Community](https://devwithmono.slack.com): Join the Mono developer Slack community
156
+
157
+ ---
158
+
159
+ # API Reference
160
+
161
+ > Complete API reference for Mono's African open banking platform. All endpoints use the base URL `api.withmono.com` and require authentication via the `mono-sec-key` header. Currency values are returned in the lowest denomination (NGN kobo, GHC pesewa, KSH/ZAR cents).
162
+
163
+ Important notes:
164
+
165
+ - Authentication: Set the `mono-sec-key` header with your App secret key for all requests
166
+ - Sandbox mode is free; Live mode requires wallet funding
167
+ - API versions: Most endpoints use v2, some newer endpoints use v3
168
+ - Rate limits apply; implement exponential backoff for retries
169
+ - All webhook payloads follow the format: `{ event: "mono.events.*", data: {...} }`
170
+
171
+ ## Customer API
172
+
173
+ - [Create Individual Customer](https://docs.mono.co/api/customer/create-a-customer): `POST` - Register an individual customer with name, email, and optional identity details
174
+ - [Create Business Customer](https://docs.mono.co/api/customer/create-a-business-customer): `POST` - Register a business customer with company details
175
+ - [Retrieve Customer](https://docs.mono.co/api/customer/retrieve-a-customer): `GET` - Fetch details of a specific customer by ID
176
+ - [List All Customers](https://docs.mono.co/api/customer/list-all-customers): `GET` - Retrieve paginated list of all customers
177
+ - [Get Customer Transactions](https://docs.mono.co/api/customer/get-all-customer-transactions): `GET` - Fetch all transactions across a customer's linked accounts
178
+ - [Fetch All Linked Accounts](https://docs.mono.co/api/customer/fetch-all-linked-accounts): `GET` - List all bank accounts linked to a customer
179
+ - [Update Customer](https://docs.mono.co/api/customer/update-a-customer): `PATCH` - Update customer information
180
+ - [Delete Customer](https://docs.mono.co/api/customer/delete-a-customer): `DELETE` - Remove a customer and their associated data
181
+
182
+ ## Bank Data API
183
+
184
+ ### Authorisation
185
+
186
+ - [Initiate Account Linking](https://docs.mono.co/api/bank-data/authorisation/initiate-account-linking): `POST /v2/accounts/initiate` - Generate a Connect Widget link for user account linking
187
+ - [Exchange Token](https://docs.mono.co/api/bank-data/authorisation/exchange-token): `POST /v2/accounts/auth` - Exchange temporary authorization code for permanent Account ID
188
+ - [Initiate Re-authorisation](https://docs.mono.co/api/bank-data/authorisation/initiate-account-reauth): `POST` - Generate link to re-authenticate expired sessions
189
+
190
+ ### Partners API
191
+
192
+ - [Create Session](https://docs.mono.co/api/bank-data/partners-api/create-session): `POST` - Initialize a direct API session without the Connect Widget
193
+ - [Login](https://docs.mono.co/api/bank-data/partners-api/login): `POST` - Authenticate user with bank credentials
194
+ - [Commit Session](https://docs.mono.co/api/bank-data/partners-api/commit-session): `POST` - Finalize session and retrieve Account ID
195
+ - [Reauth Session](https://docs.mono.co/api/bank-data/partners-api/reauth-session): `POST` - Start re-authentication flow for expired accounts
196
+ - [Reauth Login](https://docs.mono.co/api/bank-data/partners-api/reauth-login): `POST` - Complete re-authentication with credentials
197
+ - [Retrieve Sandbox Credentials](https://docs.mono.co/api/bank-data/partners-api/sandbox-credentials): `GET` - Get test credentials for sandbox testing
198
+
199
+ ### Account
200
+
201
+ - [Account Details](https://docs.mono.co/api/bank-data/accounts/details): `GET /v2/accounts/{id}` - Retrieve account type, balance, currency, institution, and holder name
202
+ - [Account Identity](https://docs.mono.co/api/bank-data/accounts/identity): `GET /v2/accounts/{id}/identity` - Fetch verified identity information (name, BVN, email, phone, address)
203
+ - [Account Balance](https://docs.mono.co/api/bank-data/accounts/account-balance): `GET` - Get current account balance
204
+ - [Income](https://docs.mono.co/api/bank-data/accounts/income): `GET /v2/accounts/{id}/income` - Retrieve income analysis including monthly average and salary estimates
205
+ - [Income Records](https://docs.mono.co/api/bank-data/accounts/income-records): `GET` - Fetch detailed income transaction records
206
+ - [Get Accounts](https://docs.mono.co/api/bank-data/accounts/get-accounts): `GET` - List all accounts for a linked connection
207
+ - [Creditworthiness](https://docs.mono.co/api/bank-data/accounts/credit-worthiness): `POST` - Generate credit score and affordability assessment
208
+ - [Unlink Account](https://docs.mono.co/api/bank-data/accounts/unlink): `POST /v2/accounts/{id}/unlink` - Disconnect a linked bank account
209
+
210
+ ### Statements
211
+
212
+ - [Get Statements](https://docs.mono.co/api/bank-data/bank-statement): `GET /v2/accounts/{id}/statement` - Retrieve bank statements with optional date range and format (PDF/JSON)
213
+ - [Poll PDF Status](https://docs.mono.co/api/bank-data/poll-pdf-status): `GET` - Check generation status of PDF statement requests
214
+
215
+ ### Transactions
216
+
217
+ - [Get Transactions](https://docs.mono.co/api/bank-data/transactions): `GET /v2/accounts/{id}/transactions` - Fetch paginated transaction history with filters for date, type (credit/debit), and narration
218
+
219
+ ### Investment
220
+
221
+ - [Assets](https://docs.mono.co/api/bank-data/investment/assets): `GET /v2/accounts/{id}/assets` - Retrieve investment portfolio holdings
222
+ - [Earnings](https://docs.mono.co/api/bank-data/investment/earnings): `GET /v2/accounts/{id}/earnings` - Fetch earnings and returns on investment assets
223
+
224
+ ### Data Enrichment
225
+
226
+ - [Transaction Categorisation](https://docs.mono.co/api/bank-data/enrichment/transaction-categorisation): `POST` - Categorize transactions into spending categories using AI
227
+ - [Transaction Categorisation (CSV)](https://docs.mono.co/api/bank-data/enrichment/transaction-categorisation-upload): `POST` - Upload CSV file for bulk transaction categorization
228
+ - [Transaction Metadata](https://docs.mono.co/api/bank-data/enrichment/transaction-metadata): `POST` - Extract merchant names, logos, and context from transactions
229
+ - [Transaction Metadata (CSV)](https://docs.mono.co/api/bank-data/enrichment/transaction-metadata-upload): `POST` - Upload CSV for bulk metadata extraction
230
+ - [Statement Insights](https://docs.mono.co/api/bank-data/enrichment/statement-insights): `GET` - Generate financial health insights from bank statements
231
+ - [Enrichment Records](https://docs.mono.co/api/bank-data/enrichment/enrichment-records): `GET` - Retrieve previously enriched transaction records
232
+ - [Job Tracker](https://docs.mono.co/api/bank-data/enrichment/job-tracker): `GET` - Check status of enrichment processing jobs
233
+
234
+ ### Inflow/Outflow
235
+
236
+ - [Credits](https://docs.mono.co/api/bank-data/credits): `GET` - Retrieve all credit (inflow) transactions
237
+ - [Debits](https://docs.mono.co/api/bank-data/debits): `GET` - Retrieve all debit (outflow) transactions
238
+
239
+ ## Telco Data API
240
+
241
+ - [Integration Guide](https://docs.mono.co/api/telco-data/integration-guide): Complete guide for accessing mobile network operator account data
242
+
243
+ ### Authenticate
244
+
245
+ - [Login](https://docs.mono.co/api/telco-data/login): `POST /v2/telecom/auth` - Initiate authentication with phone number and provider (airtel, mtn)
246
+ - [OTP Verification](https://docs.mono.co/api/telco-data/otp-verification): `POST /v2/telecom/verify` - Verify OTP sent to user's phone
247
+ - [Token Exchange](https://docs.mono.co/api/telco-data/token-exchange): `POST /v2/accounts/auth` - Exchange code for permanent telco Account ID
248
+
249
+ ### Account
250
+
251
+ - [Telco Details](https://docs.mono.co/api/telco-data/details): `GET /v2/accounts/{id}` - Retrieve telco account information
252
+ - [Telco Balances](https://docs.mono.co/api/telco-data/balances): `GET /v2/accounts/{id}/balances` - Fetch airtime, data, and bonus balances
253
+ - [Telco Transactions](https://docs.mono.co/api/telco-data/transactions): `GET /v2/accounts/{id}/transactions` - Retrieve recharge and usage history
254
+ - [Telco Identity](https://docs.mono.co/api/telco-data/identity): `GET /v2/accounts/{id}/identity` - Fetch subscriber identity information
255
+
256
+ ## One-time Payments API (DirectPay)
257
+
258
+ - [Initiate Payment](https://docs.mono.co/api/directpay/initiate): `POST /v2/payments/initiate` - Create a one-time payment with amount, reference, and customer details
259
+ - [Redirect URLs](https://docs.mono.co/api/directpay/redirect-urls): Configure success and failure redirect URLs for payment flows
260
+ - [Verify Payment Status](https://docs.mono.co/api/directpay/verify): `GET /v2/payments/verify/{reference}` - Confirm payment status with the payment reference before giving value
261
+ - [Fetch All Payments](https://docs.mono.co/api/directpay/fetch-payments): `GET` - Retrieve paginated list of all payment transactions
262
+
263
+ ## Recurring Payments API (Direct Debit)
264
+
265
+ ### Mandates
266
+
267
+ - [Get Banks](https://docs.mono.co/api/direct-debit/mandate/get-banks): `GET` - List banks supporting Direct Debit mandates
268
+ - [Initiate Mandate Authorisation](https://docs.mono.co/api/direct-debit/mandate/initiate-mandate-authorisation): `POST /v2/payments/initiate` - Generate authorization link for recurring mandate setup (variable or fixed)
269
+ - [Create a Mandate](https://docs.mono.co/api/direct-debit/mandate/create-a-mandate): `POST` - Programmatically create a mandate without hosted link
270
+ - [Retrieve a Mandate](https://docs.mono.co/api/direct-debit/mandate/retrieve-a-mandate): `GET` - Fetch mandate details by ID
271
+ - [Get All Mandates](https://docs.mono.co/api/direct-debit/mandate/get-all-mandates): `GET` - List all mandates for your application
272
+ - [Cancel Mandate](https://docs.mono.co/api/direct-debit/mandate/cancel-mandate): `PATCH` - Permanently cancel an active mandate
273
+ - [Pause Mandate](https://docs.mono.co/api/direct-debit/mandate/pause-mandate): `PATCH` - Temporarily suspend mandate debits
274
+ - [Reinstate Mandate](https://docs.mono.co/api/direct-debit/mandate/reinstate-mandate): `PATCH` - Resume a paused mandate
275
+
276
+ ### Account
277
+
278
+ - [Balance Inquiry](https://docs.mono.co/api/direct-debit/account/balance-inquiry): `GET` - Check available balance on mandated account
279
+ - [Debit Account](https://docs.mono.co/api/direct-debit/account/debit-account): `POST` - Execute a debit against an approved mandate
280
+ - [Retrieve a Debit](https://docs.mono.co/api/direct-debit/account/retrieve-a-debit): `GET` - Fetch details of a specific debit transaction
281
+ - [Retrieve All Debits](https://docs.mono.co/api/direct-debit/account/retrieve-all-debits): `GET` - List all debits for a mandate
282
+
283
+ ## Money Operations API
284
+
285
+ - [Payout](https://docs.mono.co/api/money-operations/payout): `GET /v2/payments/payouts` - Retrieve payout details by status
286
+ - [Payout Transactions](https://docs.mono.co/api/money-operations/payout-transactions): `GET` - List all payout transactions
287
+ - [Refund Payment](https://docs.mono.co/api/money-operations/refund): `POST` - Initiate refund for a completed payment
288
+ - [Create Sub-Account](https://docs.mono.co/api/money-operations/create-a-subaccount): `POST` - Create sub-accounts for payment splitting
289
+ - [Fetch All Sub-Accounts](https://docs.mono.co/api/money-operations/fetch-subaccounts): `GET` - List all sub-accounts
290
+
291
+ ## WhatsApp Payment API (Owo)
292
+
293
+ ### User
294
+
295
+ - [Check User Status](https://docs.mono.co/api/whatsapp-payment/user): `GET /owo/v1/users/status` - Check if phone number has active Owo account
296
+
297
+ ### Beneficiary
298
+
299
+ - [Link Beneficiary](https://docs.mono.co/api/whatsapp-payment/beneficiary/link): `POST` - Link a customer as beneficiary for fund requests
300
+ - [Unlink Beneficiary](https://docs.mono.co/api/whatsapp-payment/beneficiary/unlink): `POST` - Remove beneficiary association
301
+ - [Get Beneficiary](https://docs.mono.co/api/whatsapp-payment/beneficiary/get-beneficiary): `GET` - Retrieve beneficiary details
302
+ - [Get All Beneficiaries](https://docs.mono.co/api/whatsapp-payment/beneficiary/get-all-beneficiaries): `GET` - List all linked beneficiaries
303
+
304
+ ### Fund Request
305
+
306
+ - [One-time Fund Request](https://docs.mono.co/api/whatsapp-payment/fund-request/one-time): `POST` - Request one-time payment via WhatsApp
307
+ - [Recurring Fund Request](https://docs.mono.co/api/whatsapp-payment/fund-request/recurring): `POST` - Set up recurring payment requests
308
+ - [Get All Fund Requests](https://docs.mono.co/api/whatsapp-payment/fund-request/get-all): `GET` - List all fund requests
309
+ - [Get Fund Request by ID](https://docs.mono.co/api/whatsapp-payment/fund-request/get-request): `GET` - Retrieve specific fund request details
310
+
311
+ ### Payments
312
+
313
+ - [Get All Payment Details](https://docs.mono.co/api/whatsapp-payment/fund-request-payments/get-all-payments): `GET` - List all WhatsApp payment transactions
314
+ - [Get Single Payment Details](https://docs.mono.co/api/whatsapp-payment/fund-request-payments/get-payment): `GET` - Retrieve specific payment details
315
+
316
+ ## Disburse API
317
+
318
+ - [Create Source Account](https://docs.mono.co/api/disburse/create-source-account): `POST /v3/payments/disburse/source-accounts` - Register bank account for disbursements
319
+ - [Update Source Account](https://docs.mono.co/api/disburse/update-source-account): `PUT` - Modify source account details
320
+ - [Fetch Source Accounts](https://docs.mono.co/api/disburse/fetch-source-account): `GET` - List all registered source accounts
321
+ - [Create Instant Disbursement](https://docs.mono.co/api/disburse/create-instant-disbursement): `POST` - Execute immediate batch payout
322
+ - [Create Scheduled Disbursement](https://docs.mono.co/api/disburse/create-scheduled-disbursement): `POST` - Schedule batch payout for future execution
323
+ - [Transition Disbursement](https://docs.mono.co/api/disburse/transition-disbursement): `POST` - Change disbursement batch status
324
+ - [Add Distributions to Batch](https://docs.mono.co/api/disburse/add-distributions-to-batch): `POST` - Add recipients to an existing batch
325
+ - [Update Distribution in Batch](https://docs.mono.co/api/disburse/update-distribution-in-batch): `PATCH` - Modify recipient details in a batch
326
+ - [Fetch All Disbursements](https://docs.mono.co/api/disburse/fetch-all-disbursements): `GET` - List all disbursement batches
327
+ - [Fetch a Disbursement](https://docs.mono.co/api/disburse/fetch-a-disbursement): `GET` - Retrieve specific batch details
328
+ - [Fetch All Distributions in Batch](https://docs.mono.co/api/disburse/fetch-all-distributions-in-batch): `GET` - List all recipients in a batch
329
+ - [Fetch a Single Distribution](https://docs.mono.co/api/disburse/fetch-a-single-distribution): `GET` - Retrieve specific recipient details
330
+
331
+ ## Lookup API
332
+
333
+ ### BVN (Bank Verification Number)
334
+
335
+ - [Initiate BVN Lookup](https://docs.mono.co/api/bvn/initiate): `POST /v2/lookup/bvn/initiate` - Start BVN consent request with OTP verification
336
+ - [Verify BVN OTP](https://docs.mono.co/api/bvn/verify-otp): `POST` - Confirm OTP for BVN access
337
+ - [Fetch BVN Details](https://docs.mono.co/api/bvn/fetch-bvn): `POST` - Retrieve BVN identity information after consent
338
+
339
+ ### CAC (Corporate Affairs Commission)
340
+
341
+ - [Lookup a Business](https://docs.mono.co/api/cac/business): `GET /v3/lookup/cac` - Search and verify Nigerian business registration
342
+ - [Shareholder Details](https://docs.mono.co/api/cac/shareholder): `GET` - Retrieve company shareholder information
343
+ - [Persons with Significant Control](https://docs.mono.co/api/cac/psc): `GET` - List individuals with significant control
344
+ - [Secretary](https://docs.mono.co/api/cac/secretary): `GET` - Retrieve company secretary details
345
+ - [Directors](https://docs.mono.co/api/cac/directors): `GET` - List company directors
346
+ - [Company Profile](https://docs.mono.co/api/cac/profile): `GET` - Fetch comprehensive company profile
347
+
348
+ ### Other Lookups
349
+
350
+ - [Bank Listing (NIP)](https://docs.mono.co/api/lookup/bank-listing-nip): `GET` - List all banks on Nigeria Inter-Bank Payment system
351
+ - [Address Verification](https://docs.mono.co/api/lookup/address): `POST` - Verify physical address validity
352
+ - [Int'l Passport](https://docs.mono.co/api/lookup/intl-passport): `POST` - Verify international passport details
353
+ - [TIN Lookup](https://docs.mono.co/api/lookup/tin): `POST` - Verify Tax Identification Number
354
+ - [NIN Lookup](https://docs.mono.co/api/lookup/nin): `POST` - Verify National Identification Number
355
+ - [Poll NIN Job](https://docs.mono.co/api/lookup/nin/job): `GET` - Check status of async NIN lookup
356
+ - [Driver's License](https://docs.mono.co/api/lookup/drivers-license): `POST` - Verify driver's license information
357
+ - [Account Number](https://docs.mono.co/api/lookup/account-number): `POST` - Validate and verify bank account numbers
358
+ - [Credit History](https://docs.mono.co/api/lookup/credit-history): `POST` - Retrieve credit bureau reports (CRC, XDS)
359
+ - [Mashup Lookup](https://docs.mono.co/api/lookup/mashup): `POST` - Combined NIN, BVN, and DOB verification
360
+
361
+ ## Prove API (eKYC)
362
+
363
+ - [Initiate Prove](https://docs.mono.co/api/prove/initiate): `POST /v1/prove/initiate` - Start tiered KYC session (tier_1: BVN+NIN, tier_2: +Gov ID, tier_3: +Address)
364
+ - [Fetch Customer Details](https://docs.mono.co/api/prove/fetch-customer-details): `GET` - Retrieve verified customer information
365
+ - [Fetch All Customer Details](https://docs.mono.co/api/prove/fetch-all-customer-details): `GET` - List all Prove verifications
366
+ - [Blacklist Customer](https://docs.mono.co/api/prove/blacklist-customer): `POST` - Add customer to blacklist
367
+ - [Whitelist Customer](https://docs.mono.co/api/prove/whitelist-customer): `POST` - Remove customer from blacklist
368
+ - [Revoke Data Access](https://docs.mono.co/api/prove/revoke-data-access): `DELETE` - Remove customer data and access
369
+
370
+ ## Miscellaneous
371
+
372
+ - [Bank Coverage](https://docs.mono.co/api/miscellaneous/bank-coverage): `GET` - List all supported financial institutions with feature availability