Search accounts

Search accounts with cursor-based pagination

curl --request GET \
  --url https://api.pgw-sandbox.finventi.com/account-service/v2/accounts

{
  "meta": {
    "previousPageToken": "10",
    "nextPageToken": "20"
  },
  "accounts": [
    {
      "id": 1,
      "clientAccountId": "acc_001",
      "iban": "LT121000011111111111",
      "accountType": "PRIVATE",
      "accountHolderName": "Jane Doe",
      "status": "OPEN",
      "createdAt": "2025-09-10T13:43:40.758Z",
      "updatedAt": "2025-09-10T13:55:40.758Z",
      "ibanMetadata": {
        "countryCode": "LT",
        "bankCode": "70440",
        "accountCode": "1869"
      },
      "accountHolderNameAliases": [
        "HGRP"
      ],
      "organisationIdentification": {
        "lei": "3423455234Y45D34",
        "bic": "DEUTDEFFXXX",
        "other": {
          "identification": "123-AS-323",
          "schemeNameCode": "BANK",
          "schemeNameProprietary": "LocalRegistry",
          "issuer": "ChamberOfCommerce"
        }
      }
    }
  ]
}

GET

account-service

accounts

Search accounts with cursor-based pagination

curl --request GET \
  --url https://api.pgw-sandbox.finventi.com/account-service/v2/accounts

{
  "meta": {
    "previousPageToken": "10",
    "nextPageToken": "20"
  },
  "accounts": [
    {
      "id": 1,
      "clientAccountId": "acc_001",
      "iban": "LT121000011111111111",
      "accountType": "PRIVATE",
      "accountHolderName": "Jane Doe",
      "status": "OPEN",
      "createdAt": "2025-09-10T13:43:40.758Z",
      "updatedAt": "2025-09-10T13:55:40.758Z",
      "ibanMetadata": {
        "countryCode": "LT",
        "bankCode": "70440",
        "accountCode": "1869"
      },
      "accountHolderNameAliases": [
        "HGRP"
      ],
      "organisationIdentification": {
        "lei": "3423455234Y45D34",
        "bic": "DEUTDEFFXXX",
        "other": {
          "identification": "123-AS-323",
          "schemeNameCode": "BANK",
          "schemeNameProprietary": "LocalRegistry",
          "issuer": "ChamberOfCommerce"
        }
      }
    }
  ]
}

Overview

This endpoint searches your accounts using various filters with cursor-based pagination. You can filter by IBAN, client account ID, account holder name, or account status.

Cursor-Based Pagination

This endpoint uses cursor-based pagination for large datasets. Start with an initial request, then use nextPageToken to fetch the next page and previousPageToken to go back. Use the limit parameter to control results per page (1–100, default 20).

Query Parameters

iban

string | null

IBAN to search for (exact match)

Example:

"LT121000011111111111"

clientAccountId

string | null

Client account ID to search for (exact match)

Example:

"123e4567-e89b-12d3-a456-426614174000"

accountHolderName

string | null

Account holder name to search for (partial match, case insensitive)

Example:

"John Doe"

status

enum<string> | null

Account status to filter by

Available options:

OPEN,

CLOSED

Example:

"OPEN"

previousPageToken

string | null

Token representing current page position (internal account ID). Use previousPageToken or nextPageToken from response for navigation.

Example:

"123"

nextPageToken

string | null

Token representing current page position (internal account ID). Use previousPageToken or nextPageToken from response for navigation.

Example:

"123"

limit

integer<int32> | null

default:20

Number of results per page (1-100)

Required range: 1 <= x <= 100

Example:

20

Response

Accounts found

Cursor-based paginated response containing accounts

meta

object

required

Pagination metadata

Show child attributes

meta.previousPageToken

string | null

Token for fetching previous page

Example:

"10"

meta.nextPageToken

string | null

Token for fetching next page

Example:

"20"

accounts

object[]

required

List of accounts

Show child attributes

accounts.id

integer<int64>

required

Internal account identifier

Example:

1

accounts.clientAccountId

string

required

Client's internal account ID

Example:

"acc_001"

accounts.iban

string

required

International Bank Account Number

Example:

"LT121000011111111111"

accounts.accountType

enum<string>

required

Type of account

Available options:

PRIVATE,

LEGAL

Example:

"PRIVATE"

accounts.accountHolderName

string

required

Name of the account holder

Example:

"Jane Doe"

accounts.status

enum<string>

required

Account status

Available options:

OPEN,

CLOSED

Example:

"OPEN"

accounts.createdAt

string

required

Account creation timestamp

Example:

"2025-09-10T13:43:40.758Z"

accounts.updatedAt

string

required

Last update timestamp

Example:

"2025-09-10T13:55:40.758Z"

accounts.ibanMetadata

object

International Bank Account Generation Metadata

Show child attributes

accounts.ibanMetadata.countryCode

string | null

Country code

Example:

"LT"

accounts.ibanMetadata.bankCode

string | null

Bank code

Example:

"70440"

accounts.ibanMetadata.accountCode

string | null

Account code

Example:

"1869"

accounts.accountHolderNameAliases

string[] | null

Optional alternative names or identifiers to improve matching (e.g., acronyms, short forms like "IBM" for "International Business Machines")

Example:

["HGRP"]

accounts.organisationIdentification

object

Organisation identification details (for LEGAL accounts)

Show child attributes

accounts.organisationIdentification.lei

string | null

LEI of the organisation

Example:

"3423455234Y45D34"

accounts.organisationIdentification.bic

string | null

Organisation BIC

Example:

"DEUTDEFFXXX"

accounts.organisationIdentification.other

object

Other organisation identification details

Show child attributes

accounts.organisationIdentification.other.identification

string

required

Other organisation identification

Example:

"123-AS-323"

accounts.organisationIdentification.other.schemeNameCode

enum<string> | null

Coded name of the identifier scheme

Available options:

BANK,

CBID,

CHID,

CINC,

COID,

CUST,

DUNS,

EMPL,

GS1G,

SREN,

SRET,

TXID,

BDID,

BOID

accounts.organisationIdentification.other.schemeNameProprietary

string | null

Proprietary scheme name

Example:

"LocalRegistry"

accounts.organisationIdentification.other.issuer

string | null

Issuing authority

Example:

"ChamberOfCommerce"

Authentication Create account

⌘I

Getting Started

Account Management

SEPA Instant

SEPA Direct Debit

SWIFT Payments

Payment Information

Nostro Accounts

Bank Information

Webhooks

Overview

Query Parameters

Response

Getting Started

Account Management

SEPA Instant

SEPA Direct Debit

SWIFT Payments

Payment Information

Nostro Accounts

Bank Information

Webhooks

​Overview

​Cursor-Based Pagination

Query Parameters

Response

Overview

Cursor-Based Pagination