HomeStatus

Getting Accounts

Get all accounts

get
Query parameters
primaryAccountIdstring · uuid | nullableRequired
pagenumberRequiredDefault: 1
limitnumber · max: 100RequiredDefault: 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
Responseall of
objectOptional
and
get
GET /v1/partner/accounts?types=PRIMARY&primaryAccountId=123e4567-e89b-12d3-a456-426614174000&states=INITIALIZING&page=1&limit=10 HTTP/1.1
Host: api-url
Accept: */*

{
  "items": [
    {
      "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-07-08T00:59:12.780Z",
      "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
      }
    }
  ],
  "meta": {
    "currentPage": 1,
    "itemCount": 10,
    "itemsPerPage": 10,
    "totalItems": 100,
    "totalPages": 10
  }
}

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
get
GET /v1/partner/accounts/{accountId} HTTP/1.1
Host: api-url
Accept: */*

{
  "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-07-08T00:59:12.780Z",
  "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
  }
}

Get customer accounts

get
Path parameters
customerIdstringRequired
Query parameters
primaryAccountIdstring · uuid | nullableRequired
pagenumberRequiredDefault: 1
limitnumber · max: 100RequiredDefault: 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
Responseall of
objectOptional
and
get
GET /v1/partner/customers/{customerId}/accounts?types=PRIMARY&primaryAccountId=123e4567-e89b-12d3-a456-426614174000&states=INITIALIZING&page=1&limit=10 HTTP/1.1
Host: api-url
Accept: */*

{
  "items": [
    {
      "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-07-08T00:59:12.780Z",
      "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
      }
    }
  ],
  "meta": {
    "currentPage": 1,
    "itemCount": 10,
    "itemsPerPage": 10,
    "totalItems": 100,
    "totalPages": 10
  }
}

Get customer account

get
Path parameters
customerIdstringRequired
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
get
GET /v1/partner/customers/{customerId}/accounts/{accountId} HTTP/1.1
Host: api-url
Accept: */*

{
  "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-07-08T00:59:12.780Z",
  "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
  }
}

PreviousVirtual AccountsNextBalances Explained

Last updated

Was this helpful?