Atlas API Overview

Return the supported banking institutions for the requested settlement currency.

Validate a recipient account and return the account name for supported bank transfer and mobile money channels.

Validate multiple recipient bank accounts in a single request and return the resolved account names.

Create a checkout link and collect payments.

Verify the status of a checkout using the Atlas-generated reference.

Verify the status of a checkout using your own source reference.

Fetch checkout transactions using a source reference.

Fetch checkout transactions using the Atlas-generated reference.

Create a new customer and assign a virtual account to them.

Get the details of an existing customer on your Atlas account using their reference number.

Update outdated or inaccurate data for an existing customer.

Get a list of all the customers on your Atlas account.

Blacklist a customer to prevent them from using their virtual account.

Reactivate a customer's account that was previously blacklisted.

Retrieve a paginated list of e-invoices for your business.

Create a new e-invoice with supplier data, optional payee and tax representative details, and line items.

Retrieve the full details of a specific e-invoice by its invoice reference number.

Retrieve the full details of a specific e-invoice by its source system reference.

Update an existing draft e-invoice locally by invoice reference number.

Validate a previously created e-invoice against the NRS system.

Digitally sign a validated e-invoice via the NRS system.

Confirm an e-invoice with the NRS system and retrieve its confirmation status.

Update the payment status of an e-invoice.

Retrieve paginated e-invoicing customers for your business.

Create a new e-invoicing customer under your business.

Retrieve an e-invoicing customer by reference.

Update an existing e-invoicing customer by reference.

Onboard a taxpayer for e-invoicing by providing their NRS credentials.

Retrieve NRS reference data resources by type.

Update the business brand settings for e-invoicing.

Create a new payment link to collect payments from customers.

Retrieve all payment links associated with your business.

Fetch a single payment link using the Atlas-generated reference.

Fetch a single payment link using your own source reference.

List all transactions collected through a payment link using its reference.

List all transactions collected through a payment link using its source reference.

Activate or deactivate a payment link.

Initiate a single bank-transfer payout from your Atlas wallet.

Queue a bulk bank-transfer payout batch for asynchronous processing.

List payout records created by your business across all supported payout types.

Retrieve a single payout record using the payout transaction reference.

Retrieve the payout transaction associated with a merchant-provided payout source reference.

Retrieve the current status of a bulk payout batch using the Atlas batch reference.

Retrieve the current status of a bulk payout batch using the merchant source reference.

Initiate a cross-border bank transfer payout from your Atlas account.

Fetch a transaction using a valid reference.

Get all transactions from a business.

Retrieve the current exchange rate for a currency pair.

Create an FX swap request from your NGN wallet into a target currency wallet.

Retrieve a single FX swap transaction by ID.

List all FX swap records for your business.

Retrieve historical exchange rates for a currency pair.

Fetch available and ledger balances for business wallets used in FX operations.

Fetch the wallet balance for your business.

Fund your Atlas wallet in test mode.