Accounts

This section covers the different types of accounts supported by the Partner API, including primary accounts and virtual accounts.

Our platform provides two options for accounts on partner platform, Primary Accounts and Virtual Accounts. For both types, account creation is an asynchronous operation on the platform, that's why once request is sent and response received, you might need to wait until account is ready.

Account statuses

You can use Get Account Details API to pull current account status, you can initiate payments or other interactions once you see it's READY

Status	Description
INITIALIZING	Account is not ready to use.
READY	Account ready to use.
SUSPENDED	Account suspended for AML or compliance reasons.
CLOSED	Account permanently closed.

All fund activities for both primary and virtual accounts booked in separate isolated ledgers that maintains separate balances.

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.

Please refer to Primary Accounts section for more information about how to create primary accounts.

Primary Accounts

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.

Please refer to Virtual Accounts section for more information about how to create virtual accounts.

Virtual Accounts

List accounts

You can get all the accounts created under your partner organisation using the following API.

Get all accounts

get

Query parameters

primaryAccountIdstring · uuid · nullableOptional

Primary account ID to filter virtual accounts.

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

pagenumberRequired

Page number for paginated results.

Default: 1Example: 1

limitnumber · max: 100Required

Number of accounts per page.

Default: 10Example: 10

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

Responses

200

List of accounts available to the partner

application/json

objectOptional

and

400

Input validation error

application/json

422

Unprocessable entity

application/json

get

/v1/partner/accounts

HTTPcURLJavaScriptPython

GET /v1/partner/accounts?page=1&limit=10 HTTP/1.1
Accept: */*

{
  "items": [
    {
      "id": "e0cab2dd-739f-43de-b131-3e423e935bf1",
      "externalReference": "123e4567-e89b-12d3-a456-426614174000",
      "primaryAccountId": "ae66fcb2-2852-4568-990d-accc78572e4d",
      "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
      }
    }
  ],
  "meta": {
    "currentPage": 1,
    "itemCount": 10,
    "itemsPerPage": 10,
    "totalItems": 100,
    "totalPages": 10
  }
}

Get Account Details

Get account

get

Path parameters

accountIdstringRequired

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

Responses

200

Returns the account details

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

Primary account identifier, if this account is a sub-account

Example: ae66fcb2-2852-4568-990d-accc78572e4d

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:

400

Input validation error

application/json

403

Forbidden

application/json

404

Account not found

application/json

422

Unprocessable entity

application/json

get

/v1/partner/accounts/{accountId}

HTTPcURLJavaScriptPython

GET /v1/partner/accounts/{accountId} HTTP/1.1
Accept: */*

{
  "id": "e0cab2dd-739f-43de-b131-3e423e935bf1",
  "externalReference": "123e4567-e89b-12d3-a456-426614174000",
  "primaryAccountId": "ae66fcb2-2852-4568-990d-accc78572e4d",
  "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
  }
}