Skip to main content

NordigenApiResponse

The NordigenApiResponse class is the common type for all responses returned from the GoCardless API. Through its Result and Error properties you can access the result of a request.

Properties​

StatusCode - HttpStatusCode​

The status code returned by the API.

IsSuccess - bool​

Indicates whether the HTTP response was successful.

Result - TResult?​

The result returned by the API. Null if the the HTTP response was not successful.

Error - TError?​

The error returned by the API. Null if the HTTP response was successful.

RateLimits - ApiRateLimits​

The rate limits of the GoCardless API.

Constructor​

public NordigenApiResponse(HttpStatusCode statusCode, bool isSuccess,
      TResult? result, TError? apiError,  ApiRateLimits rateLimits)

Parameters​

statusCode - HttpStatusCode​

The status code returned by the API.

isSuccess - bool​

Indicates whether the HTTP response was successful.

result - TResult?​

The result returned by the API. Null if the the HTTP response was not successful.

error - TError?​

The error returned by the API. Null if the HTTP response was successful.

rateLimits - ApiRateLimits​

The rate limits of the GoCardless API.

Handling the NordigenApiResponse type​

To learn more about how to best work with the NordigenApiResponse type see the Handling API responses guide.