Getting Accounts

Get all accounts

get

/v1/partner/accounts

Query parameters

typesstring · enum[] | nullablerequired

primaryAccountIdstring · uuid | nullablerequired

statesstring · enum[] | nullablerequired

pagenumber · default: 1required

limitnumber · max: 100 · default: 10required

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

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'api-url/v1/partner/accounts?types=PRIMARY&primaryAccountId=123e4567-e89b-12d3-a456-426614174000&states=READY&page=1&limit=10'

200

400

422

200

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

List of accounts available to the partner

Get account

get

/v1/partner/accounts/{accountId}

Path parameters

accountIdstringrequired

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

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'api-url/v1/partner/accounts/{accountId}'

200

400

403

404

422

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:32:53.693Z",
  "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
  }
}

Returns the account details

Get customer accounts

get

/v1/partner/customers/{customerId}/accounts

Path parameters

customerIdstringrequired

Query parameters

typesstring · enum[] | nullablerequired

primaryAccountIdstring · uuid | nullablerequired

statesstring · enum[] | nullablerequired

pagenumber · default: 1required

limitnumber · max: 100 · default: 10required

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

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'api-url/v1/partner/customers/{customerId}/accounts?types=PRIMARY&primaryAccountId=123e4567-e89b-12d3-a456-426614174000&states=READY&page=1&limit=10'

200

400

403

422

200

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

List of accounts available to the partner

Get customer account

get

/v1/partner/customers/{customerId}/accounts/{accountId}

Path parameters

customerIdstringrequired

accountIdstringrequired

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

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'api-url/v1/partner/customers/{customerId}/accounts/{accountId}'

200

400

403

404

422

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:32:53.693Z",
  "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
  }
}

Returns the account details