Primary Accounts

This page contains API details for primary accounts

Primary Accounts

Primary accounts can be used for a variety of purposes, such as facilitating cross-border transactions, receiving payments from multiple sources, and managing finances for e-commerce businesses.

Safeguarding

Please contact your account manager to ensure you have the correct setup for primary account safeguarding.

We usually create these accounts within a regulated banking environments backed by safeguarded accounts. Each account can only have one currency, all the payments and transactions from/to these accounts must be in the account currency.

Account Identifiers

Account identifiers used for inbound and outbound payment routing purposes. These identifiers attached automatically upon successful account creation. Primary account will have at least one account identifier.

Supported Identifiers

• Sort Code and Account Number

• IBAN and BIC

Supported Currencies & Payment Routing

Following identifiers will be added by default based on currency and product code used in primary account creation.

Currency

GBP

Juristiction

United Kingdom

Default Identifier

Sort Code & Account Number

Additional Identifiers

Currency

EUR

Juristiction

United Kingdom

Default Identifier

IBAN & BIC

Additional Identifiers

N/A

Currency

EUR

Juristiction

Netherlands

Default Identifier

IBAN & BIC

Additional Identifiers

N/A

Please contact to account manager if you need any other currencies or account identifiers.

Create Primary Account

You need to specify account currency, and product code. If you don't have a product code, please contact your account manager to get one.

Create a primary account

POSTapi-url/v1/partner/accounts/primary

Header parameters

Body

application/json

idempotencyKey*string (uuid)

A unique idempotency key to prevent duplicate operations

currencyCode*enum

ISO 4217 3 digit alpha-numeric currency code

Example: "GBP"

AFNEURALLDZDUSDAOAXCDARSAMDAWGAUDAZNBSDBHDBDTBBDBYNBZDXOFBMDINRBTNBOBBOVBAMBWPNOKBRLBNDBGNBIFCVEKHRXAFCADKYDCLPCLFCNYCOPCOUKMFCDFNZDCRCHRKCUPCUCANGCZKDKKDJFDOPEGPSVCERNSZLETBFKPFJDXPFGMDGELGHSGIPGTQGBPGNFGYDHTGHNLHKDHUFISKIDRXDRIRRIQDILSJMDJPYJODKZTKESKPWKRWKWDKGSLAKLBPLSLZARLRDLYDCHFMOPMKDMGAMWKMYRMVRMRUMURXUAMXNMXVMDLMNTMADMZNMMKNADNPRNIONGNOMRPKRPABPGKPYGPENPHPPLNQARRONRUBRWFWSTSTNSARRSDSCRSLLSGDXSUSBDSOSSSPLKRSDGSRDSEKCHECHWSYPTWDTJSTHBTOPTTDTNDTRYTMTUGXUAHAEDUSNUYUUYIUYWUZSVUVVESVNDYERZMWZWLXBAXBBXBCXBDXTSXXXXAUXPDXPTXAGAFAFIMADPESPFRFAOKAORRURATSAYMAZMBYBBYRBECBEFBELBADBRBBRRBGJCYPCSKECSECVGQEEEKXEUGEKDDMDEMGHCGHPGRDGWEITLIEPLVLZALLTLLUCLUFLULMGFMLFMTLMROMZENLGPLZPTEROKSTDCSDSKKSITRHDESAESBSDDSRGTJRTPETRLTMMUAKUSSVEBVEFYUDZRNZMKZWNZWR

productCode*string

The product code for the account requested

Example: "FIAT_ACCOUNT_UK_V1"

Response

200

Account successfully created

Body

application/json

id*string (uuid)

partnerId*string (uuid)

primaryAccountId*nullable string (uuid)

type*enum

PRIMARYVIRTUAL

currencyCode*enum

Example: "GBP"

AFNEURALLDZDUSDAOAXCDARSAMDAWGAUDAZNBSDBHDBDTBBDBYNBZDXOFBMDINRBTNBOBBOVBAMBWPNOKBRLBNDBGNBIFCVEKHRXAFCADKYDCLPCLFCNYCOPCOUKMFCDFNZDCRCHRKCUPCUCANGCZKDKKDJFDOPEGPSVCERNSZLETBFKPFJDXPFGMDGELGHSGIPGTQGBPGNFGYDHTGHNLHKDHUFISKIDRXDRIRRIQDILSJMDJPYJODKZTKESKPWKRWKWDKGSLAKLBPLSLZARLRDLYDCHFMOPMKDMGAMWKMYRMVRMRUMURXUAMXNMXVMDLMNTMADMZNMMKNADNPRNIONGNOMRPKRPABPGKPYGPENPHPPLNQARRONRUBRWFWSTSTNSARRSDSCRSLLSGDXSUSBDSOSSSPLKRSDGSRDSEKCHECHWSYPTWDTJSTHBTOPTTDTNDTRYTMTUGXUAHAEDUSNUYUUYIUYWUZSVUVVESVNDYERZMWZWLXBAXBBXBCXBDXTSXXXXAUXPDXPTXAGAFAFIMADPESPFRFAOKAORRURATSAYMAZMBYBBYRBECBEFBELBADBRBBRRBGJCYPCSKECSECVGQEEEKXEUGEKDDMDEMGHCGHPGRDGWEITLIEPLVLZALLTLLUCLUFLULMGFMLFMTLMROMZENLGPLZPTEROKSTDCSDSKKSITRHDESAESBSDDSRGTJRTPETRLTMMUAKUSSVEBVEFYUDZRNZMKZWNZWR

createDate*string (date-time)

identifiers*array of PartnerAccountIdentifierResponse (object)

state*PartnerAccountStateResponse (object)

balance*PartnerAccountBalanceResponse (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "partnerId": "123e4567-e89b-12d3-a456-426614174000",
  "primaryAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "PRIMARY",
  "currencyCode": "GBP",
  "createDate": "2025-01-04T23:50:46.733Z",
  "identifiers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "UK_ACCOUNT",
      "beneficiary": "text",
      "bankAddress": "text",
      "data": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      },
      "createDate": "2025-01-04T23:50:46.733Z"
    }
  ],
  "state": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "INITIALIZING",
    "lastUpdated": "2025-01-04T23:50:46.733Z",
    "createDate": "2025-01-04T23:50:46.733Z"
  },
  "balance": {
    "currency": "GBP",
    "availableBalance": 0,
    "ledgerBalance": 0,
    "pendingCredits": 0
  }
}