# Mesh API > Larkwave's developer API for banks' merchants: virtual accounts, wallets, transfers and webhooks. - [Introduction](https://docs.mesh.larkwave.org/index.md): Collect payments, hold money and move it, on your bank's rails, with one API. - [Quickstart](https://docs.mesh.larkwave.org/quickstart.md): From a test key to a paid virtual account and a webhook. - [How Mesh works](https://docs.mesh.larkwave.org/how-mesh-works.md): Larkwave's design: where Mesh runs, and how your call reaches the bank's ledger. - [Authentication](https://docs.mesh.larkwave.org/essentials/authentication.md): API keys, IP allowlists, permissions and features. - [Test and live](https://docs.mesh.larkwave.org/essentials/test-and-live.md): One URL. The key decides. - [Wallets and virtual accounts](https://docs.mesh.larkwave.org/essentials/products.md): The two products, and which routes each opens. - [Responses and errors](https://docs.mesh.larkwave.org/essentials/responses-and-errors.md): One envelope on every response, and a numeric code to branch on. - [Idempotency](https://docs.mesh.larkwave.org/essentials/idempotency.md): Retry any create without making it twice. - [Pagination](https://docs.mesh.larkwave.org/essentials/pagination.md): Cursor paging on every list. - [Collection accounts](https://docs.mesh.larkwave.org/guides/collection-accounts.md): Permanent account numbers your payers pay into. - [One-off payment accounts](https://docs.mesh.larkwave.org/guides/dynamic-accounts.md): A dynamic account for one invoice or order, for a set amount. - [Held payments](https://docs.mesh.larkwave.org/guides/held-payments.md): When a payment doesn't match what was expected. - [Customers and KYC](https://docs.mesh.larkwave.org/guides/customers-and-kyc.md): Register the people you serve, and verify them to a tier. - [Wallets](https://docs.mesh.larkwave.org/guides/wallets.md): Accounts that hold money, for your business and your customers. - [Transfers and settlements](https://docs.mesh.larkwave.org/guides/transfers-and-settlements.md): Move money between wallets, to other banks, or to your own account. - [Webhooks](https://docs.mesh.larkwave.org/guides/webhooks.md): Events, signatures, retries and replays. - [Simulate payments](https://docs.mesh.larkwave.org/guides/simulate-inflows.md): Pay a sandbox account in test mode. - [API reference](https://docs.mesh.larkwave.org/api-reference/introduction.md): Every Mesh endpoint, with a playground. - [Look up an account name](https://docs.mesh.larkwave.org/api-reference/account-names/look-up-an-account-name.md): The name on an account at any bank, asked of that bank (a name enquiry): account_number and bank_code (from GET /v1/banks). name_enquiry_ref is the enquiry's reference for the transfer that follows. Never cached. - [Get a bank number's name](https://docs.mesh.larkwave.org/api-reference/account-names/get-a-bank-numbers-name.md): The name on one of the bank's own numbers. A number the bank doesn't have is 404. - [Get a balance](https://docs.mesh.larkwave.org/api-reference/accounts/get-a-balance.md): What the account holds now, in kobo. - [List an account's transactions](https://docs.mesh.larkwave.org/api-reference/accounts/list-an-accounts-transactions.md): The account's transactions, newest first, each with its lines and the balance after it. Filter by date; page with the cursor. - [Get an account's transaction](https://docs.mesh.larkwave.org/api-reference/accounts/get-an-accounts-transaction.md): One transaction on the account. - [Get an account's limits](https://docs.mesh.larkwave.org/api-reference/accounts/get-an-accounts-limits.md): What the account may hold and move: its tier's limits, any override the bank set, and the limits in force. - [List banks](https://docs.mesh.larkwave.org/api-reference/banks/list-banks.md): Every bank NIP reaches, sorted by name, or those whose name contains search. The list changes rarely: keep it a day (Cache-Control). code is what POST /v1/transfers/interbank takes as beneficiary_bank_code. - [List the business's transactions](https://docs.mesh.larkwave.org/api-reference/business-transactions/list-the-businesss-transactions.md): The business's transactions, newest first. Filter by date (31 days before `to` when `from` is left out; at most 92 days), one of its accounts or type; page with the cursor. - [Get a business transaction](https://docs.mesh.larkwave.org/api-reference/business-transactions/get-a-business-transaction.md): One transaction any of the business's accounts was a party to, over every date. - [Get a charge statement](https://docs.mesh.larkwave.org/api-reference/charges/get-a-charge-statement.md): The charges in a period (`from` and `to`, at most 92 days), per service and summed: charged, given back, and the difference. - [List collection settlements](https://docs.mesh.larkwave.org/api-reference/collection-settlements/list-collection-settlements.md): Across all the business's collection accounts, newest first. Filter by status and date; page with the cursor. - [List customers](https://docs.mesh.larkwave.org/api-reference/customers/list-customers.md): Lists the business's customers, newest first. Filter by status, name search, phone, email, KYC tier or creation date; page with the cursor. - [Create a customer](https://docs.mesh.larkwave.org/api-reference/customers/create-a-customer.md): Creates a customer. A retry with the same Idempotency-Key and body returns the same customer. - [Get a customer](https://docs.mesh.larkwave.org/api-reference/customers/get-a-customer.md): Gets one customer of the business. - [Update a customer](https://docs.mesh.larkwave.org/api-reference/customers/update-a-customer.md): Changes only the fields sent. Names and date of birth are fixed once the identity is verified. - [List events](https://docs.mesh.larkwave.org/api-reference/events/list-events.md): Events newest first. Filter by event or receipt date; page with the cursor. Kept 30 days. - [Get an event](https://docs.mesh.larkwave.org/api-reference/events/get-an-event.md): One event, by the id its webhook carried (evt_…). - [List number patterns](https://docs.mesh.larkwave.org/api-reference/number-patterns/list-number-patterns.md): Active first, then retired. - [Get a payment](https://docs.mesh.larkwave.org/api-reference/payments/get-a-payment.md): One payment and what it did: credited, held for a decision, accepted or returned. - [Accept a held payment](https://docs.mesh.larkwave.org/api-reference/payments/accept-a-held-payment.md): Takes a held payment (another amount than a dynamic account asked, a late or a second one), less the account's fee. One not held is 409; returning a payment is the bank's. - [List countries](https://docs.mesh.larkwave.org/api-reference/reference-data/list-countries.md): Every country `address.country` accepts. - [List customer types](https://docs.mesh.larkwave.org/api-reference/reference-data/list-customer-types.md): Every `customer_type` a customer can be created with. - [List settlement accounts](https://docs.mesh.larkwave.org/api-reference/settlement-accounts/list-settlement-accounts.md): Active first, then closed; `default` marks where a payment that names no account goes. - [Settle to your bank account](https://docs.mesh.larkwave.org/api-reference/settlements/settle-to-your-bank-account.md): Settles the amount (or, without one, the whole balance less the charge) to the business's settlement account. Accepted at once; follow it with `GET /v1/settlements/{transactionId}`. - [Get a settlement](https://docs.mesh.larkwave.org/api-reference/settlements/get-a-settlement.md): A settlement, as it stands: queued, processing, settled or failed. - [Simulate an inflow](https://docs.mesh.larkwave.org/api-reference/simulations/simulate-an-inflow.md): A payment into one of the business's accounts (wallet, static or dynamic virtual account), sent by the sandbox bank. The outcome arrives as it would in live: va.payment.* or dva.payment.* on GET /v1/events and the webhooks. - [Get key status](https://docs.mesh.larkwave.org/api-reference/status/get-key-status.md): Shows who the presented key belongs to and what it may do; a quick check that a key works. - [Make an internal transfer](https://docs.mesh.larkwave.org/api-reference/transfers/make-an-internal-transfer.md): From one of the business's wallets to another wallet at the bank: its own, its customer's, or another business's. A closed-loop business may also take money from its customers' wallets, but never send their money outside the business. Done once this answers. - [Make an interbank transfer](https://docs.mesh.larkwave.org/api-reference/transfers/make-an-interbank-transfer.md): From the business's own wallet to an account at another bank, over NIP. Accepted at once (the amount, the charge and its VAT leave the wallet now); follow it with `GET /v1/transfers/interbank/{transactionId}`. - [Get an interbank transfer](https://docs.mesh.larkwave.org/api-reference/transfers/get-an-interbank-transfer.md): A transfer to another bank, as it stands: queued, processing, settled, failed or reversed. - [Run a verification](https://docs.mesh.larkwave.org/api-reference/verifications/run-a-verification.md): Runs an identity check through TrustCore: NIN, BVN, TIN, CAC, PEP, bank account, face match, liveness or address. Checks about a person (KYC) need the wallet product and CUSTOMERS; CAC, TIN and a bank account's name are open to any business. 200 with the verdict, or 202 when the result follows later… - [List verifications](https://docs.mesh.larkwave.org/api-reference/verifications/list-verifications.md): Lists the business's verifications, newest first. Filter by check type, result or creation date; page with the cursor. - [Get a verification](https://docs.mesh.larkwave.org/api-reference/verifications/get-a-verification.md): Gets one of the business's verifications by TrustCore's id; how a 202 is followed. Another business's is 404. - [List virtual accounts](https://docs.mesh.larkwave.org/api-reference/virtual-accounts/list-virtual-accounts.md): Lists the business's virtual accounts, static and dynamic, newest first. Filter by type, status, creation date, or a dynamic account's reference; page with the cursor. - [Create a virtual account](https://docs.mesh.larkwave.org/api-reference/virtual-accounts/create-a-virtual-account.md): Gives the business an account number: static, as a collection account of the business, or dynamic for one payment of a set amount (needs DYNAMIC_VIRTUAL_ACCOUNTS). A retry with the same Idempotency-Key and body returns the same account. - [Get a virtual account](https://docs.mesh.larkwave.org/api-reference/virtual-accounts/get-a-virtual-account.md): Gets one of the business's virtual accounts, with name_status: whether payers see its name yet. - [Rename or label an account](https://docs.mesh.larkwave.org/api-reference/virtual-accounts/rename-or-label-an-account.md): Renames one of the business's collection accounts (a person's name, or free text as account_name), labels it, or both: what a payer's bank shows on that number. 200 when named at once; 202 when the provider renames it first (name_status pending, then confirmed or failed). An empty label clears it. - [Cancel a dynamic account](https://docs.mesh.larkwave.org/api-reference/virtual-accounts/cancel-a-dynamic-account.md): Cancels a dynamic account still waiting for its payment. A static account, or a dynamic one already paid, expired or cancelled, is 409. - [List an account's payments](https://docs.mesh.larkwave.org/api-reference/virtual-accounts/list-an-accounts-payments.md): The payments made into one of the business's virtual accounts, and what each did: credited, held for a decision, accepted or returned. - [Name a number](https://docs.mesh.larkwave.org/api-reference/virtual-accounts/name-a-number.md): Names one of the business's numbers, before its first payment too: a number it already has is renamed as above; a number under one of its number patterns with no account yet gets its account now (201). - [List an account's settlements](https://docs.mesh.larkwave.org/api-reference/virtual-accounts/list-an-accounts-settlements.md): A collection account's payments passed on to the business's settlement account, newest first. Filter by status and date; page with the cursor. - [List wallets](https://docs.mesh.larkwave.org/api-reference/wallets/list-wallets.md): Lists the business's wallets and its customers', newest first. Filter by owner, customer, status or creation date; page with the cursor. - [Create a wallet](https://docs.mesh.larkwave.org/api-reference/wallets/create-a-wallet.md): Opens a wallet: for a customer (named after them; the customer must be registered with the bank, and an open business's needs KYC tier 1), or one of the business's own with a label. A retry with the same Idempotency-Key and body returns the same wallet. - [Get a wallet](https://docs.mesh.larkwave.org/api-reference/wallets/get-a-wallet.md): Gets one of the business's wallets, with its tier, limits and what it has received. - [List webhook deliveries](https://docs.mesh.larkwave.org/api-reference/webhook-deliveries/list-webhook-deliveries.md): Deliveries newest first. Filter by status, event or creation date; page with the cursor. - [Get a webhook delivery](https://docs.mesh.larkwave.org/api-reference/webhook-deliveries/get-a-webhook-delivery.md): One delivery: the body sent and every try, with the status and the start of the answer. - [Retry a webhook delivery](https://docs.mesh.larkwave.org/api-reference/webhook-deliveries/retry-a-webhook-delivery.md): Sends it again now, whatever its status, signed with today's secret. The same event id, so a receiver that saw it already can ignore it. - [Get the webhook URL](https://docs.mesh.larkwave.org/api-reference/webhook-endpoint/get-the-webhook-url.md): Gets the webhook URL for the key's mode. Never the secret. - [Set the webhook URL](https://docs.mesh.larkwave.org/api-reference/webhook-endpoint/set-the-webhook-url.md): Sets or changes the webhook URL for the key's mode: https in live, never a private address. The first time, 201 with the signing secret (whsec_…), shown once; a change keeps the secret. - [Remove the webhook URL](https://docs.mesh.larkwave.org/api-reference/webhook-endpoint/remove-the-webhook-url.md): Removes the webhook URL for the key's mode; no more events are sent to it. - [Send a test event](https://docs.mesh.larkwave.org/api-reference/webhook-endpoint/send-a-test-event.md): Queues a `webhook.test` event to the URL now, signed like every other; follow it in the deliveries. - [Rotate the signing secret](https://docs.mesh.larkwave.org/api-reference/webhook-endpoint/rotate-the-signing-secret.md): A new signing secret, shown once. The old one keeps signing too for 24 hours, so nothing fails while it is swapped. ## OpenAPI Specs - [openapi](/api-reference/openapi.json) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.