# Meridian

- [Retail Virtual Accounts](https://docs.mnai.com/products/retail-va/index.md): Embed Meridian Virtual Accounts in your app so users can generate U.S. bank account details and receive transfers, including payroll deposits.
- [Request a Sandbox](https://docs.mnai.com/products/retail-va/sandbox.md): Request Sandbox credentials and set up a test environment to build and validate your Meridian integration before going live.
- [Authentication](https://docs.mnai.com/products/retail-va/authentication.md): Secure your API requests using HMAC SHA-256 signatures with pre-shared API keys, including step-by-step instructions and code examples.
- [Webhooks](https://docs.mnai.com/products/retail-va/webhooks-overview.md): Learn how Meridian delivers real-time event notifications to your system via HTTP POST webhooks, including configuration, security, and retry behavior.
- [Session management](https://docs.mnai.com/products/retail-va/session-management.md): Create and manage authenticated sessions that launch Meridian's hosted Virtual Accounts UI inside your application's WebView.
- [WebView](https://docs.mnai.com/products/retail-va/web-view.md): The Virtual Accounts experience must be loaded in a WebView environment that supports all required capabilities for onboarding and account management.
- [Customization](https://docs.mnai.com/products/retail-va/customization.md): Configure branding, localization, and customer support settings to tailor the Virtual Accounts experience to your program.
- [Information we collect](https://docs.mnai.com/products/retail-va/kyc-information.md): The customer information collected during Retail Virtual Account onboarding for KYC.
- [Simulate KYC outcomes](https://docs.mnai.com/products/retail-va/simulate-kyc.md): Use sandbox test inputs to simulate different KYC application outcomes during development and testing.
- [Deposits](https://docs.mnai.com/products/retail-va/deposits.md): Learn how customers receive ACH, wire, and stablecoin deposits into their Virtual Account, including the transaction lifecycle and Auto-sweep feature.
- [Withdrawals](https://docs.mnai.com/products/retail-va/withdrawals.md): Learn how customers withdraw funds from their Virtual Account and receive local currency payouts through your Credit API.
- [Introduction](https://docs.mnai.com/products/retail-va/api-reference/index.md): API reference for creating authenticated Virtual Accounts sessions, including base URLs, credentials, and authentication requirements.
- [Virtual Account Transaction](https://docs.mnai.com/products/retail-va/api-reference/webhooks/webhooks-transaction.md): Learn when the virtual account transaction webhook is sent and what data it includes.
- [Create a Session](https://docs.mnai.com/products/retail-va/api-reference/sessions/create-session.md): Create a Virtual Account Session to launch the hosted Meridian onboarding experience.
- [Create a quote](https://docs.mnai.com/products/retail-va/api-reference/withdrawals/create-quote.md): Create a currency conversion quote that locks an exchange rate before initiating a withdrawal.
- [Create a withdrawal](https://docs.mnai.com/products/retail-va/api-reference/withdrawals/create-withdrawal.md): Execute a withdrawal from a virtual account using a previously created quote.
- [Delete a virtual account application](https://docs.mnai.com/products/retail-va/api-reference/simulations/delete-virtual-account-application.md): Delete a user's onboarding application so onboarding can be re-tested in the sandbox.
- [Getting started](https://docs.mnai.com/products/meridian-accounts/guides/getting-started.md): Set up your Meridian Accounts Sandbox credentials, understand how Meridian identifies your customers, and prepare for production access.
- [Choose your integration model](https://docs.mnai.com/products/meridian-accounts/guides/choose-your-integration-model.md): Understand how SINGLE_USER and MULTI_USER integrations differ and how that choice affects authentication and onboarding.
- [Postman collection](https://docs.mnai.com/postman-collection.md): Import the official Meridian Postman collection. HMAC signing is handled for you — set your credentials and start making requests.
- [Authentication overview](https://docs.mnai.com/products/meridian-accounts/guides/authentication-overview.md): Learn when Meridian Accounts uses partner HMAC authentication versus Meridian JWT bearer authentication.
- [Server-to-server authentication with HMAC](https://docs.mnai.com/products/meridian-accounts/guides/server-to-server-authentication-with-hmac.md): Use Meridian partner credentials and an HMAC SHA-256 signature when your backend calls the Meridian Accounts API directly.
- [Client-server authentication with JWT](https://docs.mnai.com/products/meridian-accounts/guides/client-server-authentication-with-jwt.md): Use the Meridian access token as a bearer token after your backend has minted it with partner HMAC authentication.
- [Onboarding your customer](https://docs.mnai.com/products/meridian-accounts/guides/onboarding-your-customer.md): Enroll customers into a program, complete required onboarding steps, and activate their Meridian Account.
- [Displaying account information](https://docs.mnai.com/products/meridian-accounts/guides/displaying-account-information.md): Learn how to use Meridian Accounts to display deposit instructions and account activity in your UI.
- [Information we collect](https://docs.mnai.com/products/meridian-accounts/guides/kyb-information.md): The business, ownership, and document information collected when opening a Meridian Account for a business (KYB).
- [Making a payout](https://docs.mnai.com/products/meridian-accounts/guides/making-a-withdrawal.md): Register a beneficiary, then use the Transaction Intent API to preview and commit a payout from a Meridian balance.
- [Overview](https://docs.mnai.com/products/meridian-accounts/api-reference/index.md): Learn how to authenticate and use the Meridian Accounts API.
- [List the users enrolled in a program](https://docs.mnai.com/api-reference/users/list-the-users-enrolled-in-a-program.md): Returns the users that have an enrollment on the program identified by the `X-Meridian-Program-Id` header, newest first. A user created through `POST /v1/auth/users` appears here once enrollment has started. Both SINGLE_USER and MULTI_USER integrations may call this endpoint; no `X-Meridian-User-Id`…
- [Issue a Meridian Accounts access token](https://docs.mnai.com/api-reference/auth/issue-a-meridian-accounts-access-token.md): Mints a JWT for a Meridian user. For `client_credentials` grants, the user is identified by the `X-Meridian-User-Id` header: it must be provided for MULTI_USER integrations and omitted for SINGLE_USER integrations (the single configured user is used). For `refresh_token` grants, the user is derived…
- [Create a Meridian user for a partner](https://docs.mnai.com/api-reference/auth/create-a-meridian-user-for-a-partner.md): Creates a person or business user for the calling partner on the supplied program. Only MULTI_USER integrations may call this endpoint; SINGLE_USER keys are rejected.
- [Get current enrollment status](https://docs.mnai.com/api-reference/enrollment/get-current-enrollment-status.md): Returns the enrollment for the authenticated Meridian account, creating one on the first call if none exists yet.
- [Activate a pending enrollment](https://docs.mnai.com/api-reference/enrollment/activate-a-pending-enrollment.md): Creates or resumes the enrollment for the authenticated Meridian account and returns the current enrollment state.
- [List all Information Requests](https://docs.mnai.com/api-reference/information-requests/list-all-information-requests.md): Returns the Information Requests associated with the authenticated Meridian account.
- [Get an Information Request by ID](https://docs.mnai.com/api-reference/information-requests/get-an-information-request-by-id.md): Returns the Information Request details for the authenticated Meridian account.
- [Create or update Information Request requirement entry data](https://docs.mnai.com/api-reference/information-requests/create-or-update-information-request-requirement-entry-data.md): Writes structured data for one or more requirement entries.
- [Upload and attach an Information Request document](https://docs.mnai.com/api-reference/information-requests/upload-and-attach-an-information-request-document.md): Uploads a document for a requirement entry and stores it.
- [Submit an Information Request for review](https://docs.mnai.com/api-reference/information-requests/submit-an-information-request-for-review.md): Submits the Information Request for the authenticated Meridian account. A `validationStatus` of `VALID` covers every rule checkable from the Information Request itself; submission additionally checks it against existing data (for example whether the business name is already registered) and reports a…
- [List Accounts](https://docs.mnai.com/api-reference/accounts/list-accounts.md): Returns the accounts associated with the authenticated Meridian account.
- [Get Account by ID](https://docs.mnai.com/api-reference/accounts/get-account-by-id.md): Returns the account details for the authenticated Meridian account.
- [Add a Deposit Instruction to an Account](https://docs.mnai.com/api-reference/accounts/add-a-deposit-instruction-to-an-account.md): Starts provisioning a new, named deposit instruction on an existing account. Funds received on it are swept into the account automatically. Responds `202 Accepted`; the instruction appears in `GET /v1/accounts/{accountId}` once provisioned. A retry that reuses the same `idempotencyKey` with a differ…
- [Get Account Statement](https://docs.mnai.com/api-reference/accounts/get-account-statement.md): Returns a statement of the account's activity over a period, formatted as JSON, CSV, or PDF. JSON is returned inline; CSV and PDF are rendered and uploaded, and this endpoint responds with a time-limited download link instead of the file itself. Statements are available from 2026-01-01 onwards, the…
- [List Transactions](https://docs.mnai.com/api-reference/transactions/list-transactions.md): Returns the transactions associated with the authenticated Meridian account.
- [Get Transaction by ID](https://docs.mnai.com/api-reference/transactions/get-transaction-by-id.md): Returns the transaction details for the authenticated Meridian account.
- [List Beneficiaries](https://docs.mnai.com/api-reference/beneficiaries/list-beneficiaries.md): Returns the beneficiaries associated with the authenticated Meridian account.
- [Create a Beneficiary](https://docs.mnai.com/api-reference/beneficiaries/create-a-beneficiary.md): Creates a beneficiary together with its first payout instrument for the authenticated Meridian account. The instrument is either a bank account (`BANK_ACCOUNT`) or a stablecoin wallet address (`BLOCKCHAIN_WALLET`); further instruments are attached with `POST /v1/beneficiaries/{beneficiaryId}/instrum…
- [Get Beneficiary by ID](https://docs.mnai.com/api-reference/beneficiaries/get-beneficiary-by-id.md): Returns the beneficiary details for the authenticated Meridian account.
- [List Beneficiary Instruments](https://docs.mnai.com/api-reference/beneficiaries/list-beneficiary-instruments.md): Returns the payout instruments for a beneficiary belonging to the authenticated Meridian account, bank accounts and stablecoin wallets alike, discriminated by `type`.
- [Add an Instrument to a Beneficiary](https://docs.mnai.com/api-reference/beneficiaries/add-an-instrument-to-a-beneficiary.md): Attaches an additional payout instrument to an existing beneficiary for the authenticated Meridian account. A bank account (`BANK_ACCOUNT`) or a stablecoin wallet address (`BLOCKCHAIN_WALLET`). One wallet address may be registered once per supported currency, each as its own instrument.
- [Create a transaction intent](https://docs.mnai.com/api-reference/transaction-intents/create-a-transaction-intent.md): Creates a transaction-shaped preview from debit and credit payment instruments. The credit instrument may be a beneficiary bank account or a beneficiary blockchain wallet; a stablecoin payout must debit and credit the same currency. No funds movement occurs until the intent is committed.
- [Commit a transaction intent](https://docs.mnai.com/api-reference/transaction-intents/commit-a-transaction-intent.md): Commits a created transaction intent. Commit is idempotent and creates at most one underlying Meridian transaction.
- [Send a Mock Deposit](https://docs.mnai.com/api-reference/sandbox/send-a-mock-deposit.md): Simulates an inbound deposit into a balance account through a given deposit instruction, so you can exercise downstream processing — balances, transactions, and webhooks — without moving real money. This is fire-and-acknowledge: it responds `202` with an empty body and settles out of band, so observ…
- [Overview](https://docs.mnai.com/products/meridian-accounts/webhooks/webhooks-overview.md): Learn how Meridian Accounts delivers webhook notifications, including security, retries, and delivery behavior.
- [Enrollment](https://docs.mnai.com/products/meridian-accounts/webhooks/webhooks-enrollment.md): Learn when enrollment webhooks are sent and what data they include.
- [Information Request](https://docs.mnai.com/products/meridian-accounts/webhooks/webhooks-information-request.md): Learn when Information Request webhooks are sent and what data they include.
- [Transaction](https://docs.mnai.com/products/meridian-accounts/webhooks/webhooks-transaction.md): Learn when transaction webhooks are sent and what data they include.
- [Account](https://docs.mnai.com/products/meridian-accounts/webhooks/webhooks-account.md): Learn when account webhooks are sent and what data they include.
- [Overview](https://docs.mnai.com/products/payout-origination/overview.md): Submit payout requests to Meridian for asynchronous validation and processing.
- [Request a Sandbox](https://docs.mnai.com/products/payout-origination/sandbox.md): Request Sandbox credentials and set up a test environment to build and validate your Meridian Payout Origination integration before going live.
- [Authentication](https://docs.mnai.com/products/payout-origination/authentication.md): Secure your API requests using HMAC SHA-256 signatures with pre-shared API keys, including step-by-step instructions and code examples.
- [Postman collection](https://docs.mnai.com/postman-collection.md): Import the official Meridian Postman collection. HMAC signing is handled for you — set your credentials and start making requests.
- [Supported formats](https://docs.mnai.com/products/payout-origination/supported-formats.md): See which message formats the Payout Origination API accepts and which path slug to use for each one.
- [pacs.008 format](https://docs.mnai.com/products/payout-origination/pacs008-format.md): Understand the pacs.008 XML document Meridian expects you to Base64-encode and submit to the Payout Origination API.
- [JSON format](https://docs.mnai.com/products/payout-origination/json-format.md): Understand the Base64-encoded JSON payload Meridian accepts when you submit `POST /v1/payout-origination/json`.
- [Base64 payload encoding](https://docs.mnai.com/products/payout-origination/base64-payload-encoding.md): Learn how to prepare the Base64-encoded payload you send to the Payout Origination API.
- [Submit a payout request](https://docs.mnai.com/api-reference/payouts/submit-a-payout-request.md): Accepts a Base64-encoded payout request in the format specified by the `format` path parameter.
- [List payout transactions](https://docs.mnai.com/api-reference/transactions/list-payout-transactions.md): Returns transactions with their latest processing status. You can optionally filter the results by the Meridian `messageId` returned from the message submission endpoint.
- [Get a payout transaction](https://docs.mnai.com/api-reference/transactions/get-a-payout-transaction.md): Returns a transaction with its latest processing status by Meridian transaction ID.
- [Overview](https://docs.mnai.com/products/payout-origination/webhooks-overview.md): Learn how Meridian delivers webhook notifications, including security, retries, and delivery behavior.
- [Processing Status Updated](https://docs.mnai.com/products/payout-origination/webhooks-processing-status-updated.md): Learn when the processing status updated webhook is sent and what data it includes.
- [Overview](https://docs.mnai.com/products/bank-transfers/overview.md): How Meridian instructs bank partners to move money in real time.
- [Credit API](https://docs.mnai.com/products/bank-transfers/credit-api.md): Push funds from Meridian's sponsored account to a customer's account at the home bank.
- [Debit API](https://docs.mnai.com/products/bank-transfers/debit-api.md): Pull funds from a customer's account into Meridian's sponsored account at the home bank.
- [Overview](https://docs.mnai.com/products/bank-transfers/credit-api-example/index.md): A reference specification for bank partners building a Credit API from scratch, based on ISO 20022 pacs.008 and pacs.002.
- [Authentication](https://docs.mnai.com/products/bank-transfers/credit-api-example/authentication.md): The recommended authentication scheme for a partner-hosted Credit API, and the alternatives Meridian supports.
- [Message reference](https://docs.mnai.com/products/bank-transfers/credit-api-example/message-reference.md): What Meridian puts in each pacs.008 field, what the bank returns in the pacs.002, and the Meridian extensions to ISO 20022.
- [Create a credit](https://docs.mnai.com/products/bank-transfers/credit-api-example/create-credit.md): Register a credit instruction with the bank ahead of validation and execution.
- [Validate a credit](https://docs.mnai.com/products/bank-transfers/credit-api-example/validate-credit.md): Confirm the recipient account can receive the credit before any money moves.
- [Commit a credit](https://docs.mnai.com/products/bank-transfers/credit-api-example/commit-credit.md): Execute the transfer from Meridian's sponsored account to the recipient.
- [Get transaction status](https://docs.mnai.com/products/bank-transfers/credit-api-example/get-transaction-status.md): Retrieve the current status of a credit, polled by Meridian until the transaction is terminal.
- [Status webhook](https://docs.mnai.com/products/bank-transfers/credit-api-example/status-webhook.md): Push a final transaction status to Meridian instead of waiting for polling.
- [Realtime Collections](https://docs.mnai.com/products/realtime-collections/index.md): Create and manage payment links to collect funds from your customers with Meridian Realtime Collections.
- [Request a Sandbox](https://docs.mnai.com/products/realtime-collections/sandbox.md): Request Sandbox credentials and set up a test environment to build and validate your Meridian integration before going live.
- [Authentication](https://docs.mnai.com/products/realtime-collections/authentication.md): Secure your API requests using HMAC SHA-256 signatures with pre-shared API keys, including step-by-step instructions and code examples.
- [Webhooks](https://docs.mnai.com/products/realtime-collections/webhooks-overview.md): Learn how Meridian delivers real-time event notifications to your system via HTTP POST webhooks, including configuration, security, and retry behavior.
- [Tracking a payment link payment with webhooks](https://docs.mnai.com/products/realtime-collections/tracking-payments-with-webhooks.md): Follow a payment link payment from creation to completion, failure, or reversal using payment link transaction webhooks.
- [Introduction](https://docs.mnai.com/products/realtime-collections/api-reference/index.md): API reference for the Realtime Collections API, including base URLs, credentials, and authentication requirements.
- [Create a Session](https://docs.mnai.com/products/realtime-collections/api-reference/sessions/create-session.md): Create a Realtime Collections session to obtain the session key required to create payment links.
- [Create a Payment Link](https://docs.mnai.com/products/realtime-collections/api-reference/payment-links/create-payment-link.md): Create a payment link to collect a one-off, recurring, or variable payment from a customer.
- [Update a Payment Link](https://docs.mnai.com/products/realtime-collections/api-reference/payment-links/update-payment-link.md): Apply partial changes to an existing payment link, including its amount, schedule, and status.
- [Retrieve a Payment Link](https://docs.mnai.com/products/realtime-collections/api-reference/payment-links/get-payment-link.md): Retrieve a payment link and its current state by Meridian id.
- [Payment Link](https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link.md): Learn when the payment link webhook is sent and what data it includes.
- [Payment Link Transaction](https://docs.mnai.com/products/realtime-collections/api-reference/webhooks/webhooks-payment-link-transaction.md): Learn when the payment link transaction webhooks are sent and what data they include.

## OpenAPI Specs

- [credit-api-example](/products/bank-transfers/credit-api-example/credit-api-example.yaml)
- [meridian-accounts](/products/meridian-accounts/api-reference/meridian-accounts.json)
- [webhooks](/products/meridian-accounts/webhooks/webhooks.json)
- [payout-origination](/products/payout-origination/api-reference/payout-origination.json)
- [payment-links](/products/realtime-collections/api-reference/payment-links.json)
- [retail-rtd](/products/retail-va/api-reference/retail-rtd.json)