Skip to main content

AccountsEndpoint

The AccountsEndpoint class provides support for the API operations of the accounts endpoint.

Methods​

GetAccount​

Gets the bank account with the given id.

public async Task<NordigenApiResponse<BankAccount, BasicResponse>>
  GetAccount(Guid id, CancellationToken cancellationToken = default)

Overloaded id parameter using the string type:

public async Task<NordigenApiResponse<BankAccount, BasicResponse>>
  GetAccount(string id, CancellationToken cancellationToken = default)

Parameters​

id - Guid | string​

The id of the account to get.

cancellationToken - CancellationToken​

A token to signal cancellation of the operation.

Returns​

Task<NordigenApiResponse<BankAccount, BasicResponse>>

A NordigenApiResponse which contains the specified account if the request was successful.

GetBalances​

Gets the balances of the specified account.

public async Task<NordigenApiResponse<List<Balance>, AccountsError>>
  GetBalances(Guid accountId, CancellationToken cancellationToken = default)

Overloaded id parameter using the string type:

public async Task<NordigenApiResponse<List<Balance>, AccountsError>>
  GetBalances(Guid accountId, CancellationToken cancellationToken = default)

Parameters​

id - Guid | string​

The id of the account for which to get the balances.

cancellationToken - CancellationToken​

A token to signal cancellation of the operation.

Returns​

Task<NordigenApiResponse<List<Balance>, AccountsError>>

A NordigenApiResponse which contains which contains a list of the balances for the specified account if the request was successful.

GetAccountDetails​

Gets detailed information about the specified bank account.

public async Task<NordigenApiResponse<BankAccountDetails, AccountsError>>
  GetAccountDetails(Guid id, CancellationToken cancellationToken = default)

Overloaded id parameter using the string type:

public async Task<NordigenApiResponse<BankAccountDetails, AccountsError>>
  GetAccountDetails(string id, CancellationToken cancellationToken = default)

Parameters​

id - Guid | string​

The id of the account for which to retrieve the detailed information.

cancellationToken - CancellationToken​

A token to signal cancellation of the operation.

Returns​

Task<NordigenApiResponse<BankAccountDetails, AccountsError>>

A NordigenApiResponse which contains detailed information about the specified account if the request was successful.

GetTransactions​

Gets the transactions of the specified bank account.

public async Task<NordigenApiResponse<AccountTransactions, AccountsError>>
  GetTransactions(Guid id, DateOnly? startDate = null, DateOnly? endDate = null,
        CancellationToken cancellationToken = default)

Overloaded id parameter using the string type:

public async Task<NordigenApiResponse<AccountTransactions, AccountsError>>
  GetTransactions(string id, DateOnly? startDate = null, DateOnly? endDate = null,
        CancellationToken cancellationToken = default)
warning

If you are consuming the .NET Standard version of the library the parameters startDate and endDate will be of type DateTime.

Parameters​

id - Guid | string​

The id of the account for which to retrieve the transactions.

startDate - DateOnly | DateTime​

Optional date to limit the transactions which are returned to those after the specified date.

endDate - DateOnly | DateTime​

Optional date to limit the transactions which are returned to those before the specified date.

cancellationToken - CancellationToken​

A token to signal cancellation of the operation.

Returns​

Task<NordigenApiResponse<AccountTransactions, AccountsError>>

A NordigenApiResponse which contains transaction data of the specified account.