Getting Accounts

Get all accounts

get

Query parameters

primaryAccountIdstring · uuid | nullableRequired

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

Responseall of

objectOptional

and

400

Input validation error

application/json

422

Unprocessable entity

application/json

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": "e0cab2dd-739f-43de-b131-3e423e935bf1",
      "customerId": "a2b9649e-df7f-4349-adff-1c57283fef10",
      "partnerId": "2ecf0e23-3215-462c-97c4-9e5a147656d7",
      "primaryAccountId": "ae66fcb2-2852-4568-990d-accc78572e4d",
      "type": "PRIMARY",
      "currencyCode": "GBP",
      "createDate": "2025-01-01",
      "identifiers": [
        {
          "type": "UK_ACCOUNT",
          "beneficiary": "John Doe",
          "bankAddress": "Squire Patton Boggs, No.1 Spinningfields, Hardman Square, Manchester, M3 3EB",
          "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

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

400

Input validation error

application/json

403

Forbidden

application/json

404

Account not found

application/json

422

Unprocessable entity

application/json

get

GET /v1/partner/accounts/{accountId} HTTP/1.1
Host: api-url
Accept: */*

{
  "id": "e0cab2dd-739f-43de-b131-3e423e935bf1",
  "customerId": "a2b9649e-df7f-4349-adff-1c57283fef10",
  "partnerId": "2ecf0e23-3215-462c-97c4-9e5a147656d7",
  "primaryAccountId": "ae66fcb2-2852-4568-990d-accc78572e4d",
  "type": "PRIMARY",
  "currencyCode": "GBP",
  "createDate": "2025-01-01",
  "identifiers": [
    {
      "type": "UK_ACCOUNT",
      "beneficiary": "John Doe",
      "bankAddress": "Squire Patton Boggs, No.1 Spinningfields, Hardman Square, Manchester, M3 3EB",
      "data": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      }
    }
  ],
  "state": "READY",
  "balance": {
    "currency": "GBP",
    "availableBalance": 1,
    "ledgerBalance": 1,
    "pendingCredits": 1
  }
}

Get customer accounts

get

Path parameters

customerIdstringRequired

Query parameters

primaryAccountIdstring · uuid | nullableRequired

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

Responseall of

objectOptional

and

400

Input validation error

application/json

403

Forbidden

application/json

422

Unprocessable entity

application/json

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": "e0cab2dd-739f-43de-b131-3e423e935bf1",
      "customerId": "a2b9649e-df7f-4349-adff-1c57283fef10",
      "partnerId": "2ecf0e23-3215-462c-97c4-9e5a147656d7",
      "primaryAccountId": "ae66fcb2-2852-4568-990d-accc78572e4d",
      "type": "PRIMARY",
      "currencyCode": "GBP",
      "createDate": "2025-01-01",
      "identifiers": [
        {
          "type": "UK_ACCOUNT",
          "beneficiary": "John Doe",
          "bankAddress": "Squire Patton Boggs, No.1 Spinningfields, Hardman Square, Manchester, M3 3EB",
          "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 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

400

Input validation error

application/json

403

Forbidden

application/json

404

Account not found

application/json

422

Unprocessable entity

application/json

get

GET /v1/partner/customers/{customerId}/accounts/{accountId} HTTP/1.1
Host: api-url
Accept: */*

{
  "id": "e0cab2dd-739f-43de-b131-3e423e935bf1",
  "customerId": "a2b9649e-df7f-4349-adff-1c57283fef10",
  "partnerId": "2ecf0e23-3215-462c-97c4-9e5a147656d7",
  "primaryAccountId": "ae66fcb2-2852-4568-990d-accc78572e4d",
  "type": "PRIMARY",
  "currencyCode": "GBP",
  "createDate": "2025-01-01",
  "identifiers": [
    {
      "type": "UK_ACCOUNT",
      "beneficiary": "John Doe",
      "bankAddress": "Squire Patton Boggs, No.1 Spinningfields, Hardman Square, Manchester, M3 3EB",
      "data": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      }
    }
  ],
  "state": "READY",
  "balance": {
    "currency": "GBP",
    "availableBalance": 1,
    "ledgerBalance": 1,
    "pendingCredits": 1
  }
}

PreviousVirtual Accounts NextBalances Explained

Last updated 9 days ago

Was this helpful?