Compose Finance
Virtual accounts

Get customer virtual account

Returns the virtual account details and status for a specific virtual account ID. Use `GET /virtual-accounts` to list all virtual accounts for a customer.

GET
/api/v2/customers/{customerId}/virtual-account

Returns the virtual account details and status for a specific virtual account ID. Use GET /virtual-accounts to list all virtual accounts for a customer.

Authorization

bearerAuth
AuthorizationBearer <token>

Organization API key obtained from PropelAuth

In: header

Path Parameters

customerId*string

Unique identifier of the customer

Query Parameters

virtualAccountId*string

Virtual account ID to retrieve. This ID is returned when creating a virtual account.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET 'https://compose.finance/api/v2/customers/{customerId}/virtual-account?virtualAccountId=corr-12345-abcde' \  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "customerId": "550e8400-e29b-41d4-a716-446655440001",
  "status": "PENDING",
  "virtualAccountId": "corr-12345-abcde",
  "message": "Virtual account creation is pending"
}

{
  "error": "virtualAccountId query parameter is required. Use GET /virtual-accounts to list all virtual accounts."
}
{
  "error": "Unauthorized - Invalid or missing API key or session"
}
{
  "error": "Virtual accounts feature is not enabled for your organization"
}

{
  "error": "Customer not found"
}

Create customer virtual account POST

Creates a dedicated named virtual IBAN for the customer. For individual customers, address and identity information is automatically pulled from Sumsub KYC verification. The account creation is asynchronous. Corporate customer virtual accounts creation is not yet supported via API.

List customer virtual accounts GET

Returns all virtual bank accounts (IBANs) for the customer, including their status and details.