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.

Provision a virtual account for an existing customer that does not already have one.

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.

List virtual accounts belonging to your business, with filtering, search, sorting and pagination.

Create a single_use or multi_use virtual account for your business.

Retrieve a single virtual account using its Atlas-generated reference or your own source reference.

Reactivate an expired single_use virtual account with a new expiry.

Switch an inactive virtual account back on.

Switch off an active virtual account without deleting it.

List the credits received by a virtual account and the total amount received.

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.