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

IBAN & BIC

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

post

Header parameters

authorizationstringOptional

Authorization header containing your API Token

x-alg-noncestringOptional

Nonce used to generate the payload signature

x-alg-signaturestringOptional

Payload signature

datestringOptional

Date of the request un UTC/GMT

Body

application/json

customerIdstring · uuidRequired

Customer ID that will be the account owner.

Example: a2b9649e-df7f-4349-adff-1c57283fef10

idempotencyKeystring · uuidRequired

A unique idempotency key to prevent duplicate account creation.

Example: 1483d25d-3f00-4d39-90ce-2379a130becd

currencyCodestring · enumRequired

ISO 4217 3-letter alpha-numeric currency code for the account.

Example: GBPPossible values:

productCodestringRequired

The product code for the account being created.

Example: FIAT_ACCOUNT_UK_V1

Responses

200

Account successfully created

application/json

idstring · uuidRequired

Unique identifier of the account

Example: e0cab2dd-739f-43de-b131-3e423e935bf1

partnerIdstring · uuidRequiredDeprecated

Partner identifier that owns or manages this account

Example: 2ecf0e23-3215-462c-97c4-9e5a147656d7

externalReferencestring · uuidOptional

External reference

primaryAccountIdstring · uuid · nullableOptional

Always null for primary accounts

typestring · enumRequired

Type of account

Example: PRIMARYPossible values:

currencyCodestring · enumRequired

Currency associated with this account

Example: GBPPossible values:

createDatestring · date-timeRequired

Date when the account was created

Example: 2025-01-01

statestring · enumRequired

Current operational state of the account

Example: READYPossible values:

customerIdstring · uuidRequired

Customer identifier associated with this account

Example: a2b9649e-df7f-4349-adff-1c57283fef10

400

Input validation error

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/v1/partner/accounts/primary

HTTPcURLJavaScriptPython

POST /v1/partner/accounts/primary HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "customerId": "a2b9649e-df7f-4349-adff-1c57283fef10",
  "idempotencyKey": "1483d25d-3f00-4d39-90ce-2379a130becd",
  "currencyCode": "GBP",
  "productCode": "FIAT_ACCOUNT_UK_V1"
}

{
  "id": "e0cab2dd-739f-43de-b131-3e423e935bf1",
  "externalReference": "123e4567-e89b-12d3-a456-426614174000",
  "primaryAccountId": null,
  "type": "PRIMARY",
  "currencyCode": "GBP",
  "createDate": "2025-01-01",
  "identifiers": [
    {
      "type": "UK_ACCOUNT",
      "beneficiary": "John Doe",
      "bankAddress": "Threadneedle St, London EC2R 8AH, United Kingdom",
      "data": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      }
    }
  ],
  "state": "READY",
  "balance": {
    "currency": "GBP",
    "availableBalance": 1,
    "ledgerBalance": 1,
    "pendingCredits": 1
  },
  "customerId": "a2b9649e-df7f-4349-adff-1c57283fef10"
}