Skip to main content

NordigenClient

The NordigenClient class exposes the endpoints of the GoCardless API through its properties. It is used to execute all possible requests and retrieve the results. It also internally manages the JWT tokens used to authenticate with the API.

Properties​

JsonWebTokenPair - JsonWebTokenPair?​

The JWT pair consisting of access and refresh token used to authenticate with the GoCardless API. This property can be used to set the token pair that is used when retrieving a new access/refresh token through the TokenEndpoint.

TokenEndpoint - ITokenEndpoint​

Provides support for the API operations of the tokens endpoint.

InstitutionsEndpoint - IInstitutionsEndpoint​

Provides support for the API operations of the institutions endpoint.

AgreementsEndpoint - IAgreementsEndpoint​

Provides support for the API operations of the agreements endpoint.

RequisitionsEndpoint - IRequisitionsEndpoint​

Provides support for the API operations of the requisitions endpoint.

AccountsEndpoint - IAccountsEndpoint​

Provides support for the API operations of the accounts endpoint.

Events​

TokenPairUpdated - EventHandler<TokenPairUpdatedEventArgs>?​

Raised whenever the JsonWebTokenPair property is successfully updated. When the token is manually updated to be null, this event will not be raised. For more information see Handling Authentication Tokens.

Constructor​

public NordigenClient(HttpClient httpClient, NordigenClientCredentials credentials,
        JsonWebTokenPair? jsonWebTokenPair = null)

Parameters​

httpClient - HttpClient​

The HttpClient instance that should be used to send all requests made by the NordigenClient. You can adjust the BaseAddress of the HttpClient as needed, for details see: Using a different Base Address.

credentials - NordigenClientCredentials​

The credentials you get from the GoCardless Bank Account Data portal (User secrets).

jsonWebTokenPair - JsonWebTokenPair?​

An optional JsonWebTokenPair to reuse from an preceding successful authentication. These may for instance be retrieved from your database.