Skip to main content
When an end user finishes bank onboarding, Diameter automatically provisions a virtual account on their behalf. You do not create accounts via API — instead, you retrieve and monitor them as part of managing your end users’ financial activity.

Account Structure

Each end user receives one virtual account per product and bank combination. If an end user is onboarded with two partner banks under the same product, they will have two separate accounts — one per bank. Every account contains the following fields:

Wire Instructions

The wireInstructions object on each account contains the routing information that counterparties need to send funds into the account: Share these details with anyone who needs to send an inbound wire to the account.

Retrieving Accounts

Get a Specific Account

Fetch a single account by its ID:

Search All Accounts

Search across all accounts in your tenant. Narrow results using query parameters:

Include End User Name

Add includeEndUserName=true to any account query to include the owning end user’s name in the response:

Checking Account Balances

Retrieve the current balance for a specific account:
The response includes:
The balance endpoint is rate limited to 15 requests per second. Design your application to poll balances at a responsible frequency, or rely on webhooks for payment status changes rather than balance polling to confirm transaction completion.