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

post

/v1/partner/accounts/primary

Header parameters

authorizationstring

Authorization header containing your API Token

x-alg-noncestring

Nonce used to generate the payload signature

x-alg-signaturestring

Payload signature

datestring

Date of the request un UTC/GMT

Body

customerIdstring · uuidrequired

idempotencyKeystring · uuidrequired

A unique idempotency key to prevent duplicate operations

currencyCodestring · enumrequired

ISO 4217 3 digit alpha-numeric currency code

Example: GBP

Options: AFN, EUR, ALL, DZD, USD, AOA, XCD, ARS, AMD, AWG, AUD, AZN, BSD, BHD, BDT, BBD, BYN, BZD, XOF, BMD, INR, BTN, BOB, BOV, BAM, BWP, NOK, BRL, BND, BGN, BIF, CVE, KHR, XAF, CAD, KYD, CLP, CLF, CNY, COP, COU, KMF, CDF, NZD, CRC, HRK, CUP, CUC, ANG, CZK, DKK, DJF, DOP, EGP, SVC, ERN, SZL, ETB, FKP, FJD, XPF, GMD, GEL, GHS, GIP, GTQ, GBP, GNF, GYD, HTG, HNL, HKD, HUF, ISK, IDR, XDR, IRR, IQD, ILS, JMD, JPY, JOD, KZT, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, ZAR, LRD, LYD, CHF, MOP, MKD, MGA, MWK, MYR, MVR, MRU, MUR, XUA, MXN, MXV, MDL, MNT, MAD, MZN, MMK, NAD, NPR, NIO, NGN, OMR, PKR, PAB, PGK, PYG, PEN, PHP, PLN, QAR, RON, RUB, RWF, WST, STN, SAR, RSD, SCR, SLL, SGD, XSU, SBD, SOS, SSP, LKR, SDG, SRD, SEK, CHE, CHW, SYP, TWD, TJS, THB, TOP, TTD, TND, TRY, TMT, UGX, UAH, AED, USN, UYU, UYI, UYW, UZS, VUV, VES, VND, YER, ZMW, ZWL, XBA, XBB, XBC, XBD, XTS, XXX, XAU, XPD, XPT, XAG, AFA, FIM, ADP, ESP, FRF, AOK, AOR, RUR, ATS, AYM, AZM, BYB, BYR, BEC, BEF, BEL, BAD, BRB, BRR, BGJ, CYP, CSK, ECS, ECV, GQE, EEK, XEU, GEK, DDM, DEM, GHC, GHP, GRD, GWE, ITL, IEP, LVL, ZAL, LTL, LUC, LUF, LUL, MGF, MLF, MTL, MRO, MZE, NLG, PLZ, PTE, ROK, STD, CSD, SKK, SIT, RHD, ESA, ESB, SDD, SRG, TJR, TPE, TRL, TMM, UAK, USS, VEB, VEF, YUD, ZRN, ZMK, ZWN, ZWR

productCodestringrequired

The product code for the account requested

Example: FIAT_ACCOUNT_UK_V1

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'api-url/v1/partner/accounts/primary' \
  --header 'Content-Type: application/json' \
  --data '{
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "currencyCode": "GBP",
    "productCode": "FIAT_ACCOUNT_UK_V1"
  }'

200

400

401

403

200

{
  "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-03-12T04:27:56.894Z",
  "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
  }
}

Account successfully created