Get Virtual Bank Accounts by Merchant

Response Information:

Merchant details and contact information
List of all virtual bank accounts with their current status
Account numbers, aliases, and creation timestamps
Country and currency information for each account

Roles with Access:

Platform Admin
Wallet & Bank Admin
Platform Contact Support
Financial Operator - Views

Retrieves all virtual bank accounts associated with a specific merchant within an organization. This endpoint provides a comprehensive view of all virtual accounts, including their status, account numbers, and aliases. **Response Information:** - Merchant details and contact information - List of all virtual bank accounts with their current status - Account numbers, aliases, and creation timestamps - Country and currency information for each account **Roles with Access:** - Platform Admin - Wallet & Bank Admin - Platform Contact Support - Financial Operator - Views

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

organizationIdstringRequired

Organization identifier

merchantIdstringRequired

Merchant identifier

Response

Virtual bank accounts retrieved successfully

idstring

Virtual bank account ID

countryenum

Country code

Allowed values:

currencyenum

Currency code

Allowed values:

providerstring

Payment Service Provider name

isActiveboolean

Active status of the account

createdAtdatetime

Creation date

virtualBankAccountNumberstring or null

Virtual bank account number

aliasstring or null

Custom alias for the virtual bank account. Contains only letters, numbers, and dots.

1	import requests
2
3	url = "https://api-test.koywe.com/api/v1/organizations/org_abc123/merchants/merchant_123/virtual-accounts"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	[
2	{
3	"id": "pivba_123456",
4	"country": "AR",
5	"currency": "ARS",
6	"provider": "BITSO_MX",
7	"isActive": true,
8	"createdAt": "2025-10-25T12:00:00Z",
9	"virtualBankAccountNumber": "0000000000000000000000",
10	"alias": "john.doe.koywe"
11	}
12	]

Get Virtual Bank Accounts by Merchant

Authentication

Path Parameters

Headers

Response

Errors