Virtual Accounts

Virtual accounts requires an existing primary account as a parent, and it uses the same currency and safe-guarding relationship as the parent account.

You can create multiple virtual accounts linked with the same primary account, and move funds between:

• Virtual account to virtual account

• Virtual account to parent primary account

• Parent primary account to virtual account

You need an existing Primary Account in order to create a virtual account

Create Virtual Account

Create a virtual account

POSTapi-url/v1/partner/accounts/virtual

Header parameters

Body

application/json

customerId*string (uuid)

idempotencyKey*string (uuid)

A unique idempotency key to prevent duplicate operations

parentAccountId*string (uuid)

The parent account id for the account requested

productCode*string

The product code for the account requested

Example: "FIAT_ACCOUNT_UK_V1"

Response

200400401403

Account successfully created

Body

application/json

id*string (uuid)

customerId*string (uuid)

partnerId*string (uuid)

primaryAccountId*nullable string (uuid)

type*enum

PRIMARYVIRTUAL

currencyCode*enum

Example: "GBP"

AFNEURALLDZDUSDAOAXCDARSAMDAWGAUDAZNBSDBHDBDTBBDBYNBZDXOFBMDINRBTNBOBBOVBAMBWPNOKBRLBNDBGNBIFCVEKHRXAFCADKYDCLPCLFCNYCOPCOUKMFCDFNZDCRCHRKCUPCUCANGCZKDKKDJFDOPEGPSVCERNSZLETBFKPFJDXPFGMDGELGHSGIPGTQGBPGNFGYDHTGHNLHKDHUFISKIDRXDRIRRIQDILSJMDJPYJODKZTKESKPWKRWKWDKGSLAKLBPLSLZARLRDLYDCHFMOPMKDMGAMWKMYRMVRMRUMURXUAMXNMXVMDLMNTMADMZNMMKNADNPRNIONGNOMRPKRPABPGKPYGPENPHPPLNQARRONRUBRWFWSTSTNSARRSDSCRSLLSGDXSUSBDSOSSSPLKRSDGSRDSEKCHECHWSYPTWDTJSTHBTOPTTDTNDTRYTMTUGXUAHAEDUSNUYUUYIUYWUZSVUVVESVNDYERZMWZWLXBAXBBXBCXBDXTSXXXXAUXPDXPTXAGAFAFIMADPESPFRFAOKAORRURATSAYMAZMBYBBYRBECBEFBELBADBRBBRRBGJCYPCSKECSECVGQEEEKXEUGEKDDMDEMGHCGHPGRDGWEITLIEPLVLZALLTLLUCLUFLULMGFMLFMTLMROMZENLGPLZPTEROKSTDCSDSKKSITRHDESAESBSDDSRGTJRTPETRLTMMUAKUSSVEBVEFYUDZRNZMKZWNZWR

createDate*string (date-time)

identifiers*array of object

state*enum

Account state

INITIALIZINGREADYBLOCKEDCLOSEDSUSPENDED

balance*object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('api-url/v1/partner/accounts/virtual', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "parentAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "productCode": "FIAT_ACCOUNT_UK_V1"
    }),
});
const data = await response.json();

Response

200400401403

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "partnerId": "123e4567-e89b-12d3-a456-426614174000",
  "primaryAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "PRIMARY",
  "currencyCode": "GBP",
  "createDate": "2025-02-05T07:02:29.839Z",
  "identifiers": [
    {
      "type": "UK_ACCOUNT",
      "beneficiary": "text",
      "bankAddress": "text",
      "data": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      }
    }
  ],
  "state": "INITIALIZING",
  "balance": {
    "currency": "GBP",
    "availableBalance": 1,
    "ledgerBalance": 1,
    "pendingCredits": 1
  }
}