Atlas API Overview

Quick reference for all Atlas API endpoints organized by category

Banking

List Banks by Currency: Return the supported banking institutions for the requested settlement currency.
Run Account Name Enquiry: Validate a recipient account and return the account name for supported bank transfer and mobile money channels.
Run Bulk Account Name Enquiry: Validate multiple recipient bank accounts in a single request and return the resolved account names.

Initialize Checkout: Create a checkout link and collect payments.
Verify Checkout by Reference: Verify the status of a checkout using the Atlas-generated reference.
Verify Checkout by Source Reference: Verify the status of a checkout using your own source reference.
Get Checkout Transactions by Source Reference: Fetch checkout transactions using a source reference.
Get Checkout Transactions by Reference: Fetch checkout transactions using the Atlas-generated reference.

Create new Customer: Create a new customer and assign a virtual account to them.
Find an Existing Customer: Get the details of an existing customer on your Atlas account using their reference number.
Update Customer Data: Update outdated or inaccurate data for an existing customer.
List all Customers: Get a list of all the customers on your Atlas account.
Blacklist a Customer: Blacklist a customer to prevent them from using their virtual account.
Activate a Blacklisted Customer: Reactivate a customer's account that was previously blacklisted.

List E-Invoices: Retrieve a paginated list of e-invoices for your business.
Create E-Invoice: Create a new e-invoice with supplier data, optional payee and tax representative details, and line items.
Get E-Invoice Details: Retrieve the full details of a specific e-invoice by its invoice reference number.
Get E-Invoice by Source Reference: Retrieve the full details of a specific e-invoice by its source system reference.
Update E-Invoice: Update an existing draft e-invoice locally by invoice reference number.
Validate E-Invoice: Validate a previously created e-invoice against the NRS system.
Sign E-Invoice: Digitally sign a validated e-invoice via the NRS system.
Confirm E-Invoice: Confirm an e-invoice with the NRS system and retrieve its confirmation status.
Update Invoice Payment Status: Update the payment status of an e-invoice.
List E-Invoicing Customers: Retrieve paginated e-invoicing customers for your business.
Create E-Invoicing Customer: Create a new e-invoicing customer under your business.
Get E-Invoicing Customer: Retrieve an e-invoicing customer by reference.
Update E-Invoicing Customer: Update an existing e-invoicing customer by reference.
Onboard Taxpayer: Onboard a taxpayer for e-invoicing by providing their NRS credentials.
Get NRS Resources: Retrieve NRS reference data resources by type.
Customize Invoice Logo and Colors: Update the business brand settings for e-invoicing.

Create Payment Link: Create a new payment link to collect payments from customers.
List Payment Links: Retrieve all payment links associated with your business.
Get Payment Link by Reference: Fetch a single payment link using the Atlas-generated reference.
Get Payment Link by Source Reference: Fetch a single payment link using your own source reference.
Get Payment Link Transactions by Reference: List all transactions collected through a payment link using its reference.
Get Payment Link Transactions by Source Reference: List all transactions collected through a payment link using its source reference.
Toggle Payment Link Status: Activate or deactivate a payment link.

Initiate Bank Payout: Initiate a single bank-transfer payout from your Atlas wallet.
Initiate Bulk Bank Payout: Queue a bulk bank-transfer payout batch for asynchronous processing.
List All Payouts: List payout records created by your business across all supported payout types.
Get Payout by Reference: Retrieve a single payout record using the payout transaction reference.
Get Payout by Source Reference: Retrieve the payout transaction associated with a merchant-provided payout source reference.
Get Bulk Payout Status: Retrieve the current status of a bulk payout batch using the Atlas batch reference.
Get Bulk Payout Status by Source Reference: Retrieve the current status of a bulk payout batch using the merchant source reference.
Initiate International Bank Transfer: Initiate a cross-border bank transfer payout from your Atlas account.

Initiate FX Swap: Create an FX swap request from your NGN wallet into a target currency wallet.
Get FX Swap: Retrieve a single FX swap transaction by ID.
List FX Swaps: List all FX swap records for your business.
Get FX Rates History: Retrieve historical exchange rates for a currency pair.
Get FX Wallet Balances: Fetch available and ledger balances for business wallets used in FX operations.