87 endpoints, 14 ledgers.
Every method below is available on both Nomba (sync) and
AsyncNomba (async, same name, awaited) under the resource
group shown in each heading, e.g. nomba.virtual_accounts.fetch_a_virtual_account(...).
Field names and required/optional arguments are generated from Nomba's
OpenAPI spec — check each method's docstring in your editor for the
full field list.
Accounts nomba.accounts
Sub-accounts, balances, suspension, and account-level lookups. 11 endpoints.
GET
/v1/accounts
.list_all_accounts()
List all sub accounts
POST
/v1/accounts
.create_a_sub_account()
Create a sub account
GET
/v1/accounts/sub-account-details
.fetch_account_details()
Fetch details of a sub account
GET
/v1/accounts/parent
.fetch_parent_account_details()
Fetch parent account details
GET
/v1/accounts/{subAccountId}/balance
.fetch_account_balance()
Fetch sub account balance
GET
/v1/accounts/balance
.fetch_parent_account_balance()
Fetch parent account balance
PUT
/v1/accounts/suspend/{subAccountId}
.suspend_an_account()
Suspend a sub account
PUT
/v1/accounts/reactivate/{subAccountId}
.reactivate_a_sub_account()
Reactivate a sub account
GET
/v1/accounts/{subAccountId}/terminals
.fetch_terminals_assigned_to_an_account()
Fetch terminals assigned to a sub account
GET
/v1/accounts/terminals
.fetch_terminals_assigned_to_the_parent_account()
Fetch terminals assigned to the parent account
PUT
/v1/accounts/{subAccountId}/access
.update_access_to_account()
Update access to account
Virtual Accounts nomba.virtual_accounts
Create, fetch, update, and expire dedicated virtual accounts. 5 endpoints.
POST
/v1/accounts/virtual
.create_virtual_account()
Create virtual account
POST
/v1/accounts/virtual/list
.filter_virtual_accounts()
Filter virtual accounts
PUT
/v1/accounts/virtual/{accountRef}
.update_a_virtual_account()
Update a virtual account
GET
/v1/accounts/virtual/{accountRef}
.fetch_a_virtual_account()
Fetch a virtual account
DELETE
/v1/accounts/virtual/{accountRef}
.expire_a_virtual_account()
Expire a virtual account
Online Checkout nomba.checkout
Hosted checkout orders, tokenized cards, saved-card charges. 8 endpoints.
POST
/v1/checkout/order
.create_an_online_checkout_order()
Create an online checkout order
POST
/v1/checkout/tokenized-card-payment
.charge_customer_with_tokenized_card_data()
Charge a customer using tokenized card data
GET
/v1/checkout/tokenized-card-data
.list_all_tokenized_cards_for_merchant()
List tokenized cards
POST
/v1/checkout/tokenized-card-data
.update_tokenized_card_data()
Update tokenized card data
DELETE
/v1/checkout/tokenized-card-data
.delete_tokenized_card_data()
Update tokenized card data
GET
/v1/checkout/transaction
.fetch_a_checkout_transaction()
Fetch checkout transaction
POST
/v1/checkout/refund
.refund_checkout_transaction()
Refund a checkout transaction
POST
/v1/checkout/order/cancel
.cancel_checkout_order()
Cancel a checkout order
Charge nomba.charge
The card-payment sequence: card details, OTP, 3DS, confirmation. 11 endpoints.
GET
/v1/checkout/order/{orderReference}
.fetch_checkout_order_details()
Get Order details based on the generated Order reference
POST
/v1/checkout/checkout-card-detail
.submit_customer_card_details()
Submit customer card details
POST
/v1/checkout/checkout-card-otp
.submit_customer_payment_otp()
Submit customer card OTP
POST
/v1/checkout/resend-otp
.resend_customer_payment_otp()
Resend OTP to customer's phone
POST
/v1/checkout/confirm-transaction-receipt
.fetch_checkout_transaction_details()
Fetch checkout transaction details
GET
/v1/checkout/get-checkout-kta/{orderReference}
.fetch_checkout_flash_account_number()
Fetch checkout Flash account number for transfer payment
POST
/v1/checkout/user-card/auth
.request_user_otp_to_authenticate_user()
Request OTP before saving a user's card
POST
/v1/checkout/user-card/saved-card/auth
.request_user_otp_to_authenticate_user_who_already_has_saved_cards()
Request OTP to validate a user before fetching saved cards
POST
/v1/checkout/user-card
.submit_user_otp()
Submit user OTP
GET
/v1/checkout/user-card/{orderReference}
.fetch_user_saved_cards()
Get user saved cards
POST
/v1/checkout/transaction/cancel
.cancel_checkout_transaction()
Cancel Checkout transaction
Transfers nomba.transfers
Bank account lookups and transfers from the parent or sub-accounts. 6 endpoints.
GET
/v1/transfers/banks
.fetch_bank_codes_and_names()
Fetch bank codes and names
POST
/v1/transfers/bank/lookup
.perform_bank_account_lookup()
Perform bank account lookup
POST
/v1/transfers/bank
.perform_bank_account_transfer_the_parent_account()
Perform bank account transfer from the parent account
POST
/v1/transfers/bank/{subAccountId}
.perform_bank_account_transfer_from_account()
Perform bank account transfer from a sub account
POST
/v1/transfers/wallet
.perform_wallet_transfer_from_the_parent_account()
Perform wallet transfer from the parent account
POST
/v1/transfers/wallet/{subAccountId}
.perform_wallet_transfer_from_a_sub_account()
Perform wallet transfer from a sub account
Terminals nomba.terminals
Assign and unassign POS terminals to accounts. 4 endpoints.
POST
/v1/terminals/assign/{subAccountId}
.assign_a_terminal_to_an_account()
Assign a terminal to a sub account
POST
/v1/terminals/assign
.assign_a_terminal_to_the_parent_account()
Assign a terminal to the parent account
POST
/v1/terminals/unassign/{subAccountId}
.un_assign_terminal_from_an_account()
Un-assign terminal from a sub account
POST
/v1/terminals/unassign
.un_assign_a_terminal_from_the_parent_account()
Un-assign a terminal from the parent account
Transactions nomba.transactions
Fetch and filter transaction history, paginated. 9 endpoints.
GET
/v1/transactions/bank/{subAccountId}
.fetch_credit_debit_transactions_on_a_sub_account()
Fetch credit/debit transactions on a sub account
GET
/v1/transactions/bank
.fetch_credit_debit_transactions_on_the_parent_account()
Fetch credit/debit transactions on the parent account
GET
/v1/transactions/accounts/{subAccountId}
.fetch_transactions_on_a_sub_account()
Fetch transactions on a sub account
POST
/v1/transactions/accounts/{subAccountId}
.filter_account_transactions()
Filter account transactions
GET
/v1/transactions/accounts
.fetch_transactions_on_the_parent_account()
Fetch transactions on the parent account
POST
/v1/transactions/accounts
.filter_parent_account_transactions()
Filter parent account transactions
GET
/v1/transactions/accounts/{subAccountId}/single
.fetch_a_single_transaction_on_a_sub_account()
Fetch a single transaction on a sub account
GET
/v1/transactions/accounts/single
.fetch_a_single_transaction_on_the_parent_account()
Fetch a single transaction on the parent account
GET
/v1/transactions/requery/{sessionId}
.confirm_a_transaction_s_status_by_session_id()
Fetch a single transaction on the parent account
Airtime and Data Vending nomba.airtime_data
Buy airtime and data bundles across telco networks. 5 endpoints.
GET
/v1/bill/data-plan/{telco}
.fetch_data_plans_available_on_a_telco_network_provider()
Fetch data plans available on a telco (network provider)
POST
/v1/bill/topup
.make_airtime_purchases_via_parent_account()
Make airtime purchases via parent account
POST
/v1/bill/topup/{subAccountId}
.make_airtime_purchases_via_specific_or_sub_account()
Make airtime purchases via a sub account
POST
/v1/bill/data
.vend_data_bundles_via_parent_account()
Vend data bundles via parent account
POST
/v1/bill/data/{subAccountId}
.vend_data_bundles_via_specific_or_sub_account()
Vend data bundles via a sub account
CableTV Subscription nomba.cabletv
Cable TV provider lookups and subscription payments. 3 endpoints.
GET
/v1/bill/cabletv/lookup
.cabletv_lookup()
Fetch customer information from a cable tv provider
POST
/v1/bill/cabletv
.cable_tv_subscription_via_parent_account()
CableTv subscription via parent account
POST
/v1/bill/cabletv/{subAccountId}
.cable_tv_subscription_via_a_sub_account()
CableTv subscription via a sub account
Electricity Vending nomba.electricity
Electricity provider lookups and bill payments. 4 endpoints.
GET
/v1/bill/electricity/discos
.fetch_electricity_providers()
Fetch discos/electricity providers
GET
/v1/bill/electricity/lookup
.electricity_customer_lookup()
Fetch customer information from an electricity provider
POST
/v1/bill/electricity
.vend_electricity_via_parent_account()
Vend electricity via parent account
POST
/v1/bill/electricity/{subAccountId}
.vend_electricity_via_a_sub_account()
Vend electricity via a specific account
Betting nomba.betting
Betting provider lookups and voucher purchases. 4 endpoints.
GET
/v1/bill/betting/providers
.fetch_betting_providers()
Fetch betting providers
GET
/v1/bill/betting/lookup
.betting_customer_lookup()
Fetch customer information from a betting provider
POST
/v1/bill/betting
.vend_betting_via_parent_account()
Vend betting via parent account
POST
/v1/bill/betting/{subAccountId}
.vend_betting_via_a_sub_account()
Vend betting via a specific account
Direct Debits nomba.direct_debits
Direct debit mandate management and collections. 6 endpoints.
POST
/v1/direct-debits
.create_a_direct_debit_mandate()
Create a Direct Debit Mandate
GET
/v1/direct-debits/mandates
.get_mandates_by_filters()
Get mandates by filters
GET
/v1/direct-debits/{mandateId}
.get_mandate_by_id()
Get Mandate by ID
GET
/v1/direct-debits/status
.get_mandate_status()
Get Mandate Status
PUT
/v1/direct-debits/update-status
.update_mandate_status()
Update mandate status
POST
/v1/direct-debits/debit-mandate
.debit_a_mandate()
Debit a mandate
Global Collections nomba.global_collections
Mobile money collections and DRC inflow providers. 4 endpoints.
POST
/v1/global-collection/inflow/initiate
.initiate_mobile_money_inflow()
Initiate mobile money collection
GET
/v1/global-collection/transactions/{transactionId}
.fetch_collection_transaction()
Retrieve collection transaction status
GET
/v1/global-collection/drc/inflow/providers
.fetch_drc_inflow_providers()
Fetch DRC inflow providers
GET
/v1/sandbox/global-collection/drc/inflow/providers
.fetch_drc_inflow_providers_sandbox()
Fetch DRC inflow providers (sandbox)
Global Payout nomba.global_payout
Cross-border transfers, currency exchange, and payment methods. 7 endpoints.
POST
/v1/global-payout/money/convert
.convert_money()
Calculate currency conversion and lock exchange rate
GET
/v1/global-payout/exchange-rates
.fetch_exchange_rates()
Retrieve exchange rates for a currency pair
POST
/v1/global-payout/exchange/authorize
.authorize_exchange()
Authorize currency exchange
GET
/v1/global-payout/payment-methods
.fetch_payment_methods()
Fetch supported payment methods
GET
/v1/global-payout/bank/providers
.list_institution_providers()
List institution providers
POST
/v1/global-payout/transfer/authorize
.authorize_transfer()
Initiate and authorize cross-border transfer
GET
/v1/global-payout/transactions/{transactionId}
.fetch_global_payout_transaction()
Track global payout transaction status
nomba-python · unofficial Python SDK
Getting started · Advanced features