Jump to Content
Home
API Reference
Guides
API Reference
Home
API Reference
Log In
Dashboard
Blog
Talk to Us
API Reference
Log In
Dashboard
Blog
Talk to Us
Guides
API Reference
Getting started with the API
All
Pages
Start typing to search…
JUMP TO
Anchor
Overview
Authentication
Sandbox and Testing
JSON:API
Overview
Relationship
Fetching Related Resources
Organisation Accounts
Pagination
Required Fields
Data types
Errors
Backwards compatibility
Idempotency
Metadata
Webhooks and Events
Getting started with the API
Subledgers (Sub Accounts)
ONBOARDING
Customers
Create Customer
post
Update Customer
put
Fetch customer
get
List all Customer
get
Delete Customer
del
Search customers
get
Officers Requirement
get
Customer Identification (KYC)
Kyc Validation for Business Customer
post
Kyc Validation for Individual Customer
post
Documents
Download Document
get
Fetch Document
get
Upload Document
post
Fetch All Documents
get
Next Of Kin
Create Next Of Kin
post
Update Next Of Kin
patch
Fetch Next Of Kin
get
List Next Of Kin
get
Delete Next Of Kin
del
COLLECTIONS
Payment
Fetch Payment
get
List Payments
get
Verify Incoming Payment
get
Banking
Deposit Accounts
Create Deposit Account
post
Update Deposit Account
patch
Fetch Balance
get
Fetch Deposit Account
get
List Deposit Accounts
get
Freeze Deposit Account
post
Unfreeze Deposit Account
post
List Root Accounts
get
Fees
Create Fee
post
Reverse Fee
post
List Fees
get
Fetch Fee
get
Statements
Create Statement
post
Fetch Statement
get
List Statements
get
Download a statement
get
Transfers
Transfers
Initiate Transfer
post
Verify transfer
get
Fetch Transfer
get
List Transfers
get
CounterParty
Create Counterparty
post
Update Counterparty
patch
Fetch Counterparty
get
List Counterparties
get
Delete Counterparty
del
Banks
Verify Account Number
get
List Banks
get
Bills Payment
Billers
List Billers
get
List Biller Products
get
Verify Customer Details
get
Bills Payment
Create Bill Payment
post
Fetch Bill Payment
get
List Bills Payment
get
Bulk Operations
Bulk Transfers
Create Bulk Transfer
post
Fetch Bulk Transfer
get
Bulk Counterparties
Bulk Create Counterparties
post
Bulk Verify Account Numbers
post
Sub-Ledger Account
SubAccount
Create a SubAccount
post
Fetch Sub Account Balance
get
Fetch by SubAccount Id
get
Update Sub Account
patch
List SubAccount
get
TRANSACTIONS
Transactions
Fetch Transaction
get
List Transactions
get
List SubAccount Transactions
get
SAVINGS (Coming Soon)
Savings
List Savings
get
Create a Savings
post
Rollover a Savings
post
List Withdrawal
get
Create a Withdrawal
post
Fetch a Savings
get
Savings withdrawal data
get
Fetch a Withdrawal
get
Withdrawal
Deposit
List Deposit
get
Create a Deposit
post
Fetch a Deposit
get
RECONCILIATION
Reports
List Reports
get
Create a Report
post
Fetch a Report
get
Download a report document
get
WEBHOOK
Webhooks
Create a Webhook
post
Fetch a Webhook
get
Send sample event to a webhook
post
List Webhooks
get
Delete Webhook
del
Update a Webhook
patch
Events
List Events
get
Fetch Event
get
Event Types
get
Powered by
Getting started with the API
Ask AI
