Merchant

Get Virtual Bank Accounts by Merchant

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
get/api/v1/organizations/{organizationId}/merchants/{merchantId}/virtual-accounts

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/organizations/{organizationId}/merchants/{merchantId}/virtual-accounts
  • Auth: HTTP bearer

Path parameters

organizationIdstring required
Example:org_abc123

Organization identifier

merchantIdstring required
Example:merchant_123

Merchant identifier

Response

Virtual bank accounts retrieved successfully

idstring required

Virtual bank account ID

country'AR' | 'MX' | 'US' required

Country code

currency'ARS' | 'MXN' | 'USD' required

Currency code

providerstring required

Payment Service Provider name

isActiveboolean required

Active status of the account

virtualBankAccountNumberstring

Virtual bank account number

aliasstring

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

routingNumberstring

Routing number (USA/ACH). Optional.

bankNamestring

Bank name. Optional.

createdAtstring date-time required

Creation date

Example response

[
  {
    "id": "pivba_123456",
    "country": "AR",
    "currency": "ARS",
    "provider": "BITSO_MX",
    "isActive": true,
    "virtualBankAccountNumber": "0000000000000000000000",
    "alias": "john.doe.koywe",
    "routingNumber": "021000021",
    "bankName": "Chase Bank",
    "createdAt": "2025-10-25T12:00:00Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.