repo_id
stringlengths 8
105
| file_path
stringlengths 28
162
| content
stringlengths 15
661k
| __index_level_0__
int64 0
0
|
|---|---|---|---|
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\FinancialInstitutions.cs | using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Models;
using Ibanity.Apis.Client.Products.PontoConnect.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <summary>
/// This is an object representing a financial institution, providing its basic details - ID and name. Only the financial institutions corresponding to authorized accounts will be available on the API.
/// </summary>
public class FinancialInstitutions : ResourceClient<FinancialInstitution, object, object, object, Token>, IFinancialInstitutions
{
private const string EntityName = "financial-institutions";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public FinancialInstitutions(IApiClient apiClient, IAccessTokenProvider<Token> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, EntityName)
{ }
/// <inheritdoc />
public Task<IbanityCollection<FinancialInstitution>> ListForOrganization(Token token, IEnumerable<Filter> filters, int? pageSize, Guid? pageBefore, Guid? pageAfter, CancellationToken? cancellationToken) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
filters,
pageSize,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<FinancialInstitution>> ListForOrganization(Token token, ContinuationToken continuationToken, CancellationToken? cancellationToken) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
continuationToken ?? throw new ArgumentNullException(nameof(continuationToken)),
cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<FinancialInstitution>> List(ContinuationToken continuationToken, CancellationToken? cancellationToken) =>
InternalCursorBasedList(
null,
continuationToken ?? throw new ArgumentNullException(nameof(continuationToken)),
cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<FinancialInstitution>> List(IEnumerable<Filter> filters, int? pageSize, Guid? pageBefore, Guid? pageAfter, CancellationToken? cancellationToken) =>
InternalCursorBasedList(
null,
filters,
pageSize,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
public Task<FinancialInstitution> GetForOrganization(Token token, Guid id, CancellationToken? cancellationToken) =>
InternalGet(token, id, cancellationToken);
/// <inheritdoc />
public Task<FinancialInstitution> Get(Guid id, CancellationToken? cancellationToken) =>
GetForOrganization(null, id, cancellationToken);
}
/// <summary>
/// This is an object representing a financial institution, providing its basic details - ID and name. Only the financial institutions corresponding to authorized accounts will be available on the API.
/// </summary>
public interface IFinancialInstitutions
{
/// <summary>
/// List Organization Financial Institutions
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="filters">Attributes to be filtered from the results</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<IbanityCollection<FinancialInstitution>> ListForOrganization(Token token, IEnumerable<Filter> filters = null, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Organization Financial Institutions
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="continuationToken">Token referencing the page to request</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<IbanityCollection<FinancialInstitution>> ListForOrganization(Token token, ContinuationToken continuationToken, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Organization Financial Institution
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="id">Financial institution ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A financial institution resource</returns>
Task<FinancialInstitution> GetForOrganization(Token token, Guid id, CancellationToken? cancellationToken = null);
/// <summary>
/// List Financial Institutions
/// </summary>
/// <param name="filters">Attributes to be filtered from the results</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<IbanityCollection<FinancialInstitution>> List(IEnumerable<Filter> filters = null, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Financial Institutions
/// </summary>
/// <param name="continuationToken">Token referencing the page to request</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<IbanityCollection<FinancialInstitution>> List(ContinuationToken continuationToken, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Financial Institution
/// </summary>
/// <param name="id">Financial institution ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A financial institution resource</returns>
Task<FinancialInstitution> Get(Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\IntegrationAccounts.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.JsonApi;
using Ibanity.Apis.Client.Products.PontoConnect.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <inheritdoc />
public class IntegrationAccounts : ResourceClient<IntegrationAccount, object, IntegrationAccountRelationships, object, ClientAccessToken>, IIntegrationAccounts
{
private readonly IApiClient _apiClient;
private readonly IClientAccessTokenProvider _accessTokenProvider;
private readonly string _urlPrefix;
private const string EntityName = "integration-accounts";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public IntegrationAccounts(IApiClient apiClient, IClientAccessTokenProvider accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, EntityName)
{
_apiClient = apiClient;
_accessTokenProvider = accessTokenProvider;
_urlPrefix = urlPrefix;
}
/// <inheritdoc />
public Task<IbanityCollection<IntegrationAccount>> List(ClientAccessToken token, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
null,
pageSize,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
protected override IntegrationAccount Map(Data<IntegrationAccount, object, IntegrationAccountRelationships, object> data)
{
if (data is null)
throw new ArgumentNullException(nameof(data));
var result = data.Attributes ?? new IntegrationAccount();
result.Id = Guid.Parse(data.Id);
result.AccountId = Guid.Parse(data.Relationships.Organization.Data.Id);
result.FinancialInstitutionId = Guid.Parse(data.Relationships.Organization.Data.Id);
result.OrganizationId = Guid.Parse(data.Relationships.Organization.Data.Id);
return result;
}
}
/// <summary>
/// <p>This is an object representing the link between a user's account and an integration.</p>
/// <p>All accounts linked to your Ponto Connect application are returned by this endpoint.</p>
/// </summary>
public interface IIntegrationAccounts
{
/// <summary>
/// List Integration Accounts
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of integration account resources</returns>
Task<IbanityCollection<IntegrationAccount>> List(ClientAccessToken token, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Integrations.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.PontoConnect.Models;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <inheritdoc />
public class Integrations : IIntegrations
{
private readonly IApiClient _apiClient;
private readonly IClientAccessTokenProvider _accessTokenProvider;
private readonly string _urlPrefix;
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public Integrations(IApiClient apiClient, IClientAccessTokenProvider accessTokenProvider, string urlPrefix)
{
_apiClient = apiClient;
_accessTokenProvider = accessTokenProvider;
_urlPrefix = urlPrefix;
}
/// <inheritdoc />
public async Task<Integration> Delete(ClientAccessToken token, Guid organizationId, CancellationToken? cancellationToken) =>
Map((await _apiClient.Delete<JsonApi.Resource<Integration, object, IntegrationRelationships, object>>(
$"{_urlPrefix}/organizations/{organizationId}/integration",
(await _accessTokenProvider.RefreshToken(token ?? throw new ArgumentNullException(nameof(token))).ConfigureAwait(false)).AccessToken,
cancellationToken ?? CancellationToken.None).ConfigureAwait(false)).Data);
private static Integration Map(JsonApi.Data<Integration, object, IntegrationRelationships, object> data)
{
if (data is null)
throw new ArgumentNullException(nameof(data));
var result = data.Attributes ?? new Integration();
result.Id = Guid.Parse(data.Id);
result.OrganizationId = Guid.Parse(data.Relationships.Organization.Data.Id);
return result;
}
}
/// <summary>
/// This endpoint provides an alternative method to revoke the integration (in addition to the revoke refresh token endpoint). This endpoint remains accessible with a client access token, even if your refresh token is lost or expired.
/// </summary>
public interface IIntegrations
{
/// <summary>
/// Revoke the integration.
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="organizationId">Corresponding organization ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The deleted integration resource</returns>
Task<Integration> Delete(ClientAccessToken token, Guid organizationId, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\OnboardingDetails.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <summary>
/// <para>This is an object representing the onboarding details of the user who will undergo the linking process. It allows you to prefill the sign in or sign up forms with the user's details to streamline their Ponto onboarding process.</para>
/// <para>For security purposes, the onboarding details object will only be available to be linked to a new Ponto user for five minutes following its creation. You should include the id in the access authorization url as an additional query parameter.</para>
/// </summary>
public class OnboardingDetails : IOnboardingDetails
{
private readonly IApiClient _apiClient;
private readonly IClientAccessTokenProvider _accessTokenProvider;
private readonly string _urlPrefix;
private const string EntityName = "onboarding-details";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh client access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public OnboardingDetails(IApiClient apiClient, IClientAccessTokenProvider accessTokenProvider, string urlPrefix)
{
_apiClient = apiClient;
_accessTokenProvider = accessTokenProvider;
_urlPrefix = urlPrefix;
}
/// <inheritdoc />
public async Task<Models.OnboardingDetailsResponse> Create(ClientAccessToken token, Models.OnboardingDetails onboardingDetails, Guid? idempotencyKey, CancellationToken? cancellationToken) =>
Map((await _apiClient.Post<JsonApi.Resource<Models.OnboardingDetails, object, object, object>, JsonApi.Resource<Models.OnboardingDetailsResponse, object, object, object>>(
$"{_urlPrefix}/{EntityName}",
(await _accessTokenProvider.RefreshToken(token ?? throw new ArgumentNullException(nameof(token))).ConfigureAwait(false)).AccessToken,
new JsonApi.Resource<Models.OnboardingDetails, object, object, object>
{
Data = new JsonApi.Data<Models.OnboardingDetails, object, object, object>
{
Type = "onboardingDetails",
Attributes = onboardingDetails
}
},
idempotencyKey ?? Guid.NewGuid(),
cancellationToken ?? CancellationToken.None).ConfigureAwait(false)).Data);
private static Models.OnboardingDetailsResponse Map(JsonApi.Data<Models.OnboardingDetailsResponse, object, object, object> data)
{
if (data is null)
throw new ArgumentNullException(nameof(data));
var result = data.Attributes;
result.Id = Guid.Parse(data.Id);
return result;
}
}
/// <summary>
/// <para>This is an object representing the onboarding details of the user who will undergo the linking process. It allows you to prefill the sign in or sign up forms with the user's details to streamline their Ponto onboarding process.</para>
/// <para>For security purposes, the onboarding details object will only be available to be linked to a new Ponto user for five minutes following its creation. You should include the id in the access authorization url as an additional query parameter.</para>
/// </summary>
public interface IOnboardingDetails
{
/// <summary>
/// Create Onboarding Details
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="onboardingDetails">Onboarding details of the user who will undergo the linking process</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created onboarding details resource</returns>
Task<Models.OnboardingDetailsResponse> Create(ClientAccessToken token, Models.OnboardingDetails onboardingDetails, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\PaymentActivationRequests.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.PontoConnect.Models;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <summary>
/// <para>This is an object representing a payment activation request. If your customer has not yet requested payment activation for their organization (as indicated by the user info endpoint), you can redirect them to Ponto to submit a request for payment activation.</para>
/// <para>When creating the payment activation request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the process. At the end of the flow, they will be returned to the redirect uri that you defined.</para>
/// <para>When using this endpoint in the sandbox, the redirection flow will work but the user will not be prompted to request payment activation as this is enabled by default in the sandbox.</para>
/// </summary>
public class PaymentActivationRequests : ResourceClient<PaymentActivationRequest, object, object, PaymentActivationRequestLinks, Token>, IPaymentActivationRequests
{
private const string EntityName = "payment-activation-requests";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public PaymentActivationRequests(IApiClient apiClient, IAccessTokenProvider<Token> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, EntityName)
{ }
/// <inheritdoc />
public Task<PaymentActivationRequest> Request(Token token, Uri redirect, Guid? idempotencyKey, CancellationToken? cancellationToken)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (redirect is null)
throw new ArgumentNullException(nameof(redirect));
var payload = new JsonApi.Data<PaymentActivationRequest, object, object, object>
{
Type = "paymentActivationRequest",
Attributes = new PaymentActivationRequest { Redirect = redirect }
};
return InternalCreate(token, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<PaymentActivationRequest> Request(Token token, string redirectUri, Guid? idempotencyKey, CancellationToken? cancellationToken)
{
if (string.IsNullOrWhiteSpace(redirectUri))
throw new ArgumentException($"'{nameof(redirectUri)}' cannot be null or whitespace.", nameof(redirectUri));
return Request(
token,
new Uri(redirectUri),
idempotencyKey,
cancellationToken);
}
/// <inheritdoc />
protected override PaymentActivationRequest Map(JsonApi.Data<PaymentActivationRequest, object, object, PaymentActivationRequestLinks> data)
{
if (data.Attributes == null)
data.Attributes = new PaymentActivationRequest();
var result = base.Map(data);
result.Redirect = data.Links?.Redirect;
return result;
}
}
/// <summary>
/// <para>This is an object representing a payment activation request. If your customer has not yet requested payment activation for their organization (as indicated by the user info endpoint), you can redirect them to Ponto to submit a request for payment activation.</para>
/// <para>When creating the payment activation request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the process. At the end of the flow, they will be returned to the redirect uri that you defined.</para>
/// <para>When using this endpoint in the sandbox, the redirection flow will work but the user will not be prompted to request payment activation as this is enabled by default in the sandbox.</para>
/// </summary>
public interface IPaymentActivationRequests
{
/// <summary>
/// Request Payment Activation
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="redirect">URI that your user will be redirected to at the end of the authorization flow</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created payment activation request resource</returns>
Task<PaymentActivationRequest> Request(Token token, Uri redirect, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Request Payment Activation
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="redirectUri">URI that your user will be redirected to at the end of the authorization flow</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created payment activation request resource</returns>
Task<PaymentActivationRequest> Request(Token token, string redirectUri, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Payments.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.PontoConnect.Models;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <summary>
/// <para>This is an object representing a payment. When you want to initiate payment from one of your user's accounts, you have to create one to start the authorization flow.</para>
/// <para>If you provide a redirect URI when creating the payment, you will receive a redirect link to send your customer to to start the authorization flow. Note that for live payments, your user must have already requested and been granted payment service for their organization to use this flow.</para>
/// <para>Otherwise, the user can sign the payment in the Ponto Dashboard.</para>
/// <para>When authorizing payment initiation in the sandbox, you should use the pre-filled credentials and 123456 as the digipass response.</para>
/// </summary>
public class Payments : ResourceWithParentClient<PaymentResponse, object, object, PaymentLinks, Token>, IPayments
{
private const string ParentEntityName = "accounts";
private const string EntityName = "payments";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public Payments(IApiClient apiClient, IAccessTokenProvider<Token> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<PaymentResponse> Create(Token token, Guid accountId, PaymentRequest payment, Guid? idempotencyKey, CancellationToken? cancellationToken)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (payment is null)
throw new ArgumentNullException(nameof(payment));
var payload = new JsonApi.Data<PaymentRequest, object, object, object>
{
Type = "payment",
Attributes = payment
};
return InternalCreate(token, new[] { accountId }, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<PaymentResponse> Get(Token token, Guid accountId, Guid id, CancellationToken? cancellationToken) =>
InternalGet(token, new[] { accountId }, id, cancellationToken);
/// <inheritdoc />
public Task Delete(Token token, Guid accountId, Guid id, CancellationToken? cancellationToken) =>
InternalDelete(token, new[] { accountId }, id, cancellationToken);
/// <inheritdoc />
protected override PaymentResponse Map(JsonApi.Data<PaymentResponse, object, object, PaymentLinks> data)
{
var result = base.Map(data);
result.RedirectUri = data.Links?.RedirectString;
return result;
}
}
/// <summary>
/// <para>This is an object representing a payment. When you want to initiate payment from one of your user's accounts, you have to create one to start the authorization flow.</para>
/// <para>If you provide a redirect URI when creating the payment, you will receive a redirect link to send your customer to to start the authorization flow. Note that for live payments, your user must have already requested and been granted payment service for their organization to use this flow.</para>
/// <para>Otherwise, the user can sign the payment in the Ponto Dashboard.</para>
/// <para>When authorizing payment initiation in the sandbox, you should use the pre-filled credentials and 123456 as the digipass response.</para>
/// </summary>
public interface IPayments
{
/// <summary>
/// Create Payment
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="accountId">Account ID</param>
/// <param name="payment">An object representing a payment</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created payment resource</returns>
Task<PaymentResponse> Create(Token token, Guid accountId, PaymentRequest payment, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Payment
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="accountId">Account ID</param>
/// <param name="id">Payment ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The specified payment resource</returns>
Task<PaymentResponse> Get(Token token, Guid accountId, Guid id, CancellationToken? cancellationToken = null);
/// <summary>
/// Delete Payment
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="accountId">Account ID</param>
/// <param name="id">Payment ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
Task Delete(Token token, Guid accountId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\PontoConnectClient.cs | using Ibanity.Apis.Client.Http;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <inheritdoc cref="IPontoConnectClient" />
public class PontoConnectClient : ProductClient<ITokenProviderWithCodeVerifier>, IPontoConnectClient
{
/// <summary>
/// Product name used as prefix in Ponto Connect URIs.
/// </summary>
public const string UrlPrefix = "ponto-connect";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="tokenService">Service to generate and refresh access tokens</param>
/// <param name="clientAccessTokenService">Service to generate and refresh client access tokens.</param>
/// <param name="customerTokenService">Service to generate and refresh customer access tokens.</param>
public PontoConnectClient(IApiClient apiClient, ITokenProviderWithCodeVerifier tokenService, IClientAccessTokenProvider clientAccessTokenService, ICustomerAccessTokenProvider customerTokenService)
: base(apiClient, tokenService, clientAccessTokenService, customerTokenService)
{
FinancialInstitutions = new FinancialInstitutions(apiClient, tokenService, UrlPrefix);
Accounts = new Accounts(apiClient, tokenService, UrlPrefix);
Transactions = new Transactions(apiClient, tokenService, UrlPrefix);
ReauthorizationRequests = new ReauthorizationRequests(apiClient, tokenService, UrlPrefix);
Payments = new Payments(apiClient, tokenService, UrlPrefix);
BulkPayments = new BulkPayments(apiClient, tokenService, UrlPrefix);
Synchronizations = new Synchronizations(apiClient, tokenService, UrlPrefix);
Sandbox = new Sandbox(apiClient, tokenService, UrlPrefix);
OnboardingDetails = new OnboardingDetails(apiClient, clientAccessTokenService, UrlPrefix);
UserInfo = new UserInfo(apiClient, tokenService, UrlPrefix);
PaymentActivationRequests = new PaymentActivationRequests(apiClient, tokenService, UrlPrefix);
Usages = new Usages(apiClient, clientAccessTokenService, UrlPrefix);
Integrations = new Integrations(apiClient, clientAccessTokenService, UrlPrefix);
IntegrationAccounts = new IntegrationAccounts(apiClient, clientAccessTokenService, UrlPrefix);
}
/// <inheritdoc />
public IFinancialInstitutions FinancialInstitutions { get; }
/// <inheritdoc />
public IAccounts Accounts { get; }
/// <inheritdoc />
public ITransactions Transactions { get; }
/// <inheritdoc />
public IReauthorizationRequests ReauthorizationRequests { get; }
/// <inheritdoc />
public IPayments Payments { get; }
/// <inheritdoc />
public IBulkPayments BulkPayments { get; }
/// <inheritdoc />
public ISynchronizations Synchronizations { get; }
/// <inheritdoc />
public ISandbox Sandbox { get; }
/// <inheritdoc />
public IOnboardingDetails OnboardingDetails { get; }
/// <inheritdoc />
public IUserInfo UserInfo { get; }
/// <inheritdoc />
public IPaymentActivationRequests PaymentActivationRequests { get; }
/// <inheritdoc />
public IUsages Usages { get; }
/// <inheritdoc />
public IIntegrations Integrations { get; }
/// <inheritdoc />
public IIntegrationAccounts IntegrationAccounts { get; }
}
/// <summary>
/// Contains services for all Ponto Connect-related resources.
/// </summary>
public interface IPontoConnectClient : IProductWithRefreshTokenClient<ITokenProviderWithCodeVerifier>
{
/// <summary>
/// This is an object representing a financial institution, providing its basic details - ID and name. Only the financial institutions corresponding to authorized accounts will be available on the API.
/// </summary>
IFinancialInstitutions FinancialInstitutions { get; }
/// <summary>
/// <para>This is an object representing a user's account. This object will provide details about the account, including the balance and the currency.</para>
/// <para>An account has related transactions and belongs to a financial institution.</para>
/// <para>An account may be revoked from an integration using the revoke account endpoint. To recover access, the user must add the account back to the integration in their Ponto Dashboard or in a new authorization flow.</para>
/// </summary>
IAccounts Accounts { get; }
/// <summary>
/// <para>This is an object representing an account transaction. This object will give you the details of the financial transaction, including its amount and description.</para>
/// <para>From this object, you can link back to its account.</para>
/// </summary>
ITransactions Transactions { get; }
/// <summary>
/// <para>This object allows you to request the reauthorization of a specific bank account.</para>
/// <para>By providing a redirect URI, you can create a redirect link to which you can send your customer so they can directly reauthorize their account on Ponto. After reauthorizing at their bank portal, they are redirected automatically back to your application, to the redirect URI of your choosing.</para>
/// </summary>
IReauthorizationRequests ReauthorizationRequests { get; }
/// <summary>
/// <para>This is an object representing a payment. When you want to initiate payment from one of your user's accounts, you have to create one to start the authorization flow.</para>
/// <para>If you provide a redirect URI when creating the payment, you will receive a redirect link to send your customer to to start the authorization flow. Note that for live payments, your user must have already requested and been granted payment service for their organization to use this flow.</para>
/// <para>Otherwise, the user can sign the payment in the Ponto Dashboard.</para>
/// <para>When authorizing payment initiation in the sandbox, you should use the pre-filled credentials and 123456 as the digipass response.</para>
/// </summary>
IPayments Payments { get; }
/// <summary>
/// <para>This is an object representing a bulk payment. When you want to initiate a bulk payment from one of your user's accounts, you have to create one to start the authorization flow.</para>
/// <para>If you provide a redirect URI when creating the bulk payment, you will receive a redirect link to send your customer to to start the authorization flow. Note that for live bulk payments, your user must have already requested and been granted payment service for their organization to use this flow.</para>
/// <para>Otherwise, the user can sign the bulk payment in the Ponto Dashboard.</para>
/// <para>When authorizing bulk payment initiation in the sandbox, you should use the pre-filled credentials and 123456 as the digipass response.</para>
/// </summary>
IBulkPayments BulkPayments { get; }
/// <summary>
/// This is an object representing a resource synchronization. This object will give you the details of the synchronization, including its resource, type, and status.
/// </summary>
ISynchronizations Synchronizations { get; }
/// <summary>
/// Fake accounts and transactions.
/// </summary>
ISandbox Sandbox { get; }
/// <summary>
/// <para>This is an object representing the onboarding details of the user who will undergo the linking process. It allows you to prefill the sign in or sign up forms with the user's details to streamline their Ponto onboarding process.</para>
/// <para>For security purposes, the onboarding details object will only be available to be linked to a new Ponto user for five minutes following its creation. You should include the id in the access authorization url as an additional query parameter.</para>
/// </summary>
IOnboardingDetails OnboardingDetails { get; }
/// <summary>
/// <para>This endpoint provides information about the subject (organization) of an access token. Minimally, it provides the organization's id as the token's sub. If additional organization information was requested in the scope of the authorization, it will be provided here.</para>
/// <para>The organization's id can be used to request its usage. Keep in mind that if the access token is revoked, this endpoint will no longer be available, so you may want to store the organization's id in your system.</para>
/// </summary>
IUserInfo UserInfo { get; }
/// <summary>
/// <para>This is an object representing a payment activation request. If your customer has not yet requested payment activation for their organization (as indicated by the user info endpoint), you can redirect them to Ponto to submit a request for payment activation.</para>
/// <para>When creating the payment activation request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the process. At the end of the flow, they will be returned to the redirect uri that you defined.</para>
/// <para>When using this endpoint in the sandbox, the redirection flow will work but the user will not be prompted to request payment activation as this is enabled by default in the sandbox.</para>
/// </summary>
IPaymentActivationRequests PaymentActivationRequests { get; }
/// <summary>
/// This endpoint provides the usage of your integration by the provided organization during a given month. In order to continue to allow access to this information if an integration is revoked, you must use a client access token for this endpoint.
/// </summary>
IUsages Usages { get; }
/// <summary>
/// This endpoint provides an alternative method to revoke the integration (in addition to the revoke refresh token endpoint). This endpoint remains accessible with a client access token, even if your refresh token is lost or expired.
/// </summary>
IIntegrations Integrations { get; }
/// <summary>
/// <p>This is an object representing the link between a user's account and an integration.</p>
/// <p>All accounts linked to your Ponto Connect application are returned by this endpoint.</p>
/// </summary>
IIntegrationAccounts IntegrationAccounts { get; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\ReauthorizationRequests.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.PontoConnect.Models;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <summary>
/// <para>This object allows you to request the reauthorization of a specific bank account.</para>
/// <para>By providing a redirect URI, you can create a redirect link to which you can send your customer so they can directly reauthorize their account on Ponto. After reauthorizing at their bank portal, they are redirected automatically back to your application, to the redirect URI of your choosing.</para>
/// </summary>
public class ReauthorizationRequests : ResourceWithParentClient<ReauthorizationRequest, object, object, ReauthorizationRequestLinks, Token>, IReauthorizationRequests
{
private const string ParentEntityName = "accounts";
private const string EntityName = "reauthorization-requests";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public ReauthorizationRequests(IApiClient apiClient, IAccessTokenProvider<Token> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<ReauthorizationRequest> Create(Token token, Guid accountId, Uri redirect, Guid? idempotencyKey, CancellationToken? cancellationToken)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (redirect is null)
throw new ArgumentNullException(nameof(redirect));
var payload = new JsonApi.Data<ReauthorizationRequest, object, object, object>
{
Type = "reauthorizationRequest",
Attributes = new ReauthorizationRequest { Redirect = redirect }
};
return InternalCreate(token, new[] { accountId }, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<ReauthorizationRequest> Create(Token token, Guid accountId, string redirectUri, Guid? idempotencyKey, CancellationToken? cancellationToken)
{
if (string.IsNullOrWhiteSpace(redirectUri))
throw new ArgumentException($"'{nameof(redirectUri)}' cannot be null or whitespace.", nameof(redirectUri));
return Create(
token,
accountId,
new Uri(redirectUri),
idempotencyKey,
cancellationToken);
}
/// <inheritdoc />
protected override ReauthorizationRequest Map(JsonApi.Data<ReauthorizationRequest, object, object, ReauthorizationRequestLinks> data)
{
var result = base.Map(data);
result.Redirect = data.Links.Redirect;
return result;
}
}
/// <summary>
/// <para>This object allows you to request the reauthorization of a specific bank account.</para>
/// <para>By providing a redirect URI, you can create a redirect link to which you can send your customer so they can directly reauthorize their account on Ponto. After reauthorizing at their bank portal, they are redirected automatically back to your application, to the redirect URI of your choosing.</para>
/// </summary>
public interface IReauthorizationRequests
{
/// <summary>
/// Request Account Reauthorization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="accountId">Bank account ID</param>
/// <param name="redirect">URI that your user will be redirected to at the end of the authorization flow</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created reauthorization request resource</returns>
Task<ReauthorizationRequest> Create(Token token, Guid accountId, Uri redirect, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Request Account Reauthorization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="accountId">Bank account ID</param>
/// <param name="redirectUri">URI that your user will be redirected to at the end of the authorization flow</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created reauthorization request resource</returns>
Task<ReauthorizationRequest> Create(Token token, Guid accountId, string redirectUri, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Sandbox.cs | using Ibanity.Apis.Client.Http;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <inheritdoc />
public class Sandbox : ISandbox
{
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public Sandbox(IApiClient apiClient, IAccessTokenProvider<Token> accessTokenProvider, string urlPrefix)
{
Accounts = new SandboxAccounts(apiClient, accessTokenProvider, urlPrefix);
Transactions = new SandboxTransactions(apiClient, accessTokenProvider, urlPrefix);
}
/// <inheritdoc />
public ISandboxAccounts Accounts { get; }
/// <inheritdoc />
public ISandboxTransactions Transactions { get; }
}
/// <summary>
/// Fake accounts and transactions.
/// </summary>
public interface ISandbox
{
/// <summary>
/// <para>This is an object representing a financial institution account, a fake account you can use for test purposes in a sandbox integration.</para>
/// <para>These sandbox accounts are available only to the related organization, and can be authorized in the Ponto dashboard.</para>
/// <para>A financial institution account belongs to a financial institution and can have many associated financial institution transactions.</para>
/// </summary>
ISandboxAccounts Accounts { get; }
/// <summary>
/// <para>This is an object representing a financial institution transaction, a fake transaction on a fake account you can create for test purposes.</para>
/// <para>Once the account corresponding to the financial institution account has been synchronized, your custom financial institution transactions will be visible in the transactions list.</para>
/// </summary>
ISandboxTransactions Transactions { get; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\SandboxAccounts.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.PontoConnect.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <summary>
/// <para>This is an object representing a financial institution account, a fake account you can use for test purposes in a sandbox integration.</para>
/// <para>These sandbox accounts are available only to the related organization, and can be authorized in the Ponto dashboard.</para>
/// <para>A financial institution account belongs to a financial institution and can have many associated financial institution transactions.</para>
/// </summary>
public class SandboxAccounts : ResourceWithParentClient<SandboxAccount, object, object, object, Token>, ISandboxAccounts
{
private const string ParentEntityName = "sandbox/financial-institutions";
private const string EntityName = "financial-institution-accounts";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public SandboxAccounts(IApiClient apiClient, IAccessTokenProvider<Token> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<IbanityCollection<SandboxAccount>> List(Token token, Guid financialInstitutionId, int? pageSize, Guid? pageBefore, Guid? pageAfter, CancellationToken? cancellationToken) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
new[] { financialInstitutionId },
null,
pageSize,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<SandboxAccount>> List(Token token, ContinuationToken continuationToken, CancellationToken? cancellationToken) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
continuationToken ?? throw new ArgumentNullException(nameof(continuationToken)),
cancellationToken);
/// <inheritdoc />
public Task<SandboxAccount> Get(Token token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken) =>
InternalGet(token, new[] { financialInstitutionId }, id, cancellationToken);
}
/// <summary>
/// <para>This is an object representing a financial institution account, a fake account you can use for test purposes in a sandbox integration.</para>
/// <para>These sandbox accounts are available only to the related organization, and can be authorized in the Ponto dashboard.</para>
/// <para>A financial institution account belongs to a financial institution and can have many associated financial institution transactions.</para>
/// </summary>
public interface ISandboxAccounts
{
/// <summary>
/// List Financial Institution Accounts
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution account resources</returns>
Task<IbanityCollection<SandboxAccount>> List(Token token, Guid financialInstitutionId, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Financial Institution Accounts
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="continuationToken">Token referencing the page to request</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution account resources</returns>
Task<IbanityCollection<SandboxAccount>> List(Token token, ContinuationToken continuationToken, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Financial Institution Account
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="id">Financial institution account ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The specified financial institution account resource</returns>
Task<SandboxAccount> Get(Token token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\SandboxTransactions.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.PontoConnect.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <summary>
/// <para>This is an object representing a financial institution transaction, a fake transaction on a fake account you can create for test purposes.</para>
/// <para>Once the account corresponding to the financial institution account has been synchronized, your custom financial institution transactions will be visible in the transactions list.</para>
/// </summary>
public class SandboxTransactions : ResourceWithParentClient<SandboxTransaction, object, object, object, Token>, ISandboxTransactions
{
private const string TopLevelParentEntityName = "sandbox/financial-institutions";
private const string ParentEntityName = "financial-institution-accounts";
private const string EntityName = "financial-institution-transactions";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public SandboxTransactions(IApiClient apiClient, IAccessTokenProvider<Token> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { TopLevelParentEntityName, ParentEntityName, EntityName })
{
}
/// <inheritdoc />
public Task<IbanityCollection<SandboxTransaction>> List(Token token, Guid financialInstitutionId, Guid accountId, int? pageSize, Guid? pageBefore, Guid? pageAfter, CancellationToken? cancellationToken) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
new[] { financialInstitutionId, accountId },
null,
pageSize,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<SandboxTransaction>> List(Token token, ContinuationToken continuationToken, CancellationToken? cancellationToken) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
continuationToken ?? throw new ArgumentNullException(nameof(continuationToken)),
cancellationToken);
/// <inheritdoc />
public Task<SandboxTransaction> Get(Token token, Guid financialInstitutionId, Guid accountId, Guid id, CancellationToken? cancellationToken) =>
InternalGet(token, new[] { financialInstitutionId, accountId }, id, cancellationToken);
/// <inheritdoc />
public Task<SandboxTransaction> Create(Token token, Guid financialInstitutionId, Guid accountId, Transaction transaction, Guid? idempotencyKey, CancellationToken? cancellationToken)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (transaction is null)
throw new ArgumentNullException(nameof(transaction));
var payload = new JsonApi.Data<Transaction, object, object, object>
{
Type = "financialInstitutionTransaction",
Attributes = transaction
};
return InternalCreate(token, new[] { financialInstitutionId, accountId }, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<SandboxTransaction> Update(Token token, Guid financialInstitutionId, Guid accountId, Guid id, Transaction transaction, Guid? idempotencyKey, CancellationToken? cancellationToken)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (transaction is null)
throw new ArgumentNullException(nameof(transaction));
var payload = new JsonApi.Data<Transaction, object, object, object>
{
Type = "financialInstitutionTransaction",
Attributes = transaction
};
return InternalUpdate(token, new[] { financialInstitutionId, accountId }, id, payload, idempotencyKey, cancellationToken);
}
}
/// <summary>
/// <para>This is an object representing a financial institution transaction, a fake transaction on a fake account you can create for test purposes.</para>
/// <para>Once the account corresponding to the financial institution account has been synchronized, your custom financial institution transactions will be visible in the transactions list.</para>
/// </summary>
public interface ISandboxTransactions
{
/// <summary>
/// List Financial Institution Transactions
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountId">Account ID</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution transaction resources</returns>
Task<IbanityCollection<SandboxTransaction>> List(Token token, Guid financialInstitutionId, Guid accountId, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Financial Institution Transactions
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="continuationToken">Token referencing the page to request</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution transaction resources</returns>
Task<IbanityCollection<SandboxTransaction>> List(Token token, ContinuationToken continuationToken, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Financial Institution Transaction
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountId">Account ID</param>
/// <param name="id">Financial institution transaction ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The specified financial institution transaction resource</returns>
Task<SandboxTransaction> Get(Token token, Guid financialInstitutionId, Guid accountId, Guid id, CancellationToken? cancellationToken = null);
/// <summary>
/// Create Financial Institution Transaction
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountId">Account ID</param>
/// <param name="transaction">An object representing a financial institution transaction</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created financial institution transaction resource</returns>
Task<SandboxTransaction> Create(Token token, Guid financialInstitutionId, Guid accountId, Transaction transaction, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Update Financial Institution Transaction
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountId">Account ID</param>
/// <param name="id">Financial institution transaction ID</param>
/// <param name="transaction">An object representing a financial institution transaction</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The updated financial institution transaction resource</returns>
Task<SandboxTransaction> Update(Token token, Guid financialInstitutionId, Guid accountId, Guid id, Transaction transaction, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Synchronizations.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.PontoConnect.Models;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <summary>
/// This is an object representing a resource synchronization. This object will give you the details of the synchronization, including its resource, type, and status.
/// </summary>
public class Synchronizations : ResourceClient<Synchronization, object, object, object, Token>, ISynchronizations
{
private const string EntityName = "synchronizations";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public Synchronizations(IApiClient apiClient, IAccessTokenProvider<Token> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, EntityName)
{ }
/// <inheritdoc />
public Task<Synchronization> Create(Token token, SynchronizationRequest synchronization, Guid? idempotencyKey, CancellationToken? cancellationToken)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (synchronization is null)
throw new ArgumentNullException(nameof(synchronization));
var payload = new JsonApi.Data<SynchronizationRequest, object, object, object>
{
Type = "synchronization",
Attributes = synchronization
};
return InternalCreate(token, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<Synchronization> Get(Token token, Guid id, CancellationToken? cancellationToken) =>
InternalGet(token, id, cancellationToken);
}
/// <summary>
/// This is an object representing a resource synchronization. This object will give you the details of the synchronization, including its resource, type, and status.
/// </summary>
public interface ISynchronizations
{
/// <summary>
/// Create Synchronization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="synchronization">Details of the synchronization, including its resource, type, and status</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A synchronization resource</returns>
Task<Synchronization> Create(Token token, SynchronizationRequest synchronization, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Synchronization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="id">ID of the synchronization</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A synchronization resource</returns>
Task<Synchronization> Get(Token token, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Transactions.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.PontoConnect.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <summary>
/// <para>This is an object representing an account transaction. This object will give you the details of the financial transaction, including its amount and description.</para>
/// <para>From this object, you can link back to its account.</para>
/// </summary>
public class Transactions : ResourceWithParentClient<TransactionResponse, object, TransactionRelationships, object, Token>, ITransactions
{
private const string ParentEntityName = "accounts";
private const string EntityName = "transactions";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public Transactions(IApiClient apiClient, IAccessTokenProvider<Token> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<IbanityCollection<TransactionResponse>> List(Token token, Guid accountId, int? pageSize, Guid? pageBefore, Guid? pageAfter, CancellationToken? cancellationToken) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
new[] { accountId },
null,
pageSize,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<TransactionResponse>> List(Token token, ContinuationToken continuationToken, CancellationToken? cancellationToken) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
continuationToken ?? throw new ArgumentNullException(nameof(continuationToken)),
cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<TransactionResponse>> ListUpdatedForSynchronization(Token token, Guid synchronizationId, int? pageSize, Guid? pageBefore, Guid? pageAfter, CancellationToken? cancellationToken) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
$"{UrlPrefix}/synchronizations/{synchronizationId}/updated-transactions",
null,
pageSize,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<TransactionResponse>> ListUpdatedForSynchronization(Token token, ContinuationToken continuationToken, CancellationToken? cancellationToken) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
continuationToken ?? throw new ArgumentNullException(nameof(continuationToken)),
cancellationToken);
/// <inheritdoc />
public Task<TransactionResponse> Get(Token token, Guid accountId, Guid id, CancellationToken? cancellationToken) =>
InternalGet(token, new[] { accountId }, id, cancellationToken);
/// <inheritdoc />
protected override TransactionResponse Map(JsonApi.Data<TransactionResponse, object, TransactionRelationships, object> data)
{
var result = base.Map(data);
result.AccountId = Guid.Parse(data.Relationships.Account.Data.Id);
return result;
}
}
/// <summary>
/// <para>This is an object representing an account transaction. This object will give you the details of the financial transaction, including its amount and description.</para>
/// <para>From this object, you can link back to its account.</para>
/// </summary>
public interface ITransactions
{
/// <summary>
/// List Transactions
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="accountId">Bank account ID</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of transaction resources</returns>
Task<IbanityCollection<TransactionResponse>> List(Token token, Guid accountId, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Transactions
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="continuationToken">Token referencing the page to request</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of transaction resources</returns>
Task<IbanityCollection<TransactionResponse>> List(Token token, ContinuationToken continuationToken, CancellationToken? cancellationToken = null);
/// <summary>
/// List Transactions updated during the synchronization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="synchronizationId">Synchronization ID</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of transaction resources updated during the synchronization</returns>
Task<IbanityCollection<TransactionResponse>> ListUpdatedForSynchronization(Token token, Guid synchronizationId, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Transactions updated during the synchronization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="continuationToken">Token referencing the page to request</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of transaction resources updated during the synchronization</returns>
Task<IbanityCollection<TransactionResponse>> ListUpdatedForSynchronization(Token token, ContinuationToken continuationToken, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Transaction
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="accountId">Bank account ID</param>
/// <param name="id">Transaction ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The specified transaction resource</returns>
Task<TransactionResponse> Get(Token token, Guid accountId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Usages.cs | using System;
using System.Globalization;
using System.Text.RegularExpressions;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.PontoConnect.Models;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <inheritdoc />
public class Usages : IUsages
{
private static readonly Regex MonthPattern = new Regex(
@"^(?<year>\d{4})-(?<month>\d{2})$",
RegexOptions.Compiled
);
private readonly IApiClient _apiClient;
private readonly IClientAccessTokenProvider _accessTokenProvider;
private readonly string _urlPrefix;
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public Usages(IApiClient apiClient, IClientAccessTokenProvider accessTokenProvider, string urlPrefix)
{
_apiClient = apiClient;
_accessTokenProvider = accessTokenProvider;
_urlPrefix = urlPrefix;
}
/// <inheritdoc />
public async Task<Usage> Get(ClientAccessToken token, Guid organizationId, int year, int month, CancellationToken? cancellationToken) =>
Map((await _apiClient.Get<JsonApi.Resource<Usage, object, UsageRelationships, object>>(
$"{_urlPrefix}/organizations/{organizationId}/usage/{year:D4}-{month:D2}",
(await _accessTokenProvider.RefreshToken(token ?? throw new ArgumentNullException(nameof(token))).ConfigureAwait(false)).AccessToken,
cancellationToken ?? CancellationToken.None).ConfigureAwait(false)).Data);
private static Usage Map(JsonApi.Data<Usage, object, UsageRelationships, object> data)
{
if (data is null)
throw new ArgumentNullException(nameof(data));
var result = data.Attributes;
var (year, month) = ParseMonth(data.Id);
result.Year = year;
result.Month = month;
result.OrganizationId = Guid.Parse(data.Relationships.Organization.Data.Id);
return result;
}
private static (int, int) ParseMonth(string month)
{
var match = MonthPattern.Match(month);
if (!match.Success)
throw new IbanityException("Invalid month: " + month);
return (
int.Parse(match.Groups["year"].Value, CultureInfo.InvariantCulture),
int.Parse(match.Groups["month"].Value, CultureInfo.InvariantCulture)
);
}
}
/// <summary>
/// This endpoint provides the usage of your integration by the provided organization during a given month. In order to continue to allow access to this information if an integration is revoked, you must use a client access token for this endpoint.
/// </summary>
public interface IUsages
{
/// <summary>
/// Get Organization Usage
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="organizationId">Corresponding organization ID</param>
/// <param name="year">Year to get usage for</param>
/// <param name="month">Month to get usage for</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The account and payment usage of the organization's integration for the provided month</returns>
Task<Usage> Get(ClientAccessToken token, Guid organizationId, int year, int month, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\UserInfo.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
namespace Ibanity.Apis.Client.Products.PontoConnect
{
/// <inheritdoc />
public class UserInfo : IUserInfo
{
private const string EntityName = "userinfo";
private readonly IApiClient _apiClient;
private readonly IAccessTokenProvider<Token> _accessTokenProvider;
private readonly string _urlPrefix;
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public UserInfo(IApiClient apiClient, IAccessTokenProvider<Token> accessTokenProvider, string urlPrefix)
{
_apiClient = apiClient;
_accessTokenProvider = accessTokenProvider;
_urlPrefix = urlPrefix;
}
/// <inheritdoc />
public async Task<Models.UserInfo> Get(Token token, CancellationToken? cancellationToken) =>
await _apiClient.Get<Models.UserInfo>(
$"{_urlPrefix}/{EntityName}",
(await _accessTokenProvider.RefreshToken(token ?? throw new ArgumentNullException(nameof(token))).ConfigureAwait(false)).AccessToken,
cancellationToken ?? CancellationToken.None).ConfigureAwait(false);
}
/// <summary>
/// <para>This endpoint provides information about the subject (organization) of an access token. Minimally, it provides the organization's id as the token's sub. If additional organization information was requested in the scope of the authorization, it will be provided here.</para>
/// <para>The organization's id can be used to request its usage. Keep in mind that if the access token is revoked, this endpoint will no longer be available, so you may want to store the organization's id in your system.</para>
/// </summary>
public interface IUserInfo
{
/// <summary>
/// Get User Info
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The subject of the access token, which is the organization's id, and any other attributes authorized in the scope of the token</returns>
Task<Models.UserInfo> Get(Token token, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\Account.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// <para>This is an object representing a user's account. This object will provide details about the account, including the balance and the currency.</para>
/// <para>An account has related transactions and belongs to a financial institution.</para>
/// <para>An account may be revoked from an integration using the revoke account endpoint. To recover access, the user must add the account back to the integration in their Ponto Dashboard or in a new authorization flow.</para>
/// </summary>
[DataContract]
public class Account
{
/// <summary>
/// When the account was authorized for the last time
/// </summary>
/// <value>When the account was authorized for the last time</value>
[DataMember(Name = "authorizedAt", EmitDefaultValue = false)]
public DateTimeOffset? AuthorizedAt { get; set; }
/// <summary>
/// When the authorization towards the account is expected to end
/// </summary>
/// <value>When the authorization towards the account is expected to end</value>
[DataMember(Name = "authorizationExpirationExpectedAt", EmitDefaultValue = false)]
public DateTimeOffset? AuthorizationExpirationExpectedAt { get; set; }
/// <summary>
/// Type of financial institution account. Can be <code>checking</code>, <code>savings</code>, <code>securities</code>, <code>card</code> or <code>psp</code>
/// </summary>
/// <value>Type of financial institution account. Can be <code>checking</code>, <code>savings</code>, <code>securities</code>, <code>card</code> or <code>psp</code></value>
[DataMember(Name = "subtype", EmitDefaultValue = false)]
public string Subtype { get; set; }
/// <summary>
/// Type of financial institution reference (can be <code>IBAN</code>, <code>BBAN</code>, <code>email</code>, <code>PAN</code>, <code>MASKEDPAN</code> or <code>MSISDN</code>)
/// </summary>
/// <value>Type of financial institution reference (can be <code>IBAN</code>, <code>BBAN</code>, <code>email</code>, <code>PAN</code>, <code>MASKEDPAN</code> or <code>MSISDN</code>)</value>
[DataMember(Name = "referenceType", EmitDefaultValue = false)]
public string ReferenceType { get; set; }
/// <summary>
/// Financial institution's internal reference for this financial institution account
/// </summary>
/// <value>Financial institution's internal reference for this financial institution account</value>
[DataMember(Name = "reference", EmitDefaultValue = false)]
public string Reference { get; set; }
/// <summary>
/// Name of the account product
/// </summary>
/// <value>Name of the account product</value>
[DataMember(Name = "product", EmitDefaultValue = false)]
public string Product { get; set; }
/// <summary>
/// Name of the account holder
/// </summary>
/// <value>Name of the account holder</value>
[DataMember(Name = "holderName", EmitDefaultValue = false)]
public string HolderName { get; set; }
/// <summary>
/// Description of the financial institution account
/// </summary>
/// <value>Description of the financial institution account</value>
[DataMember(Name = "description", EmitDefaultValue = false)]
public string Description { get; set; }
/// <summary>
/// Reference date of the current balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>Reference date of the current balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "currentBalanceReferenceDate", EmitDefaultValue = false)]
public DateTimeOffset? CurrentBalanceReferenceDate { get; set; }
/// <summary>
/// When the current balance was changed for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When the current balance was changed for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "currentBalanceChangedAt", EmitDefaultValue = false)]
public DateTimeOffset? CurrentBalanceChangedAt { get; set; }
/// <summary>
/// Total funds currently in the financial institution account
/// </summary>
/// <value>Total funds currently in the financial institution account</value>
[DataMember(Name = "currentBalance", EmitDefaultValue = false)]
public decimal CurrentBalance { get; set; }
/// <summary>
/// Currency of the financial institution account, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format
/// </summary>
/// <value>Currency of the financial institution account, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format</value>
[DataMember(Name = "currency", EmitDefaultValue = false)]
public string Currency { get; set; }
/// <summary>
/// Reference date of the available balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>Reference date of the available balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "availableBalanceReferenceDate", EmitDefaultValue = false)]
public DateTimeOffset? AvailableBalanceReferenceDate { get; set; }
/// <summary>
/// When the available balance was changed for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When the available balance was changed for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "availableBalanceChangedAt", EmitDefaultValue = false)]
public DateTimeOffset? AvailableBalanceChangedAt { get; set; }
/// <summary>
/// Amount of financial institution account funds that can be accessed immediately
/// </summary>
/// <value>Amount of financial institution account funds that can be accessed immediately</value>
[DataMember(Name = "availableBalance", EmitDefaultValue = false)]
public decimal AvailableBalance { get; set; }
/// <summary>
/// Short string representation.
/// </summary>
/// <returns>Short string representation</returns>
public override string ToString() => $"{Reference} ({CurrentBalance} {Currency})";
}
/// <inheritdoc cref="Account" />
[DataContract]
public class AccountResponse : Account, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// When this account was last synchronized.
/// </summary>
public DateTimeOffset SynchronizedAt { get; set; }
/// <summary>
/// Details of the most recently completed (with success or error) synchronization of the account
/// </summary>
public Synchronization LatestSynchronization { get; set; }
/// <summary>
/// <para>Indicates the availability of the account. The possible values are:</para>
/// <para>available (default)</para>
/// <para>readonly if the financial institution is undertaking maintenance and cannot be reached. Existing data is available but you cannot, for example, synchronize the account until the maintenance is complete</para>
/// </summary>
public string Availability { get; set; }
}
/// <summary>
/// Account metadata
/// </summary>
[DataContract]
public class AccountMeta
{
/// <summary>
/// When this account was last synchronized.
/// </summary>
[DataMember(Name = "synchronizedAt", EmitDefaultValue = false)]
public DateTimeOffset SynchronizedAt { get; set; }
/// <summary>
/// Details of the most recently completed (with success or error) synchronization of the account
/// </summary>
[DataMember(Name = "latestSynchronization", EmitDefaultValue = false)]
public JsonApi.Data<Synchronization, object, object, object> LatestSynchronization { get; set; }
/// <summary>
/// <para>Indicates the availability of the account. The possible values are:</para>
/// <para>available (default)</para>
/// <para>readonly if the financial institution is undertaking maintenance and cannot be reached. Existing data is available but you cannot, for example, synchronize the account until the maintenance is complete</para>
/// </summary>
[DataMember(Name = "availability", EmitDefaultValue = false)]
public string Availability { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\BulkPayment.cs | using System;
using System.Collections.Generic;
using System.Globalization;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// <para>This is an object representing a bulk payment. When you want to initiate a bulk payment from one of your user's accounts, you have to create one to start the authorization flow.</para>
/// <para>If you provide a redirect URI when creating the bulk payment, you will receive a redirect link to send your customer to to start the authorization flow. Note that for live bulk payments, your user must have already requested and been granted payment service for their organization to use this flow.</para>
/// <para>Otherwise, the user can sign the bulk payment in the Ponto Dashboard.</para>
/// <para>When authorizing bulk payment initiation in the sandbox, you should use the pre-filled credentials and 123456 as the digipass response.</para>
/// </summary>
[DataContract]
public abstract class BulkPayment
{
/// <summary>
/// Your identifier for the bulk payment, displayed to the user in the Ponto dashboard
/// </summary>
/// <value>Your identifier for the bulk payment, displayed to the user in the Ponto dashboard</value>
[DataMember(Name = "reference", IsRequired = true, EmitDefaultValue = false)]
public string Reference { get; set; }
/// <summary>
/// A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/ponto-connect/api#financial-institution-attributes'>financial institution attributes</a>
/// </summary>
/// <value>A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/ponto-connect/api#financial-institution-attributes'>financial institution attributes</a></value>
[DataMember(Name = "requestedExecutionDate", EmitDefaultValue = false)]
public string RequestedExecutionDateString
{
get => RequestedExecutionDate.HasValue
? RequestedExecutionDate.Value.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture)
: null;
set => RequestedExecutionDate = !string.IsNullOrWhiteSpace(value)
? (DateTimeOffset?)DateTimeOffset.Parse(value, CultureInfo.InvariantCulture)
: null;
}
/// <summary>
/// A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/ponto-connect/api#financial-institution-attributes'>financial institution attributes</a>
/// </summary>
/// <value>A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/ponto-connect/api#financial-institution-attributes'>financial institution attributes</a></value>
public DateTimeOffset? RequestedExecutionDate { get; set; }
/// <summary>
/// <p>Indicates whether the bulk payment transactions should be grouped into one booking entry by the financial institution instead of individual transactions.</p><p>This is a preference that may or may not be taken into account by the financial institution based on availability and the customer's bulk payment contract.</p><p>Defaults to <code>false</code></p>
/// </summary>
/// <value><p>Indicates whether the bulk payment transactions should be grouped into one booking entry by the financial institution instead of individual transactions.</p><p>This is a preference that may or may not be taken into account by the financial institution based on availability and the customer's bulk payment contract.</p><p>Defaults to <code>false</code></p></value>
[DataMember(Name = "batchBookingPreferred", EmitDefaultValue = true)]
public bool BatchBookingPreferred { get; set; }
/// <summary>
/// TBD
/// </summary>
/// <value>TBD</value>
[DataMember(Name = "endToEndId", EmitDefaultValue = true)]
public string EndToEndId { get; set; }
/// <summary>
/// Short string representation.
/// </summary>
/// <returns>Short string representation</returns>
public override string ToString() => Reference;
}
/// <inheritdoc />
public class BulkPaymentRequest : BulkPayment
{
/// <summary>
/// URI that your user will be redirected to at the end of the authorization flow.</a>
/// </summary>
/// <value>URI that your user will be redirected to at the end of the authorization flow.</a></value>
[DataMember(Name = "redirectUri", EmitDefaultValue = false)]
public string RedirectUri { get; set; }
/// <summary>
/// <p>List of payment attribute objects to be included in the bulk payment.</p><p>Required attributes are <code>currency</code> (currently must be <code>EUR</code>), <code>amount</code>, <code>creditorName</code>, <code>creditorAccountReference</code>, and <code>creditorAccountReferenceType</code>.</p><p>Optional attributes are <code>remittanceInformation</code>, <code>remittanceInformationType</code>, <code>creditorAgent</code>, and <code>creditorAgentType</code>.</p><p>For more information see the <a href='https://documentation.ibanity.com/ponto-connect/api#create-payment-attributes'>create payment attributes</a></p>
/// </summary>
/// <value><p>List of payment attribute objects to be included in the bulk payment.</p><p>Required attributes are <code>currency</code> (currently must be <code>EUR</code>), <code>amount</code>, <code>creditorName</code>, <code>creditorAccountReference</code>, and <code>creditorAccountReferenceType</code>.</p><p>Optional attributes are <code>remittanceInformation</code>, <code>remittanceInformationType</code>, <code>creditorAgent</code>, and <code>creditorAgentType</code>.</p><p>For more information see the <a href='https://documentation.ibanity.com/ponto-connect/api#create-payment-attributes'>create payment attributes</a></p></value>
[DataMember(Name = "payments", IsRequired = true, EmitDefaultValue = false)]
public List<Payment> Payments { get; set; }
}
/// <inheritdoc cref="BulkPayment" />
[DataContract]
public class BulkPaymentResponse : BulkPayment, IIdentified<Guid>
{
/// <summary>
/// Current status of the bulk payment.
/// </summary>
/// <value>Current status of the bulk payment.</value>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
/// <value>URI to redirect to from your customer frontend to conduct the authorization flow.</value>
[DataMember(Name = "redirectUri", EmitDefaultValue = false)]
public string RedirectUri { get; set; }
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
/// <value>URI to redirect to from your customer frontend to conduct the authorization flow.</value>
public Uri Redirect => string.IsNullOrWhiteSpace(RedirectUri)
? null
: new Uri(RedirectUri);
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\FinancialInstitution.cs | using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// This is an object representing a financial institution, providing its basic details - ID and name. Only the financial institutions corresponding to authorized accounts will be available on the API.
/// </summary>
[DataContract]
public class FinancialInstitution : Identified<Guid>
{
/// <summary>
/// Availability of the connection (experimental, beta, stable)
/// </summary>
/// <value>Availability of the connection (experimental, beta, stable)</value>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
/// <summary>
/// Attribute used to group multiple individual financial institutions in the same country
/// </summary>
/// <value>Attribute used to group multiple individual financial institutions in the same country</value>
[DataMember(Name = "sharedBrandReference", EmitDefaultValue = false)]
public Object SharedBrandReference { get; set; }
/// <summary>
/// Customer-friendly name of the financial institution's shared brand, if it is a member of one
/// </summary>
/// <value>Customer-friendly name of the financial institution's shared brand, if it is a member of one</value>
[DataMember(Name = "sharedBrandName", EmitDefaultValue = false)]
public Object SharedBrandName { get; set; }
/// <summary>
/// Hexadecimal color code related to the secondary branding color of the financial institution
/// </summary>
/// <value>Hexadecimal color code related to the secondary branding color of the financial institution</value>
[DataMember(Name = "secondaryColor", EmitDefaultValue = false)]
public string SecondaryColor { get; set; }
/// <summary>
/// Hexadecimal color code related to the primary branding color of the financial institution
/// </summary>
/// <value>Hexadecimal color code related to the primary branding color of the financial institution</value>
[DataMember(Name = "primaryColor", EmitDefaultValue = false)]
public string PrimaryColor { get; set; }
/// <summary>
/// Identifies which values are accepted for the periodic payment initiation request <code>productType</code>
/// </summary>
/// <value>Identifies which values are accepted for the periodic payment initiation request <code>productType</code></value>
[DataMember(Name = "periodicPaymentsProductTypes", EmitDefaultValue = false)]
public List<string> PeriodicPaymentsProductTypes { get; set; }
/// <summary>
/// Indicates whether the financial institution allows periodic payment initiation requests
/// </summary>
/// <value>Indicates whether the financial institution allows periodic payment initiation requests</value>
[DataMember(Name = "periodicPaymentsEnabled", EmitDefaultValue = true)]
public bool PeriodicPaymentsEnabled { get; set; }
/// <summary>
/// Identifies which values are accepted for the <a href='https://documentation.ibanity.com//api#payment-initiation-request'>payment initiation request</a> <code>productType</code>
/// </summary>
/// <value>Identifies which values are accepted for the <a href='https://documentation.ibanity.com//api#payment-initiation-request'>payment initiation request</a> <code>productType</code></value>
[DataMember(Name = "paymentsProductTypes", EmitDefaultValue = false)]
public List<string> PaymentsProductTypes { get; set; }
/// <summary>
/// Indicates whether the financial institution allows <a href='https://documentation.ibanity.com//api#payment-initiation-request'>payment initiation requests</a>
/// </summary>
/// <value>Indicates whether the financial institution allows <a href='https://documentation.ibanity.com//api#payment-initiation-request'>payment initiation requests</a></value>
[DataMember(Name = "paymentsEnabled", EmitDefaultValue = true)]
public bool PaymentsEnabled { get; set; }
/// <summary>
/// Name of the financial institution
/// </summary>
/// <value>Name of the financial institution</value>
[DataMember(Name = "name", EmitDefaultValue = false)]
public string Name { get; set; }
/// <summary>
/// Indicates if there is an ongoing or scheduled maintenance. If present, the possible values are:<ul><li><code>internal</code>, meaning we are working on the connection and no data access is possible</li><li><code>financialInstitution</code>, indicating the financial institution cannot be reached, but existing data is available in read-only mode</li></ul>
/// </summary>
/// <value>Indicates if there is an ongoing or scheduled maintenance. If present, the possible values are:<ul><li><code>internal</code>, meaning we are working on the connection and no data access is possible</li><li><code>financialInstitution</code>, indicating the financial institution cannot be reached, but existing data is available in read-only mode</li></ul></value>
[DataMember(Name = "maintenanceType", EmitDefaultValue = false)]
public Object MaintenanceType { get; set; }
/// <summary>
/// Indicates the end date of the maintenance.
/// </summary>
/// <value>Indicates the end date of the maintenance.</value>
[DataMember(Name = "maintenanceTo", EmitDefaultValue = false)]
public Object MaintenanceTo { get; set; }
/// <summary>
/// Indicates the start date of the maintenance.
/// </summary>
/// <value>Indicates the start date of the maintenance.</value>
[DataMember(Name = "maintenanceFrom", EmitDefaultValue = false)]
public Object MaintenanceFrom { get; set; }
/// <summary>
/// Location of the logo image for the financial institution
/// </summary>
/// <value>Location of the logo image for the financial institution</value>
[DataMember(Name = "logoUrl", EmitDefaultValue = false)]
public string LogoUrl { get; set; }
/// <summary>
/// Indicates whether a <code>requestedExecutionDate</code> is supported for <a href='https://documentation.ibanity.com//api#payment'>payments</a> from accounts belonging to this financial institution
/// </summary>
/// <value>Indicates whether a <code>requestedExecutionDate</code> is supported for <a href='https://documentation.ibanity.com//api#payment'>payments</a> from accounts belonging to this financial institution</value>
[DataMember(Name = "futureDatedPaymentsAllowed", EmitDefaultValue = true)]
public bool FutureDatedPaymentsAllowed { get; set; }
/// <summary>
/// Indicates if the financial institution has been deprecated. Very rarely we may need to deprecate a <a href='https://documentation.ibanity.com//api#financial-institution'>financial institution</a> and ask your users to authorize their accounts again on its replacement. You will be able to access both accounts (if authorized) but you will not be able to synchronize the deprecated account once its authorization has expired.
/// </summary>
/// <value>Indicates if the financial institution has been deprecated. Very rarely we may need to deprecate a <a href='https://documentation.ibanity.com//api#financial-institution'>financial institution</a> and ask your users to authorize their accounts again on its replacement. You will be able to access both accounts (if authorized) but you will not be able to synchronize the deprecated account once its authorization has expired.</value>
[DataMember(Name = "deprecated", EmitDefaultValue = true)]
public bool Deprecated { get; set; }
/// <summary>
/// Country of the financial institution, in <a href='https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2'>ISO 3166-1 alpha-2</a> format. Is <code>null</code> in the case of an international financial institution.
/// </summary>
/// <value>Country of the financial institution, in <a href='https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2'>ISO 3166-1 alpha-2</a> format. Is <code>null</code> in the case of an international financial institution.</value>
[DataMember(Name = "country", EmitDefaultValue = false)]
public string Country { get; set; }
/// <summary>
/// Identifies which values are accepted for the bulk payment initiation request <code>productType</code>
/// </summary>
/// <value>Identifies which values are accepted for the bulk payment initiation request <code>productType</code></value>
[DataMember(Name = "bulkPaymentsProductTypes", EmitDefaultValue = false)]
public List<string> BulkPaymentsProductTypes { get; set; }
/// <summary>
/// Indicates whether the financial institution allows bulk payment initiation requests
/// </summary>
/// <value>Indicates whether the financial institution allows bulk payment initiation requests</value>
[DataMember(Name = "bulkPaymentsEnabled", EmitDefaultValue = true)]
public bool BulkPaymentsEnabled { get; set; }
/// <summary>
/// Identifier for the financial institution, in <a href='https://en.wikipedia.org/wiki/ISO_9362'>ISO9362</a> format.
/// </summary>
/// <value>Identifier for the financial institution, in <a href='https://en.wikipedia.org/wiki/ISO_9362'>ISO9362</a> format.</value>
[DataMember(Name = "bic", EmitDefaultValue = false)]
public string Bic { get; set; }
/// <summary>
/// TBD
/// </summary>
/// <value>TBD</value>
[DataMember(Name = "timeZone", EmitDefaultValue = false)]
public string TimeZone { get; set; }
/// <summary>
/// Short string representation.
/// </summary>
/// <returns>Short string representation</returns>
public override string ToString() => $"{Name} ({Id})";
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\Integration.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// This endpoint provides an alternative method to revoke the integration (in addition to the revoke refresh token endpoint). This endpoint remains accessible with a client access token, even if your refresh token is lost or expired.
/// </summary>
[DataContract]
public class Integration : Identified<Guid>
{
/// <summary>
/// Corresponding organization ID
/// </summary>
public Guid OrganizationId { get; set; }
}
/// <summary>
/// Details about the corresponding organization.
/// </summary>
[DataContract]
public class IntegrationRelationships
{
/// <summary>
/// Details about the corresponding organization
/// </summary>
[DataMember(Name = "organization", EmitDefaultValue = false)]
public JsonApi.Relationship Organization { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\IntegrationAccount.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// <p>This is an object representing the link between a user's account and an integration.</p>
/// <p>All accounts linked to your Ponto Connect application are returned by this endpoint.</p>
/// </summary>
[DataContract]
public class IntegrationAccount : Identified<Guid>
{
/// <summary>
/// <p>When the account was linked to the integration
/// </summary>
/// <value><p>When the account was linked to the integration</value>
[DataMember(Name = "createdAt", EmitDefaultValue = false)]
public DateTimeOffset CreatedAt { get; set; }
/// <summary>
/// <p>When the account was last accessed through the integration.
/// </summary>
/// <value><p>When the account was last accessed through the integration.</value>
[DataMember(Name = "lastAccessedAt", EmitDefaultValue = false)]
public DateTimeOffset? LastAccessedAt { get; set; }
/// <summary>
/// Corresponding account ID
/// </summary>
public Guid AccountId { get; set; }
/// <summary>
/// Corresponding financial institution ID
/// </summary>
public Guid FinancialInstitutionId { get; set; }
/// <summary>
/// Corresponding organization ID
/// </summary>
public Guid OrganizationId { get; set; }
}
/// <summary>
/// Details about the corresponding account, financial institution and organization.
/// </summary>
[DataContract]
public class IntegrationAccountRelationships
{
/// <summary>
/// Details about the corresponding account
/// </summary>
[DataMember(Name = "account", EmitDefaultValue = false)]
public JsonApi.Relationship Account { get; set; }
/// <summary>
/// Details about the corresponding financial institution
/// </summary>
[DataMember(Name = "financialInstitution", EmitDefaultValue = false)]
public JsonApi.Relationship FinancialInstitution { get; set; }
/// <summary>
/// Details about the corresponding organization
/// </summary>
[DataMember(Name = "organization", EmitDefaultValue = false)]
public JsonApi.Relationship Organization { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\OnboardingDetails.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// <para>This is an object representing the onboarding details of the user who will undergo the linking process. It allows you to prefill the sign in or sign up forms with the user's details to streamline their Ponto onboarding process.</para>
/// <para>For security purposes, the onboarding details object will only be available to be linked to a new Ponto user for five minutes following its creation. You should include the id in the access authorization url as an additional query parameter.</para>
/// </summary>
[DataContract]
public class OnboardingDetails
{
/// <summary>
/// VAT number corresponding to the onboarding user's organization
/// </summary>
/// <value>VAT number corresponding to the onboarding user's organization</value>
[DataMember(Name = "vatNumber", EmitDefaultValue = false)]
public string VatNumber { get; set; }
/// <summary>
/// Phone number of the onboarding user
/// </summary>
/// <value>Phone number of the onboarding user</value>
[DataMember(Name = "phoneNumber", EmitDefaultValue = false)]
public string PhoneNumber { get; set; }
/// <summary>
/// Name of the onboarding user's organization
/// </summary>
/// <value>Name of the onboarding user's organization</value>
[DataMember(Name = "organizationName", EmitDefaultValue = false)]
public string OrganizationName { get; set; }
/// <summary>
/// Last name of the onboarding user
/// </summary>
/// <value>Last name of the onboarding user</value>
[DataMember(Name = "lastName", EmitDefaultValue = false)]
public string LastName { get; set; }
/// <summary>
/// First name of the onboarding user
/// </summary>
/// <value>First name of the onboarding user</value>
[DataMember(Name = "firstName", EmitDefaultValue = false)]
public string FirstName { get; set; }
/// <summary>
/// Enterprise number corresponding to the onboarding user's organization
/// </summary>
/// <value>Enterprise number corresponding to the onboarding user's organization</value>
[DataMember(Name = "enterpriseNumber", EmitDefaultValue = false)]
public string EnterpriseNumber { get; set; }
/// <summary>
/// Email belonging to the onboarding user
/// </summary>
/// <value>Email belonging to the onboarding user</value>
[DataMember(Name = "email", EmitDefaultValue = false)]
public string Email { get; set; }
/// <summary>
/// Street address of the onboarding user's organization
/// </summary>
/// <value>Street address of the onboarding user's organization</value>
[DataMember(Name = "addressStreetAddress", EmitDefaultValue = false)]
public string AddressStreetAddress { get; set; }
/// <summary>
/// Postal code of the onboarding user's organization
/// </summary>
/// <value>Postal code of the onboarding user's organization</value>
[DataMember(Name = "addressPostalCode", EmitDefaultValue = false)]
public string AddressPostalCode { get; set; }
/// <summary>
/// Country of the onboarding user's organization
/// </summary>
/// <value>Country of the onboarding user's organization</value>
[DataMember(Name = "addressCountry", EmitDefaultValue = false)]
public string AddressCountry { get; set; }
/// <summary>
/// City of the onboarding user's organization
/// </summary>
/// <value>City of the onboarding user's organization</value>
[DataMember(Name = "addressCity", EmitDefaultValue = false)]
public string AddressCity { get; set; }
/// <summary>
/// Unique identifier of the financial institution that should be preselected during the Ponto onboarding process
/// </summary>
/// <value>Unique identifier of the financial institution that should be preselected during the Ponto onboarding process</value>
[DataMember(Name = "initialFinancialInstitutionId", EmitDefaultValue = false)]
public Guid? InitialFinancialInstitutionId { get; set; }
}
/// <inheritdoc cref="OnboardingDetails" />
[DataContract]
public class OnboardingDetailsResponse : OnboardingDetails, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\Payment.cs | using System;
using System.Globalization;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// <para>This is an object representing a payment. When you want to initiate payment from one of your user's accounts, you have to create one to start the authorization flow.</para>
/// <para>If you provide a redirect URI when creating the payment, you will receive a redirect link to send your customer to to start the authorization flow. Note that for live payments, your user must have already requested and been granted payment service for their organization to use this flow.</para>
/// <para>Otherwise, the user can sign the payment in the Ponto Dashboard.</para>
/// <para>When authorizing payment initiation in the sandbox, you should use the pre-filled credentials and 123456 as the digipass response.</para>
/// </summary>
[DataContract]
public class Payment
{
/// <summary>
/// A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/ponto-connect/api#financial-institution-attributes'>financial institution attributes</a>
/// </summary>
/// <value>A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/ponto-connect/api#financial-institution-attributes'>financial institution attributes</a></value>
[DataMember(Name = "requestedExecutionDate", EmitDefaultValue = false)]
public string RequestedExecutionDateString
{
get => RequestedExecutionDate.HasValue
? RequestedExecutionDate.Value.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture)
: null;
set => RequestedExecutionDate = !string.IsNullOrWhiteSpace(value)
? (DateTimeOffset?)DateTimeOffset.Parse(value, CultureInfo.InvariantCulture)
: null;
}
/// <summary>
/// A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/ponto-connect/api#financial-institution-attributes'>financial institution attributes</a>
/// </summary>
/// <value>A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/ponto-connect/api#financial-institution-attributes'>financial institution attributes</a></value>
public DateTimeOffset? RequestedExecutionDate { get; set; }
/// <summary>
/// Type of remittance information, can be <code>structured</code> or <code>unstructured</code>
/// </summary>
/// <value>Type of remittance information, can be <code>structured</code> or <code>unstructured</code></value>
[DataMember(Name = "remittanceInformationType", EmitDefaultValue = false)]
public string RemittanceInformationType { get; set; }
/// <summary>
/// Content of the remittance information (aka communication). Limited to 140 characters in the set <code>a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 / - ? : ( ) . , ' + Space</code> to ensure it is not rejected by the financial institution.
/// </summary>
/// <value>Content of the remittance information (aka communication). Limited to 140 characters in the set <code>a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 / - ? : ( ) . , ' + Space</code> to ensure it is not rejected by the financial institution.</value>
[DataMember(Name = "remittanceInformation", EmitDefaultValue = false)]
public string RemittanceInformation { get; set; }
/// <summary>
/// Currency of the payment, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format
/// </summary>
/// <value>Currency of the payment, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format</value>
[DataMember(Name = "currency", IsRequired = true, EmitDefaultValue = false)]
public string Currency { get; set; }
/// <summary>
/// Name of the payee. Limited to 60 characters in the set <code>a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 / - ? : ( ) . , ' + Space</code> to ensure it is not rejected by the financial institution.
/// </summary>
/// <value>Name of the payee. Limited to 60 characters in the set <code>a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 / - ? : ( ) . , ' + Space</code> to ensure it is not rejected by the financial institution.</value>
[DataMember(Name = "creditorName", IsRequired = true, EmitDefaultValue = false)]
public string CreditorName { get; set; }
/// <summary>
/// Type of financial institution reference, currently must be <code>BIC</code>
/// </summary>
/// <value>Type of financial institution reference, currently must be <code>BIC</code></value>
[DataMember(Name = "creditorAgentType", EmitDefaultValue = false)]
public string CreditorAgentType { get; set; }
/// <summary>
/// Reference to the financial institution
/// </summary>
/// <value>Reference to the financial institution</value>
[DataMember(Name = "creditorAgent", EmitDefaultValue = false)]
public string CreditorAgent { get; set; }
/// <summary>
/// Type of payee's account reference, currently must be <code>IBAN</code>
/// </summary>
/// <value>Type of payee's account reference, currently must be <code>IBAN</code></value>
[DataMember(Name = "creditorAccountReferenceType", IsRequired = true, EmitDefaultValue = false)]
public string CreditorAccountReferenceType { get; set; }
/// <summary>
/// Financial institution's internal reference for the payee's account
/// </summary>
/// <value>Financial institution's internal reference for the payee's account</value>
[DataMember(Name = "creditorAccountReference", IsRequired = true, EmitDefaultValue = false)]
public string CreditorAccountReference { get; set; }
/// <summary>
/// Amount of the payment.
/// </summary>
/// <value>Amount of the payment.</value>
[DataMember(Name = "amount", IsRequired = true, EmitDefaultValue = false)]
public decimal Amount { get; set; }
/// <summary>
/// TBD
/// </summary>
/// <value>TBD</value>
[DataMember(Name = "endToEndId", EmitDefaultValue = true)]
public string EndToEndId { get; set; }
/// <summary>
/// Short string representation.
/// </summary>
/// <returns>Short string representation</returns>
public override string ToString() => $"To {CreditorName} ({Amount} {Currency})";
}
/// <inheritdoc />
public class PaymentRequest : Payment
{
/// <summary>
/// URI that your user will be redirected to at the end of the authorization flow</a>
/// </summary>
/// <value>URI that your user will be redirected to at the end of the authorization flow</a></value>
[DataMember(Name = "redirectUri", EmitDefaultValue = false)]
public string RedirectUri { get; set; }
}
/// <inheritdoc cref="Payment" />
[DataContract]
public class PaymentResponse : Payment, IIdentified<Guid>
{
/// <summary>
/// Current status of the payment.
/// </summary>
/// <value>Current status of the payment.</value>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
/// <value>URI to redirect to from your customer frontend to conduct the authorization flow.</value>
[DataMember(Name = "redirectUri", EmitDefaultValue = false)]
public string RedirectUri { get; set; }
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
/// <value>URI to redirect to from your customer frontend to conduct the authorization flow.</value>
public Uri Redirect => string.IsNullOrWhiteSpace(RedirectUri)
? null
: new Uri(RedirectUri);
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
}
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
[DataContract]
public class PaymentLinks
{
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
[DataMember(Name = "redirect", EmitDefaultValue = false)]
public string RedirectString { get; set; }
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
public Uri Redirect => string.IsNullOrWhiteSpace(RedirectString)
? null
: new Uri(RedirectString);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\PaymentActivationRequest.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// <para>This is an object representing a payment activation request. If your customer has not yet requested payment activation for their organization (as indicated by the user info endpoint), you can redirect them to Ponto to submit a request for payment activation.</para>
/// <para>When creating the payment activation request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the process. At the end of the flow, they will be returned to the redirect uri that you defined.</para>
/// <para>When using this endpoint in the sandbox, the redirection flow will work but the user will not be prompted to request payment activation as this is enabled by default in the sandbox.</para>
/// </summary>
[DataContract]
public class PaymentActivationRequest : Identified<Guid>
{
/// <summary>
/// URI that your user will be redirected to at the end of the authorization flow.
/// </summary>
[DataMember(Name = "redirectUri", EmitDefaultValue = false)]
public Uri Redirect { get; set; }
}
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
[DataContract]
public class PaymentActivationRequestLinks
{
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
[DataMember(Name = "redirect", EmitDefaultValue = false)]
public string RedirectString { get; set; }
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
public Uri Redirect => string.IsNullOrWhiteSpace(RedirectString)
? null
: new Uri(RedirectString);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\ReauthorizationRequest.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// <para>This object allows you to request the reauthorization of a specific bank account.</para>
/// <para>By providing a redirect URI, you can create a redirect link to which you can send your customer so they can directly reauthorize their account on Ponto. After reauthorizing at their bank portal, they are redirected automatically back to your application, to the redirect URI of your choosing.</para>
/// </summary>
[DataContract]
public class ReauthorizationRequest : Identified<Guid>
{
/// <summary>
/// URI that your user will be redirected to at the end of the authorization flow.
/// </summary>
[DataMember(Name = "redirectUri", EmitDefaultValue = false)]
public Uri Redirect { get; set; }
}
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
[DataContract]
public class ReauthorizationRequestLinks
{
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
[DataMember(Name = "redirect", EmitDefaultValue = false)]
public string RedirectString { get; set; }
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
public Uri Redirect => string.IsNullOrWhiteSpace(RedirectString)
? null
: new Uri(RedirectString);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\SandboxAccount.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// <para>This is an object representing a financial institution account, a fake account you can use for test purposes in a sandbox integration.</para>
/// <para>These sandbox accounts are available only to the related organization, and can be authorized in the Ponto dashboard.</para>
/// <para>A financial institution account belongs to a financial institution and can have many associated financial institution transactions.</para>
/// </summary>
[DataContract]
public class SandboxAccount : Account, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\SandboxTransaction.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// <para>This is an object representing a financial institution transaction, a fake transaction on a fake account you can create for test purposes.</para>
/// <para>Once the account corresponding to the financial institution account has been synchronized, your custom financial institution transactions will be visible in the transactions list.</para>
/// </summary>
[DataContract]
public class SandboxTransaction : Transaction, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\Synchronization.cs | using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <inheritdoc cref="SynchronizationRequest" />
[DataContract]
public class Synchronization : SynchronizationRequest, IIdentified<Guid>
{
/// <summary>
/// When this synchronization was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this synchronization was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "updatedAt", EmitDefaultValue = false)]
public DateTimeOffset UpdatedAt { get; set; }
/// <summary>
/// Current status of the synchronization, which changes from <code>pending</code> to <code>running</code> to <code>success</code> or <code>error</code>
/// </summary>
/// <value>Current status of the synchronization, which changes from <code>pending</code> to <code>running</code> to <code>success</code> or <code>error</code></value>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
/// <summary>
/// Details of any errors that have occurred during synchronization, due to invalid authorization or technical failure. <a href='https://documentation.ibanity.com//api#sync'>See possible errors</a>
/// </summary>
/// <value>Details of any errors that have occurred during synchronization, due to invalid authorization or technical failure. <a href='https://documentation.ibanity.com//api#sync'>See possible errors</a></value>
[DataMember(Name = "errors", EmitDefaultValue = false)]
public List<JsonApi.ErrorItem> Errors { get; set; }
/// <summary>
/// When this synchronization was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this synchronization was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "createdAt", EmitDefaultValue = false)]
public DateTimeOffset CreatedAt { get; set; }
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// Short string representation.
/// </summary>
/// <returns>Short string representation</returns>
public override string ToString() => $"{Status} from {CreatedAt:o} ({Id})";
}
/// <summary>
/// This is an object representing a resource synchronization. This object will give you the details of the synchronization, including its resource, type, and status.
/// </summary>
[DataContract]
public class SynchronizationRequest
{
/// <summary>
/// Type of the resource to be synchronized. Currently must be <code>account</code>
/// </summary>
/// <value>Type of the resource to be synchronized. Currently must be <code>account</code></value>
[DataMember(Name = "resourceType", EmitDefaultValue = false)]
public string ResourceType { get; set; }
/// <summary>
/// Identifier of the resource to be synchronized
/// </summary>
/// <value>Identifier of the resource to be synchronized</value>
[DataMember(Name = "resourceId", EmitDefaultValue = false)]
public Guid ResourceId { get; set; }
/// <summary>
/// What is being synchronized. Account information such as balance is updated using <code>accountDetails</code>, while <code>accountTransactions</code> is used to synchronize the transactions.
/// </summary>
/// <value>What is being synchronized. Account information such as balance is updated using <code>accountDetails</code>, while <code>accountTransactions</code> is used to synchronize the transactions.</value>
[DataMember(Name = "subtype", EmitDefaultValue = false)]
public string Subtype { get; set; }
/// <summary>
/// This must contain the IP address of the customer.
/// </summary>
/// <value>This must contain the IP address of the customer.</value>
[DataMember(Name = "customerIpAddress", EmitDefaultValue = false)]
public string CustomerIpAddress { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\Transaction.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// <para>This is an object representing an account transaction. This object will give you the details of the financial transaction, including its amount and description.</para>
/// <para>From this object, you can link back to its account.</para>
/// </summary>
[DataContract]
public class Transaction
{
/// <summary>
/// Date representing the moment the financial institution transaction is considered effective
/// </summary>
/// <value>Date representing the moment the financial institution transaction is considered effective</value>
[DataMember(Name = "valueDate", EmitDefaultValue = false)]
public DateTimeOffset ValueDate { get; set; }
/// <summary>
/// Type of remittance information, can be <code>structured</code> or <code>unstructured</code>
/// </summary>
/// <value>Type of remittance information, can be <code>structured</code> or <code>unstructured</code></value>
[DataMember(Name = "remittanceInformationType", EmitDefaultValue = false)]
public string RemittanceInformationType { get; set; }
/// <summary>
/// Content of the remittance information (aka communication)
/// </summary>
/// <value>Content of the remittance information (aka communication)</value>
[DataMember(Name = "remittanceInformation", EmitDefaultValue = false)]
public string RemittanceInformation { get; set; }
/// <summary>
/// Purpose code, based on <a href='https://www.iso20022.org/'>ISO 20022</a>
/// </summary>
/// <value>Purpose code, based on <a href='https://www.iso20022.org/'>ISO 20022</a></value>
[DataMember(Name = "purposeCode", EmitDefaultValue = false)]
public string PurposeCode { get; set; }
/// <summary>
/// Bank transaction code prorietary to the financial institution. Content will vary per financial institution
/// </summary>
/// <value>Bank transaction code prorietary to the financial institution. Content will vary per financial institution</value>
[DataMember(Name = "proprietaryBankTransactionCode", EmitDefaultValue = false)]
public string ProprietaryBankTransactionCode { get; set; }
/// <summary>
/// Unique reference of the mandate which is signed between the remitter and the debtor
/// </summary>
/// <value>Unique reference of the mandate which is signed between the remitter and the debtor</value>
[DataMember(Name = "mandateId", EmitDefaultValue = false)]
public string MandateId { get; set; }
/// <summary>
/// Date representing the moment the financial institution transaction has been recorded
/// </summary>
/// <value>Date representing the moment the financial institution transaction has been recorded</value>
[DataMember(Name = "executionDate", EmitDefaultValue = false)]
public DateTimeOffset ExecutionDate { get; set; }
/// <summary>
/// Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
/// </summary>
/// <value>Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.</value>
[DataMember(Name = "endToEndId", EmitDefaultValue = false)]
public string EndToEndId { get; set; }
/// <summary>
/// Description of the financial institution transaction
/// </summary>
/// <value>Description of the financial institution transaction</value>
[DataMember(Name = "description", EmitDefaultValue = false)]
public string Description { get; set; }
/// <summary>
/// Currency of the financial institution transaction, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format
/// </summary>
/// <value>Currency of the financial institution transaction, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format</value>
[DataMember(Name = "currency", EmitDefaultValue = false)]
public string Currency { get; set; }
/// <summary>
/// Identification of the creditor, e.g. a SEPA Creditor ID.
/// </summary>
/// <value>Identification of the creditor, e.g. a SEPA Creditor ID.</value>
[DataMember(Name = "creditorId", EmitDefaultValue = false)]
public string CreditorId { get; set; }
/// <summary>
/// When this financial institution transaction was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this financial institution transaction was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "createdAt", EmitDefaultValue = false)]
public DateTimeOffset CreatedAt { get; set; }
/// <summary>
/// Number representing the counterpart's account
/// </summary>
/// <value>Number representing the counterpart's account</value>
[DataMember(Name = "counterpartReference", EmitDefaultValue = false)]
public string CounterpartReference { get; set; }
/// <summary>
/// Legal name of the counterpart. Can only be updated if it was previously not provided (blank).
/// </summary>
/// <value>Legal name of the counterpart. Can only be updated if it was previously not provided (blank).</value>
[DataMember(Name = "counterpartName", EmitDefaultValue = false)]
public string CounterpartName { get; set; }
/// <summary>
/// Bank transaction code, based on <a href='https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets'>ISO 20022</a>
/// </summary>
/// <value>Bank transaction code, based on <a href='https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets'>ISO 20022</a></value>
[DataMember(Name = "bankTransactionCode", EmitDefaultValue = false)]
public string BankTransactionCode { get; set; }
/// <summary>
/// Amount of the financial institution transaction. Can be positive or negative
/// </summary>
/// <value>Amount of the financial institution transaction. Can be positive or negative</value>
[DataMember(Name = "amount", EmitDefaultValue = false)]
public decimal Amount { get; set; }
/// <summary>
/// Additional transaction-related information provided from the financial institution to the customer
/// </summary>
/// <value>Additional transaction-related information provided from the financial institution to the customer</value>
[DataMember(Name = "additionalInformation", EmitDefaultValue = false)]
public string AdditionalInformation { get; set; }
/// <summary>
/// Reference for card related to the transaction (if any). For example the last 4 digits of the card number.
/// </summary>
/// <value>Reference for card related to the transaction (if any). For example the last 4 digits of the card number.</value>
[DataMember(Name = "cardReference", EmitDefaultValue = false)]
public string CardReference { get; set; }
/// <summary>
/// Type of card reference (can be PAN or MASKEDPAN).
/// </summary>
/// <value>Type of card reference (can be PAN or MASKEDPAN).</value>
[DataMember(Name = "cardReferenceType", EmitDefaultValue = false)]
public string CardReferenceType { get; set; }
/// <summary>
/// A fee that was withheld from this transaction at the financial institution.
/// </summary>
/// <value>A fee that was withheld from this transaction at the financial institution.</value>
[DataMember(Name = "fee", EmitDefaultValue = false)]
public decimal? Fee { get; set; }
/// <summary>
/// Short string representation.
/// </summary>
/// <returns>Short string representation</returns>
public override string ToString() => $"{BankTransactionCode} ({Amount} {Currency})";
}
/// <inheritdoc cref="Transaction" />
[DataContract]
public class TransactionResponse : Transaction, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// ID of the account that this transaction belongs to.
/// </summary>
public Guid AccountId { get; set; }
/// <summary>
/// When this financial institution transaction was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this financial institution transaction was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "updatedAt", EmitDefaultValue = false)]
public DateTimeOffset UpdatedAt { get; set; }
}
/// <summary>
/// Link to the account that this transaction belongs to.
/// </summary>
[DataContract]
public class TransactionRelationships
{
/// <summary>
/// Link to the account that this transaction belongs to.
/// </summary>
[DataMember(Name = "account", EmitDefaultValue = false)]
public JsonApi.Relationship Account { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\Usage.cs | using System;
using System.Runtime.Serialization;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// This endpoint provides the usage of your integration by the provided organization during a given month. In order to continue to allow access to this information if an integration is revoked, you must use a client access token for this endpoint.
/// </summary>
[DataContract]
public class Usage
{
/// <summary>
/// Number of initiated payments created by the integration
/// </summary>
/// <value>Number of initiated payments created by the integration</value>
[DataMember(Name = "paymentCount", EmitDefaultValue = false)]
public int PaymentCount { get; set; }
/// <summary>
/// Number of accounts which initiated a payment created by the integration
/// </summary>
/// <value>Number of accounts which initiated a payment created by the integration</value>
[DataMember(Name = "paymentAccountCount", EmitDefaultValue = true)]
public int PaymentAccountCount { get; set; }
/// <summary>
/// Number of initiated bulk payment bundles created by the integration
/// </summary>
/// <value>Number of initiated bulk payment bundles created by the integration</value>
[DataMember(Name = "bulkPaymentBundleCount", EmitDefaultValue = true)]
public int BulkPaymentBundleCount { get; set; }
/// <summary>
/// Number of initiated bulk payment created by the integration
/// </summary>
/// <value>Number of initiated bulk payment created by the integration</value>
[DataMember(Name = "bulkPaymentCount", EmitDefaultValue = true)]
public int BulkPaymentCount { get; set; }
/// <summary>
/// Number of accounts linked to the integration. The total is prorated, so may be a decimal number if accounts have been linked or unlinked during the month.
/// </summary>
/// <value>Number of accounts linked to the integration. The total is prorated, so may be a decimal number if accounts have been linked or unlinked during the month.</value>
[DataMember(Name = "accountCount", EmitDefaultValue = true)]
public decimal AccountCount { get; set; }
/// <summary>
/// Year of the usage.
/// </summary>
public int Year { get; set; }
/// <summary>
/// Month of the usage.
/// </summary>
public int Month { get; set; }
/// <summary>
/// ID of the corresponding organization
/// </summary>
public Guid OrganizationId { get; set; }
}
/// <summary>
/// Details about the corresponding organization
/// </summary>
[DataContract]
public class UsageRelationships
{
/// <summary>
/// Details about the corresponding organization
/// </summary>
[DataMember(Name = "organization", EmitDefaultValue = false)]
public JsonApi.Relationship Organization { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\PontoConnect | raw_data\ibanity-dotnet\src\Client\Products\PontoConnect\Models\UserInfo.cs | using System;
using System.Runtime.Serialization;
namespace Ibanity.Apis.Client.Products.PontoConnect.Models
{
/// <summary>
/// <para>This endpoint provides information about the subject (organization) of an access token. Minimally, it provides the organization's id as the token's sub. If additional organization information was requested in the scope of the authorization, it will be provided here.</para>
/// <para>The organization's id can be used to request its usage. Keep in mind that if the access token is revoked, this endpoint will no longer be available, so you may want to store the organization's id in your system.</para>
/// </summary>
[DataContract]
public class UserInfo
{
/// <summary>
/// ID of the organization corresponding to the provided access token
/// </summary>
/// <value>ID of the organization corresponding to the provided access token</value>
[DataMember(Name = "sub", EmitDefaultValue = false)]
public Guid Sub { get; set; }
/// <summary>
/// Indicates whether the organization has requested to be able to sign payments from Ponto. If it is <code>false</code> (or you are in the sandbox), you may use the <a href='https://documentation.ibanity.com//api#request-payment-activation'>payment activation request</a> redirect flow.
/// </summary>
/// <value>Indicates whether the organization has requested to be able to sign payments from Ponto. If it is <code>false</code> (or you are in the sandbox), you may use the <a href='https://documentation.ibanity.com//api#request-payment-activation'>payment activation request</a> redirect flow.</value>
[DataMember(Name = "paymentsActivationRequested", EmitDefaultValue = true)]
public bool PaymentsActivationRequested { get; set; }
/// <summary>
/// Indicates whether the organization can currently sign live payments from Ponto. Must be <code>true</code> to use the (bulk) payment redirect flow.
/// </summary>
/// <value>Indicates whether the organization can currently sign live payments from Ponto. Must be <code>true</code> to use the (bulk) payment redirect flow.</value>
[DataMember(Name = "paymentsActivated", EmitDefaultValue = true)]
public bool PaymentsActivated { get; set; }
/// <summary>
/// Indicates whether the organization has completed the onboarding process in the Ponto dashboard. If not completed within 72 hours of creation, the organization's account information and integration will be automatically deleted from Ponto.
/// </summary>
/// <value>Indicates whether the organization has completed the onboarding process in the Ponto dashboard. If not completed within 72 hours of creation, the organization's account information and integration will be automatically deleted from Ponto.</value>
[DataMember(Name = "onboardingComplete", EmitDefaultValue = true)]
public bool OnboardingComplete { get; set; }
/// <summary>
/// Name of the organization
/// </summary>
/// <value>Name of the organization</value>
[DataMember(Name = "name", EmitDefaultValue = false)]
public string Name { get; set; }
/// <summary>
/// Only when scope name was requested and he integration was created via a representative
/// </summary>
/// <value>Only when scope name was requested and he integration was created via a representative</value>
[DataMember(Name = "representativeOrganizationName", EmitDefaultValue = false)]
public string RepresentativeOrganizationName { get; set; }
/// <summary>
/// Only if the integration was created via a representative
/// </summary>
/// <value>Only if the integration was created via a representative</value>
[DataMember(Name = "representativeOrganizationId", EmitDefaultValue = false)]
public Guid? RepresentativeOrganizationId { get; set; }
/// <summary>
/// Short string representation.
/// </summary>
/// <returns>Short string representation</returns>
public override string ToString() => $"{Name} ({Sub})";
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\AccountInformationAccessRequestAuthorizations.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.JsonApi;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IAccountInformationAccessRequestAuthorizations" />
public class AccountInformationAccessRequestAuthorizations : ResourceWithParentClient<AccountInformationAccessRequestAuthorizationResponse, object, object, AuthorizationLinks, CustomerAccessToken>, IAccountInformationAccessRequestAuthorizations
{
private const string GrandParentEntityName = "customer/financial-institutions";
private const string ParentEntityName = "account-information-access-requests";
private const string EntityName = "authorizations";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public AccountInformationAccessRequestAuthorizations(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { GrandParentEntityName, ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<AccountInformationAccessRequestAuthorizationResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, Guid accountInformationAccessRequestId, RequestAuthorization requestAuthorization, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (requestAuthorization is null)
throw new ArgumentNullException(nameof(requestAuthorization));
var payload = new JsonApi.Data<RequestAuthorization, object, object, object>
{
Type = "authorization",
Attributes = requestAuthorization
};
return InternalCreate(token, new[] { financialInstitutionId, accountInformationAccessRequestId }, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
protected override AccountInformationAccessRequestAuthorizationResponse Map(Data<AccountInformationAccessRequestAuthorizationResponse, object, object, AuthorizationLinks> data)
{
var result = base.Map(data);
result.NextRedirect = data.Links?.NextRedirect;
return result;
}
}
/// <summary>
/// <p>This object represent the authorization resource. When you perform an Authorization flow using TPP managed authorization flow, you need to create an authorization resource to complete the flow.</p>
/// <p>The attribute queryParameters contains the query parameters returned by the financial institution when the customer is redirected to your configured redirect uri.</p>
/// </summary>
public interface IAccountInformationAccessRequestAuthorizations
{
/// <summary>
/// Create account information access request authorization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountInformationAccessRequestId">Account information access request ID</param>
/// <param name="requestAuthorization">Details of the account information access request authorization</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created Account Information Access Request Authorization resource</returns>
Task<AccountInformationAccessRequestAuthorizationResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, Guid accountInformationAccessRequestId, RequestAuthorization requestAuthorization, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\AccountInformationAccessRequests.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.JsonApi;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IAccountInformationAccessRequests" />
public class AccountInformationAccessRequests : ResourceWithParentClient<AccountInformationAccessRequestResponse, AccountInformationAccessRequestMeta, object, AccountInformationAccessRequestLinks, CustomerAccessToken>, IAccountInformationAccessRequests
{
private const string ParentEntityName = "customer/financial-institutions";
private const string EntityName = "account-information-access-requests";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public AccountInformationAccessRequests(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<AccountInformationAccessRequestResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, AccountInformationAccessRequestRequest accountInformationAccessRequest, int? requestedPastTransactionDays = null, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (accountInformationAccessRequest is null)
throw new ArgumentNullException(nameof(accountInformationAccessRequest));
var payload = new JsonApi.Data<AccountInformationAccessRequestRequest, AccountInformationAccessRequestMeta, object, object>
{
Type = "accountInformationAccessRequest",
Attributes = accountInformationAccessRequest,
Meta = new AccountInformationAccessRequestMeta
{
RequestedPastTransactionDays = requestedPastTransactionDays
}
};
return InternalCreate(token, new[] { financialInstitutionId }, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<AccountInformationAccessRequestResponse> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(token, new[] { financialInstitutionId }, id, cancellationToken);
/// <inheritdoc />
protected override AccountInformationAccessRequestResponse Map(Data<AccountInformationAccessRequestResponse, AccountInformationAccessRequestMeta, object, AccountInformationAccessRequestLinks> data)
{
var result = base.Map(data);
result.Redirect = data.Links?.Redirect;
return result;
}
}
/// <summary>
/// <p>This is an object representing an account information access request. When you want to access the account information of one of your customers, you have to create one to start the authorization flow.</p>
/// <p>When creating the account information access request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the authorization process. At the end of the flow, they will be returned to the redirect uri that you defined.</p>
/// <p>If the access request is not authorized (for example when the customer cancels the flow), an error query parameter will be added to the redirect uri. The possible values of this parameter are access_denied and unsupported_multi_currency_account.</p>
/// <p>When authorizing account access by a financial institution user (in the sandbox), you should use 123456 as the digipass response. You can also use the Ibanity Sandbox Authorization Portal CLI to automate this authorization.</p>
/// </summary>
public interface IAccountInformationAccessRequests
{
/// <summary>
/// Create account information access request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountInformationAccessRequest">Details of the account information access request</param>
/// <param name="requestedPastTransactionDays">Optional number of days to fetch past transactions. Default is 90</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created account information access request resource</returns>
Task<AccountInformationAccessRequestResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, AccountInformationAccessRequestRequest accountInformationAccessRequest, int? requestedPastTransactionDays = null, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get account information access request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="id">Account information access request ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created account information access request resource</returns>
Task<AccountInformationAccessRequestResponse> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Accounts.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IAccounts" />
public class Accounts : ResourceWithParentClient<AccountResponse, AccountMeta, object, object, CustomerAccessToken>, IAccounts
{
private const string ParentEntityName = "customer/financial-institutions";
private const string EntityName = "accounts";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public Accounts(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<IbanityCollection<AccountResponse>> List(CustomerAccessToken token, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(
token,
$"{UrlPrefix}/customer/accounts",
null,
pageLimit,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<AccountResponse>> ListForFinancialInstitution(CustomerAccessToken token, Guid financialInstitutionId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(token, new[] { financialInstitutionId }, null, pageLimit, pageBefore, pageAfter, cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<AccountResponse>> ListForAccountInformationAccessRequest(CustomerAccessToken token, Guid financialInstitutionId, Guid accountInformationAccessRequestId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(
token,
$"{UrlPrefix}/customer/financial-institutions/{financialInstitutionId}/account-information-access-requests/{accountInformationAccessRequestId}/accounts",
null,
pageLimit,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
public Task<AccountResponse> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(token, new[] { financialInstitutionId }, id, cancellationToken);
/// <inheritdoc />
public Task Delete(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null) =>
InternalDelete(token, new[] { financialInstitutionId }, id, cancellationToken);
/// <inheritdoc />
protected override AccountResponse Map(JsonApi.Data<AccountResponse, AccountMeta, object, object> data)
{
var result = base.Map(data);
result.SynchronizedAt = data.Meta.SynchronizedAt;
result.Availability = data.Meta.Availability;
result.LatestSynchronization = data.Meta.LatestSynchronization.Attributes;
result.LatestSynchronization.Id = Guid.Parse(data.Meta.LatestSynchronization.Id);
return result;
}
}
/// <summary>
/// <p>This is an object representing a customer account. This object will provide details about the account, including the balance and the currency.</p>
/// <p>An account has related transactions and belongs to a financial institution.</p>
/// <p>The account API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
public interface IAccounts
{
/// <summary>
/// List Accounts
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="pageLimit">Maximum number (1-100) of resources that might be returned. It is possible that the response contains fewer elements. Defaults to 10</param>
/// <param name="pageBefore">Cursor for pagination. Indicates that the API should return the synchronization resources which are immediately before this one in the list (the previous page)</param>
/// <param name="pageAfter">Cursor for pagination. Indicates that the API should return the synchronization resources which are immediately after this one in the list (the next page)</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of account resources</returns>
Task<IbanityCollection<AccountResponse>> List(CustomerAccessToken token, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Accounts for Financial Institution
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="pageLimit">Maximum number (1-100) of resources that might be returned. It is possible that the response contains fewer elements. Defaults to 10</param>
/// <param name="pageBefore">Cursor for pagination. Indicates that the API should return the synchronization resources which are immediately before this one in the list (the previous page)</param>
/// <param name="pageAfter">Cursor for pagination. Indicates that the API should return the synchronization resources which are immediately after this one in the list (the next page)</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of account resources</returns>
Task<IbanityCollection<AccountResponse>> ListForFinancialInstitution(CustomerAccessToken token, Guid financialInstitutionId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Accounts for Account Information Access Request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountInformationAccessRequestId">Account information access request ID</param>
/// <param name="pageLimit">Maximum number (1-100) of resources that might be returned. It is possible that the response contains fewer elements. Defaults to 10</param>
/// <param name="pageBefore">Cursor for pagination. Indicates that the API should return the synchronization resources which are immediately before this one in the list (the previous page)</param>
/// <param name="pageAfter">Cursor for pagination. Indicates that the API should return the synchronization resources which are immediately after this one in the list (the next page)</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of account resources</returns>
Task<IbanityCollection<AccountResponse>> ListForAccountInformationAccessRequest(CustomerAccessToken token, Guid financialInstitutionId, Guid accountInformationAccessRequestId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Account
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="id">Account ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The specified account resource or 404 if not found</returns>
Task<AccountResponse> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null);
/// <summary>
/// Delete Account
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="id">Account ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <remarks>All account details and transactions have been destroyed. In the case that the customer would add this account again later, the account id and the transaction ids will be different since they will be considered completely new resources.</remarks>
Task Delete(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\BasePaymentInitiationRequestAuthorizations.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.JsonApi;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <summary>
/// Abstract service to manage payment authorizations
/// </summary>
/// <typeparam name="TRelationships">Relationships type</typeparam>
public abstract class BasePaymentInitiationRequestAuthorizations<TRelationships> : ResourceWithParentClient<PaymentAuthorizationResponse, object, TRelationships, AuthorizationLinks, CustomerAccessToken>
{
private const string GrandParentEntityName = "customer/financial-institutions";
private const string EntityName = "authorizations";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
/// <param name="parentEntityName"></param>
protected BasePaymentInitiationRequestAuthorizations(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix, string parentEntityName) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { GrandParentEntityName, parentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<PaymentAuthorizationResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, Guid paymentInitiationRequestId, RequestAuthorization requestAuthorization, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (requestAuthorization is null)
throw new ArgumentNullException(nameof(requestAuthorization));
var payload = new JsonApi.Data<RequestAuthorization, object, TRelationships, object>
{
Type = "authorization",
Attributes = requestAuthorization
};
return InternalCreate(token, new[] { financialInstitutionId, paymentInitiationRequestId }, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
protected override PaymentAuthorizationResponse Map(Data<PaymentAuthorizationResponse, object, TRelationships, AuthorizationLinks> data)
{
if (data.Attributes == null)
data.Attributes = new PaymentAuthorizationResponse();
var result = base.Map(data);
result.NextRedirect = data.Links?.NextRedirect;
result.PaymentInitiationRequestStatus = GetStatus(data.Relationships);
return result;
}
/// <summary>
/// Get payment status from relationships
/// </summary>
/// <param name="relationships">Relationship received in response</param>
/// <returns>Payment status</returns>
protected abstract string GetStatus(TRelationships relationships);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\BatchSynchronizations.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.JsonApi;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IBatchSynchronizations" />
public class BatchSynchronizations : ResourceClient<BatchSynchronizationResponse, object, object, object, CustomerAccessToken>, IBatchSynchronizations
{
private const string EntityName = "batch-synchronizations";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public BatchSynchronizations(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, EntityName)
{ }
/// <inheritdoc />
public Task<BatchSynchronizationResponse> Create(BatchSynchronization batchSynchronization, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (batchSynchronization is null)
throw new ArgumentNullException(nameof(batchSynchronization));
var payload = new JsonApi.Data<BatchSynchronization, object, object, object>
{
Type = "batchSynchronization",
Attributes = batchSynchronization
};
return InternalCreate(null, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
protected override BatchSynchronizationResponse Map(Data<BatchSynchronizationResponse, object, object, object> data)
{
if (data.Attributes == null)
data.Attributes = new BatchSynchronizationResponse();
return base.Map(data);
}
}
/// <summary>
/// This is an object representing a resource batch-synchronization. This object will give you the details of the batch-synchronization.
/// </summary>
public interface IBatchSynchronizations
{
/// <summary>
/// Create Batch Synchronization
/// </summary>
/// <param name="batchSynchronization">Details of the batch-synchronization</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A batch synchronization resource</returns>
Task<BatchSynchronizationResponse> Create(BatchSynchronization batchSynchronization, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\BulkPaymentInitiationRequestAuthorizations.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IBulkPaymentInitiationRequestAuthorizations" />
public class BulkPaymentInitiationRequestAuthorizations : BasePaymentInitiationRequestAuthorizations<BulkPaymentInitiationRequestAuthorizationRelationships>, IBulkPaymentInitiationRequestAuthorizations
{
private const string ParentEntityName = "bulk-payment-initiation-requests";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public BulkPaymentInitiationRequestAuthorizations(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, ParentEntityName)
{ }
/// <inheritdoc />
protected override string GetStatus(BulkPaymentInitiationRequestAuthorizationRelationships relationships) =>
relationships?.BulkPaymentInitiationRequest?.Data?.Attributes?.Status;
}
/// <summary>
/// <p>This object represent the authorization resource. When you perform an Authorization flow using TPP managed authorization flow, you need to create an authorization resource to complete the flow.</p>
/// <p>The attribute queryParameters contains the query parameters returned by the financial institution when the customer is redirected to your configured redirect uri.</p>
/// </summary>
public interface IBulkPaymentInitiationRequestAuthorizations
{
/// <summary>
/// Create bulk payment initiation request authorization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="bulkPaymentInitiationRequestId">Bulk payment initiation request ID</param>
/// <param name="requestAuthorization">Details of the request authorization</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created Account Information Access Request Authorization resource</returns>
Task<PaymentAuthorizationResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, Guid bulkPaymentInitiationRequestId, RequestAuthorization requestAuthorization, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\BulkPaymentInitiationRequests.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IBulkPaymentInitiationRequests" />
public class BulkPaymentInitiationRequests : ResourceWithParentClient<BulkPaymentInitiationRequestResponse, object, object, object, CustomerAccessToken>, IBulkPaymentInitiationRequests
{
private const string ParentEntityName = "customer/financial-institutions";
private const string EntityName = "bulk-payment-initiation-requests";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public BulkPaymentInitiationRequests(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<BulkPaymentInitiationRequestResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, BulkPaymentInitiationRequest paymentInitiationRequest, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (paymentInitiationRequest is null)
throw new ArgumentNullException(nameof(paymentInitiationRequest));
var payload = new JsonApi.Data<BulkPaymentInitiationRequest, object, object, object>
{
Type = "paymentInitiationRequest",
Attributes = paymentInitiationRequest
};
return InternalCreate(token, new[] { financialInstitutionId }, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<BulkPaymentInitiationRequestResponse> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(token, new[] { financialInstitutionId }, id, cancellationToken);
/// <inheritdoc />
public Task Delete(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null) =>
InternalDelete(token, new[] { financialInstitutionId }, id, cancellationToken);
}
/// <summary>
/// This is an object representing a bulk payment initiation request. When you want to request the initiation of payments on behalf of one of your customers, you can create one to start the authorization flow.
/// </summary>
public interface IBulkPaymentInitiationRequests
{
/// <summary>
/// Create Bulk Payment Initiation Request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="paymentInitiationRequest">Details of the periodic payment initiation request</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created payment initiation request resource</returns>
Task<BulkPaymentInitiationRequestResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, BulkPaymentInitiationRequest paymentInitiationRequest, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Bulk Payment Initiation Request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="id">Bulk Payment Initiation Request ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The specified payment initiation request resource</returns>
Task<BulkPaymentInitiationRequestResponse> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null);
/// <summary>
/// Delete Bulk Payment Initiation Request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="id">Bulk Payment Initiation Request ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
Task Delete(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Customers.cs | using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.JsonApi;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="ICustomers" />
public class Customers : ResourceClient<Customer, object, object, object, CustomerAccessToken>, ICustomers
{
private const string EntityName = "customer";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public Customers(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, EntityName)
{ }
/// <inheritdoc />
public Task<Customer> Delete(CustomerAccessToken token, CancellationToken? cancellationToken = null) =>
InternalDelete(token, cancellationToken);
/// <inheritdoc />
protected override Customer Map(Data<Customer, object, object, object> data)
{
if (data.Attributes == null)
data.Attributes = new Customer();
return base.Map(data);
}
}
/// <summary>
/// <p>This is an object representing a customer. A customer resource is created with the creation of a related customer access token.</p>
/// <p>In the case that the contractual relationship between you and your customer is terminated, you should probably use the Delete Customer endpoint to erase ALL customer personal data.</p>
/// <p>In the case that your customer wants to revoke your access to some accounts, you should use the Delete Account endpoint instead.</p>
/// </summary>
public interface ICustomers
{
/// <summary>
/// Remove all customer personal data.
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A resource with the deleted customer's identifier.</returns>
Task<Customer> Delete(CustomerAccessToken token, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\FinancialInstitutionCountries.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.JsonApi;
using Ibanity.Apis.Client.Products.XS2A.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IFinancialInstitutionCountries" />
public class FinancialInstitutionCountries : ResourceClient<FinancialInstitutionCountry, object, object, object, string, CustomerAccessToken>, IFinancialInstitutionCountries
{
private const string EntityName = "financial-institution-countries";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public FinancialInstitutionCountries(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, EntityName)
{ }
/// <inheritdoc />
protected override string ParseId(string id) => id;
/// <inheritdoc />
protected override FinancialInstitutionCountry Map(Data<FinancialInstitutionCountry, object, object, object> data)
{
if (data.Attributes == null)
data.Attributes = new FinancialInstitutionCountry();
return base.Map(data);
}
/// <inheritdoc />
public Task<IbanityCollection<FinancialInstitutionCountry>> List(int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(null, null, pageSize, pageBefore, pageAfter, cancellationToken);
}
/// <summary>
/// This endpoint provides a list of the unique countries for which there are financial institutions available in the list financial institutions endpoint. These codes can be used to filter the financial institutions by country.
/// </summary>
public interface IFinancialInstitutionCountries
{
/// <summary>
/// List Financial Institutions Countries
/// </summary>
/// <param name="pageSize"></param>
/// <param name="pageBefore"></param>
/// <param name="pageAfter"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
Task<IbanityCollection<FinancialInstitutionCountry>> List(int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\FinancialInstitutions.cs | using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Models;
using Ibanity.Apis.Client.Products.XS2A.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IFinancialInstitutions" />
public class FinancialInstitutions : ResourceClient<FinancialInstitution, object, object, object, CustomerAccessToken>, IFinancialInstitutions
{
private const string EntityName = "financial-institutions";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public FinancialInstitutions(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, EntityName)
{ }
/// <inheritdoc />
public Task<IbanityCollection<FinancialInstitution>> List(IEnumerable<Filter> filters = null, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(
null,
filters,
pageSize,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
public Task<PageBasedXS2ACollection<FinancialInstitution>> ListByPage(IEnumerable<Filter> filters = null, long? pageNumber = null, int? pageSize = null, CancellationToken? cancellationToken = null) =>
InternalXs2aPageBasedList(null, filters, null, pageNumber, pageSize, cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<FinancialInstitution>> ListForCustomer(CustomerAccessToken token, IEnumerable<Filter> filters = null, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
filters,
pageSize,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
public Task<PageBasedXS2ACollection<FinancialInstitution>> ListForCustomerByPage(CustomerAccessToken token, IEnumerable<Filter> filters = null, long? pageNumber = null, int? pageSize = null, CancellationToken? cancellationToken = null) =>
InternalXs2aPageBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
filters,
null,
pageNumber,
pageSize,
cancellationToken);
/// <inheritdoc />
public Task<FinancialInstitution> Get(Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(null, id, cancellationToken);
}
/// <summary>
/// This is an object representing a financial institution, providing its basic details - including whether it is a sandbox object or not.
/// </summary>
/// <remarks>You can manage fake financial institutions in the sandbox using the create, update, and delete methods. Obviously, these endpoints will not work for real, live financial institutions.</remarks>
public interface IFinancialInstitutions
{
/// <summary>
/// List Financial Institutions
/// </summary>
/// <param name="filters">Attributes to be filtered from the results</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<IbanityCollection<FinancialInstitution>> List(IEnumerable<Filter> filters = null, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Financial Institutions
/// </summary>
/// <param name="filters">Attributes to be filtered from the results</param>
/// <param name="pageNumber">Cursor that specifies the last resource of the previous page</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<PageBasedXS2ACollection<FinancialInstitution>> ListByPage(IEnumerable<Filter> filters = null, long? pageNumber = null, int? pageSize = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Financial Institutions for a customer
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="filters">Attributes to be filtered from the results</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<IbanityCollection<FinancialInstitution>> ListForCustomer(CustomerAccessToken token, IEnumerable<Filter> filters = null, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Financial Institutions for a customer
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="filters">Attributes to be filtered from the results</param>
/// <param name="pageNumber">Cursor that specifies the last resource of the previous page</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<PageBasedXS2ACollection<FinancialInstitution>> ListForCustomerByPage(CustomerAccessToken token, IEnumerable<Filter> filters = null, long? pageNumber = null, int? pageSize = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Financial Institution
/// </summary>
/// <param name="id">Financial institution ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns></returns>
Task<FinancialInstitution> Get(Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Holdings.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IHoldings" />
public class Holdings : ResourceWithParentClient<Holding, object, HoldingRelationships, object, CustomerAccessToken>, IHoldings
{
private const string GrandParentEntityName = "customer/financial-institutions";
private const string ParentEntityName = "accounts";
private const string EntityName = "holdings";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public Holdings(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { GrandParentEntityName, ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<IbanityCollection<Holding>> List(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(token, new[] { financialInstitutionId, accountId }, null, pageLimit, pageBefore, pageAfter, cancellationToken);
/// <inheritdoc />
public Task<Holding> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(token, new[] { financialInstitutionId, accountId }, id, cancellationToken);
/// <inheritdoc />
protected override Holding Map(JsonApi.Data<Holding, object, HoldingRelationships, object> data)
{
var result = base.Map(data);
result.AccountId = Guid.Parse(data.Relationships.Account.Data.Id);
return result;
}
}
/// <summary>
/// <p>This is an object representing an account holding. This object will give you the details of the financial holding</p>
/// <p>From this object, you can link back to its account.</p>
/// <p>The Holding API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
public interface IHoldings
{
/// <summary>
/// List Holdings
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountId">Bank account ID</param>
/// <param name="pageLimit">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of holding resources</returns>
Task<IbanityCollection<Holding>> List(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Holding
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountId">Bank account ID</param>
/// <param name="id">Holding ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The specified holding resource or 404 if not found</returns>
Task<Holding> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\PaymentInitiationRequestAuthorizations.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IPaymentInitiationRequestAuthorizations" />
public class PaymentInitiationRequestAuthorizations : BasePaymentInitiationRequestAuthorizations<PaymentInitiationRequestAuthorizationRelationships>, IPaymentInitiationRequestAuthorizations
{
private const string ParentEntityName = "payment-initiation-requests";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public PaymentInitiationRequestAuthorizations(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, ParentEntityName)
{ }
/// <inheritdoc />
protected override string GetStatus(PaymentInitiationRequestAuthorizationRelationships relationships) =>
relationships?.PaymentInitiationRequest?.Data?.Attributes?.Status;
}
/// <summary>
/// <p>This object represent the authorization resource. When you perform an Authorization flow using TPP managed authorization flow, you need to create an authorization resource to complete the flow.</p>
/// <p>The attribute queryParameters contains the query parameters returned by the financial institution when the customer is redirected to your configured redirect uri.</p>
/// </summary>
public interface IPaymentInitiationRequestAuthorizations
{
/// <summary>
/// Create bulk payment initiation request authorization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="paymentInitiationRequestId">Payment initiation request ID</param>
/// <param name="requestAuthorization">Details of the request authorization</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created Account Information Access Request Authorization resource</returns>
Task<PaymentAuthorizationResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, Guid paymentInitiationRequestId, RequestAuthorization requestAuthorization, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\PaymentInitiationRequests.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IPaymentInitiationRequests" />
public class PaymentInitiationRequests : ResourceWithParentClient<PaymentInitiationRequestResponse, object, object, object, CustomerAccessToken>, IPaymentInitiationRequests
{
private const string ParentEntityName = "customer/financial-institutions";
private const string EntityName = "payment-initiation-requests";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public PaymentInitiationRequests(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<PaymentInitiationRequestResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, PaymentInitiationRequest paymentInitiationRequest, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (paymentInitiationRequest is null)
throw new ArgumentNullException(nameof(paymentInitiationRequest));
var payload = new JsonApi.Data<PaymentInitiationRequest, object, object, object>
{
Type = "paymentInitiationRequest",
Attributes = paymentInitiationRequest
};
return InternalCreate(token, new[] { financialInstitutionId }, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<PaymentInitiationRequestResponse> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(token, new[] { financialInstitutionId }, id, cancellationToken);
/// <inheritdoc />
public Task Delete(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null) =>
InternalDelete(token, new[] { financialInstitutionId }, id, cancellationToken);
}
/// <summary>
/// <p>This is an object representing a payment initiation request. When you want to initiate payment from one of your customers, you have to create one to start the authorization flow.</p>
/// <p>When creating the payment initiation request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the authorization process. At the end of the flow, they will be returned to the redirect uri that you defined.</p>
/// <p>If the payment initiation is not authorized (for example when the customer cancels the flow), an error query parameter will be added to the redirect uri with the value rejected.</p>
/// <p>When authorizing payment initiation from a financial institution user (in the sandbox), you should use 123456 as the digipass response.</p>
/// </summary>
public interface IPaymentInitiationRequests
{
/// <summary>
/// Create Payment Initiation Request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="paymentInitiationRequest">Details of the payment initiation request</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created payment initiation request resource</returns>
Task<PaymentInitiationRequestResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, PaymentInitiationRequest paymentInitiationRequest, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Payment Initiation Request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="id">Payment Initiation Request ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The specified payment initiation request resource</returns>
Task<PaymentInitiationRequestResponse> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null);
/// <summary>
/// Delete Payment Initiation Request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="id">Payment Initiation Request ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
Task Delete(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\PendingTransactions.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IPendingTransactions" />
public class PendingTransactions : ResourceWithParentClient<PendingTransaction, object, PendingTransactionRelationships, object, CustomerAccessToken>, IPendingTransactions
{
private const string GrandParentEntityName = "customer/financial-institutions";
private const string ParentEntityName = "accounts";
private const string EntityName = "pending-transactions";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public PendingTransactions(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { GrandParentEntityName, ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<IbanityCollection<PendingTransaction>> List(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(token, new[] { financialInstitutionId, accountId }, null, pageLimit, pageBefore, pageAfter, cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<PendingTransaction>> ListUpdatedForSynchronization(CustomerAccessToken token, Guid synchronizationId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(
token ?? throw new ArgumentNullException(nameof(token)),
$"{UrlPrefix}/customer/synchronizations/{synchronizationId}/updated-pending-transactions",
null,
pageLimit,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
public Task<PendingTransaction> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(token, new[] { financialInstitutionId, accountId }, id, cancellationToken);
/// <inheritdoc />
protected override PendingTransaction Map(JsonApi.Data<PendingTransaction, object, PendingTransactionRelationships, object> data)
{
var result = base.Map(data);
result.AccountId = Guid.Parse(data.Relationships.Account.Data.Id);
return result;
}
}
/// <summary>
/// <p>This is an object representing an account pending transaction. This object will give you the details of the financial transaction, including its amount and description.</p>
/// <p>From this object, you can link back to its account.</p>
/// <p>The Pending transaction API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
public interface IPendingTransactions
{
/// <summary>
/// List Pending Transactions
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountId">Bank account ID</param>
/// <param name="pageLimit">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of pending transaction resources</returns>
Task<IbanityCollection<PendingTransaction>> List(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Pending Transactions
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="synchronizationId">Synchronization ID</param>
/// <param name="pageLimit">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of pending transaction resources</returns>
Task<IbanityCollection<PendingTransaction>> ListUpdatedForSynchronization(CustomerAccessToken token, Guid synchronizationId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Pending Transaction
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountId">Bank account ID</param>
/// <param name="id">Pending Transaction ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The specified pending transaction resource or 404 if not found</returns>
Task<PendingTransaction> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\PeriodicPaymentInitiationRequestAuthorizations.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IPeriodicPaymentInitiationRequestAuthorizations" />
public class PeriodicPaymentInitiationRequestAuthorizations : BasePaymentInitiationRequestAuthorizations<PeriodicPaymentInitiationRequestAuthorizationRelationships>, IPeriodicPaymentInitiationRequestAuthorizations
{
private const string ParentEntityName = "periodic-payment-initiation-requests";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public PeriodicPaymentInitiationRequestAuthorizations(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, ParentEntityName)
{ }
/// <inheritdoc />
protected override string GetStatus(PeriodicPaymentInitiationRequestAuthorizationRelationships relationships) =>
relationships?.PeriodicPaymentInitiationRequest?.Data?.Attributes?.Status;
}
/// <summary>
/// <p>This object represent the authorization resource. When you perform an Authorization flow using TPP managed authorization flow, you need to create an authorization resource to complete the flow.</p>
/// <p>The attribute queryParameters contains the query parameters returned by the financial institution when the customer is redirected to your configured redirect uri.</p>
/// </summary>
public interface IPeriodicPaymentInitiationRequestAuthorizations
{
/// <summary>
/// Create bulk payment initiation request authorization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="periodicPaymentInitiationRequestId">Periodic payment initiation request ID</param>
/// <param name="requestAuthorization">Details of the request authorization</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created Account Information Access Request Authorization resource</returns>
Task<PaymentAuthorizationResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, Guid periodicPaymentInitiationRequestId, RequestAuthorization requestAuthorization, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\PeriodicPaymentInitiationRequests.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IPeriodicPaymentInitiationRequests" />
public class PeriodicPaymentInitiationRequests : ResourceWithParentClient<PeriodicPaymentInitiationRequestResponse, object, object, object, CustomerAccessToken>, IPeriodicPaymentInitiationRequests
{
private const string ParentEntityName = "customer/financial-institutions";
private const string EntityName = "periodic-payment-initiation-requests";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public PeriodicPaymentInitiationRequests(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<PeriodicPaymentInitiationRequestResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, PeriodicPaymentInitiationRequest paymentInitiationRequest, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (paymentInitiationRequest is null)
throw new ArgumentNullException(nameof(paymentInitiationRequest));
var payload = new JsonApi.Data<PeriodicPaymentInitiationRequest, object, object, object>
{
Type = "paymentInitiationRequest",
Attributes = paymentInitiationRequest
};
return InternalCreate(token, new[] { financialInstitutionId }, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<PeriodicPaymentInitiationRequestResponse> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(token, new[] { financialInstitutionId }, id, cancellationToken);
/// <inheritdoc />
public Task Delete(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null) =>
InternalDelete(token, new[] { financialInstitutionId }, id, cancellationToken);
}
/// <summary>
/// <p>This is an object representing a payment initiation request. When you want to initiate payment from one of your customers, you have to create one to start the authorization flow.</p>
/// <p>When creating the payment initiation request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the authorization process. At the end of the flow, they will be returned to the redirect uri that you defined.</p>
/// <p>If the payment initiation is not authorized (for example when the customer cancels the flow), an error query parameter will be added to the redirect uri with the value rejected.</p>
/// <p>When authorizing payment initiation from a financial institution user (in the sandbox), you should use 123456 as the digipass response.</p>
/// </summary>
public interface IPeriodicPaymentInitiationRequests
{
/// <summary>
/// Create Periodic Payment Initiation Request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="paymentInitiationRequest">Details of the periodic payment initiation request</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created payment initiation request resource</returns>
Task<PeriodicPaymentInitiationRequestResponse> Create(CustomerAccessToken token, Guid financialInstitutionId, PeriodicPaymentInitiationRequest paymentInitiationRequest, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Periodic Payment Initiation Request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="id">Periodic Payment Initiation Request ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The specified payment initiation request resource</returns>
Task<PeriodicPaymentInitiationRequestResponse> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null);
/// <summary>
/// Delete Periodic Payment Initiation Request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="id">Periodic Payment Initiation Request ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
Task Delete(CustomerAccessToken token, Guid financialInstitutionId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Sandbox.cs | using Ibanity.Apis.Client.Http;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc />
public class Sandbox : ISandbox
{
/// <summary>
/// Product name used as prefix in sandbox URIs.
/// </summary>
public const string UrlPrefix = "sandbox";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
public Sandbox(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider)
{
FinancialInstitutions = new SandboxFinancialInstitutions(apiClient, accessTokenProvider, UrlPrefix);
FinancialInstitutionUsers = new SandboxFinancialInstitutionUsers(apiClient, accessTokenProvider, UrlPrefix);
FinancialInstitutionAccounts = new SandboxFinancialInstitutionAccounts(apiClient, accessTokenProvider, UrlPrefix);
FinancialInstitutionTransactions = new SandboxFinancialInstitutionTransactions(apiClient, accessTokenProvider, UrlPrefix);
FinancialInstitutionHoldings = new SandboxFinancialInstitutionHoldings(apiClient, accessTokenProvider, UrlPrefix);
}
/// <inheritdoc />
public ISandboxFinancialInstitutions FinancialInstitutions { get; }
/// <inheritdoc />
public ISandboxFinancialInstitutionUsers FinancialInstitutionUsers { get; }
/// <inheritdoc />
public ISandboxFinancialInstitutionAccounts FinancialInstitutionAccounts { get; }
/// <inheritdoc />
public ISandboxFinancialInstitutionTransactions FinancialInstitutionTransactions { get; }
/// <inheritdoc />
public ISandboxFinancialInstitutionHoldings FinancialInstitutionHoldings { get; }
}
/// <summary>
/// Fake accounts and transactions.
/// </summary>
public interface ISandbox
{
/// <summary>
/// This is an object representing a financial institution, providing its basic details - including whether it is a sandbox object or not.
/// </summary>
/// <remarks>You can manage fake financial institutions in the sandbox using the create, update, and delete methods. Obviously, these endpoints will not work for real, live financial institutions.</remarks>
ISandboxFinancialInstitutions FinancialInstitutions { get; }
/// <summary>
/// <p>This is an object representing a financial institution user. It is a fake financial institution customer you can create for test purposes.</p>
/// <p>From this object, you can follow the links to its related financial institution accounts and transactions.</p>
/// </summary>
ISandboxFinancialInstitutionUsers FinancialInstitutionUsers { get; }
/// <summary>
/// <p>This is an object representing a financial institution account, a fake account you create for test purposes.</p>
/// <p>In addition to the regular account API calls, there are sandbox-specific endpoints available to manage your sandbox data.</p>
/// <p>A financial institution account belongs to a financial institution user and financial institution and can have many associated financial institution transactions.</p>
/// </summary>
ISandboxFinancialInstitutionAccounts FinancialInstitutionAccounts { get; }
/// <summary>
/// <p>This is an object representing a financial institution transaction, a fake transaction on a fake account you can create for test purposes.</p>
/// <p>In addition to the regular transaction API calls, there are sandbox-specific endpoints available to manage your sandbox data.</p>
/// <p>From this object, you can follow the link to its related financial institution account</p>
/// </summary>
ISandboxFinancialInstitutionTransactions FinancialInstitutionTransactions { get; }
/// <summary>
/// <p>This is an object representing a financial institution holding, a fake holding on a fake securities account you can create for test purposes.</p>
/// <p>In addition to the regular holding API calls, there are sandbox-specific endpoints available to manage your sandbox data.</p>
/// <p>From this object, you can follow the link to its related financial institution account</p>
/// </summary>
ISandboxFinancialInstitutionHoldings FinancialInstitutionHoldings { get; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\SandboxFinancialInstitutionAccounts.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="ISandboxFinancialInstitutionAccounts" />
public class SandboxFinancialInstitutionAccounts : ResourceWithParentClient<SandboxFinancialInstitutionAccountResponse, object, object, object, CustomerAccessToken>, ISandboxFinancialInstitutionAccounts
{
private const string GrandParentEntityName = "financial-institutions";
private const string ParentEntityName = "financial-institution-users";
private const string EntityName = "financial-institution-accounts";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public SandboxFinancialInstitutionAccounts(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { GrandParentEntityName, ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<IbanityCollection<SandboxFinancialInstitutionAccountResponse>> List(Guid financialInstitutionId, Guid financialInstitutionUserId, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(null, new[] { financialInstitutionId, financialInstitutionUserId }, null, pageSize, pageBefore, pageAfter, cancellationToken);
/// <inheritdoc />
public Task<SandboxFinancialInstitutionAccountResponse> Get(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(null, new[] { financialInstitutionId, financialInstitutionUserId }, id, cancellationToken);
/// <inheritdoc />
public Task<SandboxFinancialInstitutionAccountResponse> Create(Guid financialInstitutionId, Guid financialInstitutionUserId, SandboxFinancialInstitutionAccount sandboxFinancialInstitutionAccount, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (sandboxFinancialInstitutionAccount is null)
throw new ArgumentNullException(nameof(sandboxFinancialInstitutionAccount));
var payload = new JsonApi.Data<SandboxFinancialInstitutionAccount, object, object, object>
{
Type = "financialInstitutionAccount",
Attributes = sandboxFinancialInstitutionAccount
};
return InternalCreate(null, new[] { financialInstitutionId, financialInstitutionUserId }, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task Delete(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid id, CancellationToken? cancellationToken = null) =>
InternalDelete(null, new[] { financialInstitutionId, financialInstitutionUserId }, id, cancellationToken);
}
/// <summary>
/// <p>This is an object representing a financial institution account, a fake account you create for test purposes.</p>
/// <p>In addition to the regular account API calls, there are sandbox-specific endpoints available to manage your sandbox data.</p>
/// <p>A financial institution account belongs to a financial institution user and financial institution and can have many associated financial institution transactions.</p>
/// </summary>
public interface ISandboxFinancialInstitutionAccounts
{
/// <summary>
/// List sandbox financial institution accounts
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<IbanityCollection<SandboxFinancialInstitutionAccountResponse>> List(Guid financialInstitutionId, Guid financialInstitutionUserId, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get sandbox financial institution account
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="id">Sandbox financial institution account ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<SandboxFinancialInstitutionAccountResponse> Get(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid id, CancellationToken? cancellationToken = null);
/// <summary>
/// Create sandbox financial institution account
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="sandboxFinancialInstitutionAccount">Details of the sandbox financial institution account</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created sandbox financial institution account resource</returns>
Task<SandboxFinancialInstitutionAccountResponse> Create(Guid financialInstitutionId, Guid financialInstitutionUserId, SandboxFinancialInstitutionAccount sandboxFinancialInstitutionAccount, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Delete sandbox financial institution account
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="id">Sandbox financial institution account ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
Task Delete(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\SandboxFinancialInstitutionHoldings.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="ISandboxFinancialInstitutionHoldings" />
public class SandboxFinancialInstitutionHoldings : ResourceWithParentClient<SandboxFinancialInstitutionHoldingResponse, object, object, object, CustomerAccessToken>, ISandboxFinancialInstitutionHoldings
{
private const string GrandGrandParentEntityName = "financial-institutions";
private const string GrandParentEntityName = "financial-institution-users";
private const string ParentEntityName = "financial-institution-accounts";
private const string EntityName = "financial-institution-holdings";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public SandboxFinancialInstitutionHoldings(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { GrandGrandParentEntityName, GrandParentEntityName, ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<IbanityCollection<SandboxFinancialInstitutionHoldingResponse>> List(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(null, new[] { financialInstitutionId, financialInstitutionUserId, financialInstitutionAccountId }, null, pageSize, pageBefore, pageAfter, cancellationToken);
/// <inheritdoc />
public Task<SandboxFinancialInstitutionHoldingResponse> Get(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(null, new[] { financialInstitutionId, financialInstitutionUserId, financialInstitutionAccountId }, id, cancellationToken);
/// <inheritdoc />
public Task<SandboxFinancialInstitutionHoldingResponse> Create(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, SandboxFinancialInstitutionHolding sandboxFinancialInstitutionHolding, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (sandboxFinancialInstitutionHolding is null)
throw new ArgumentNullException(nameof(sandboxFinancialInstitutionHolding));
var payload = new JsonApi.Data<SandboxFinancialInstitutionHolding, object, object, object>
{
Type = "financialInstitutionHolding",
Attributes = sandboxFinancialInstitutionHolding
};
return InternalCreate(null, new[] { financialInstitutionId, financialInstitutionUserId, financialInstitutionAccountId }, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<SandboxFinancialInstitutionHoldingResponse> Update(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, Guid id, SandboxFinancialInstitutionHolding sandboxFinancialInstitutionHolding, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (sandboxFinancialInstitutionHolding is null)
throw new ArgumentNullException(nameof(sandboxFinancialInstitutionHolding));
var payload = new JsonApi.Data<SandboxFinancialInstitutionHolding, object, object, object>
{
Type = "financialInstitutionTransaction",
Attributes = sandboxFinancialInstitutionHolding
};
return InternalUpdate(null, new[] { financialInstitutionId, financialInstitutionUserId, financialInstitutionAccountId }, id, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task Delete(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, Guid id, CancellationToken? cancellationToken = null) =>
InternalDelete(null, new[] { financialInstitutionId, financialInstitutionUserId, financialInstitutionAccountId }, id, cancellationToken);
}
/// <summary>
/// <p>This is an object representing a financial institution holding, a fake holding on a fake securities account you can create for test purposes.</p>
/// <p>In addition to the regular holding API calls, there are sandbox-specific endpoints available to manage your sandbox data.</p>
/// <p>From this object, you can follow the link to its related financial institution account</p>
/// </summary>
public interface ISandboxFinancialInstitutionHoldings
{
/// <summary>
/// List sandbox financial institution holdings
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="financialInstitutionAccountId">Financial institution account ID</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<IbanityCollection<SandboxFinancialInstitutionHoldingResponse>> List(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get sandbox financial institution holding
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="financialInstitutionAccountId">Financial institution account ID</param>
/// <param name="id">Sandbox financial institution holding ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<SandboxFinancialInstitutionHoldingResponse> Get(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, Guid id, CancellationToken? cancellationToken = null);
/// <summary>
/// Create sandbox financial institution holding
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="financialInstitutionAccountId">Financial institution account ID</param>
/// <param name="sandboxFinancialInstitutionHolding">Details of the sandbox financial institution holding</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created sandbox financial institution holding resource</returns>
Task<SandboxFinancialInstitutionHoldingResponse> Create(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, SandboxFinancialInstitutionHolding sandboxFinancialInstitutionHolding, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Delete sandbox financial institution holding
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="financialInstitutionAccountId">Financial institution account ID</param>
/// <param name="id">Sandbox financial institution holding ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
Task Delete(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\SandboxFinancialInstitutions.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="ISandboxFinancialInstitutions" />
public class SandboxFinancialInstitutions : ResourceClient<FinancialInstitution, object, object, object, CustomerAccessToken>, ISandboxFinancialInstitutions
{
private const string EntityName = "financial-institutions";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public SandboxFinancialInstitutions(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, EntityName)
{ }
/// <inheritdoc />
public Task<FinancialInstitution> Create(SandboxFinancialInstitution sandboxFinancialInstitution, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (sandboxFinancialInstitution is null)
throw new ArgumentNullException(nameof(sandboxFinancialInstitution));
var payload = new JsonApi.Data<SandboxFinancialInstitution, object, object, object>
{
Type = "financialInstitution",
Attributes = sandboxFinancialInstitution
};
return InternalCreate(null, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task Delete(Guid id, CancellationToken? cancellationToken = null) =>
InternalDelete(null, id, cancellationToken);
/// <inheritdoc />
public Task<FinancialInstitution> Update(Guid id, SandboxFinancialInstitution sandboxFinancialInstitution, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (sandboxFinancialInstitution is null)
throw new ArgumentNullException(nameof(sandboxFinancialInstitution));
var payload = new JsonApi.Data<SandboxFinancialInstitution, object, object, object>
{
Type = "financialInstitution",
Attributes = sandboxFinancialInstitution
};
return InternalUpdate(null, id, payload, idempotencyKey, cancellationToken);
}
}
/// <summary>
/// This is an object representing a financial institution, providing its basic details - including whether it is a sandbox object or not.
/// </summary>
/// <remarks>You can manage fake financial institutions in the sandbox using the create, update, and delete methods. Obviously, these endpoints will not work for real, live financial institutions.</remarks>
public interface ISandboxFinancialInstitutions
{
/// <summary>
/// Create sandbox financial institution
/// </summary>
/// <param name="sandboxFinancialInstitution">Details of the sandbox financial institution</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created sandbox financial institution resource</returns>
Task<FinancialInstitution> Create(SandboxFinancialInstitution sandboxFinancialInstitution, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Update sandbox financial institution
/// </summary>
/// <param name="id">Sandbox financial institution ID</param>
/// <param name="sandboxFinancialInstitution">Details of the sandbox financial institution</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created sandbox financial institution resource</returns>
Task<FinancialInstitution> Update(Guid id, SandboxFinancialInstitution sandboxFinancialInstitution, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Delete sandbox financial institution
/// </summary>
/// <param name="id">Sandbox financial institution ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
Task Delete(Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\SandboxFinancialInstitutionTransactions.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="ISandboxFinancialInstitutionTransactions" />
public class SandboxFinancialInstitutionTransactions : ResourceWithParentClient<SandboxFinancialInstitutionTransactionResponse, object, object, object, CustomerAccessToken>, ISandboxFinancialInstitutionTransactions
{
private const string GrandGrandParentEntityName = "financial-institutions";
private const string GrandParentEntityName = "financial-institution-users";
private const string ParentEntityName = "financial-institution-accounts";
private const string EntityName = "financial-institution-transactions";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public SandboxFinancialInstitutionTransactions(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { GrandGrandParentEntityName, GrandParentEntityName, ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<IbanityCollection<SandboxFinancialInstitutionTransactionResponse>> List(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(null, new[] { financialInstitutionId, financialInstitutionUserId, financialInstitutionAccountId }, null, pageSize, pageBefore, pageAfter, cancellationToken);
/// <inheritdoc />
public Task<SandboxFinancialInstitutionTransactionResponse> Get(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(null, new[] { financialInstitutionId, financialInstitutionUserId, financialInstitutionAccountId }, id, cancellationToken);
/// <inheritdoc />
public Task<SandboxFinancialInstitutionTransactionResponse> Create(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, SandboxFinancialInstitutionTransaction sandboxFinancialInstitutionTransaction, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (sandboxFinancialInstitutionTransaction is null)
throw new ArgumentNullException(nameof(sandboxFinancialInstitutionTransaction));
var payload = new JsonApi.Data<SandboxFinancialInstitutionTransaction, object, object, object>
{
Type = "financialInstitutionTransaction",
Attributes = sandboxFinancialInstitutionTransaction
};
return InternalCreate(null, new[] { financialInstitutionId, financialInstitutionUserId, financialInstitutionAccountId }, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<SandboxFinancialInstitutionTransactionResponse> Update(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, Guid id, SandboxFinancialInstitutionTransaction sandboxFinancialInstitutionTransaction, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (sandboxFinancialInstitutionTransaction is null)
throw new ArgumentNullException(nameof(sandboxFinancialInstitutionTransaction));
var payload = new JsonApi.Data<SandboxFinancialInstitutionTransaction, object, object, object>
{
Type = "financialInstitutionTransaction",
Attributes = sandboxFinancialInstitutionTransaction
};
return InternalUpdate(null, new[] { financialInstitutionId, financialInstitutionUserId, financialInstitutionAccountId }, id, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task Delete(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, Guid id, CancellationToken? cancellationToken = null) =>
InternalDelete(null, new[] { financialInstitutionId, financialInstitutionUserId, financialInstitutionAccountId }, id, cancellationToken);
}
/// <summary>
/// <p>This is an object representing a financial institution transaction, a fake transaction on a fake account you can create for test purposes.</p>
/// <p>In addition to the regular transaction API calls, there are sandbox-specific endpoints available to manage your sandbox data.</p>
/// <p>From this object, you can follow the link to its related financial institution account</p>
/// </summary>
public interface ISandboxFinancialInstitutionTransactions
{
/// <summary>
/// List sandbox financial institution transactions
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="financialInstitutionAccountId">Financial institution account ID</param>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<IbanityCollection<SandboxFinancialInstitutionTransactionResponse>> List(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get sandbox financial institution transaction
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="financialInstitutionAccountId">Financial institution account ID</param>
/// <param name="id">Sandbox financial institution transaction ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<SandboxFinancialInstitutionTransactionResponse> Get(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, Guid id, CancellationToken? cancellationToken = null);
/// <summary>
/// Create sandbox financial institution transaction
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="financialInstitutionAccountId">Financial institution account ID</param>
/// <param name="sandboxFinancialInstitutionTransaction">Details of the sandbox financial institution transaction</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created sandbox financial institution transaction resource</returns>
Task<SandboxFinancialInstitutionTransactionResponse> Create(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, SandboxFinancialInstitutionTransaction sandboxFinancialInstitutionTransaction, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Update sandbox financial institution transaction
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="financialInstitutionAccountId">Financial institution account ID</param>
/// <param name="id">Financial institution transaction ID</param>
/// <param name="sandboxFinancialInstitutionTransaction">Details of the sandbox financial institution transaction</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created sandbox financial institution transaction resource</returns>
Task<SandboxFinancialInstitutionTransactionResponse> Update(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, Guid id, SandboxFinancialInstitutionTransaction sandboxFinancialInstitutionTransaction, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Delete sandbox financial institution transaction
/// </summary>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="financialInstitutionUserId">Financial institution user ID</param>
/// <param name="financialInstitutionAccountId">Financial institution account ID</param>
/// <param name="id">Sandbox financial institution transaction ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
Task Delete(Guid financialInstitutionId, Guid financialInstitutionUserId, Guid financialInstitutionAccountId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\SandboxFinancialInstitutionUsers.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="ISandboxFinancialInstitutionUsers" />
public class SandboxFinancialInstitutionUsers : ResourceClient<SandboxFinancialInstitutionUserResponse, object, object, object, CustomerAccessToken>, ISandboxFinancialInstitutionUsers
{
private const string EntityName = "financial-institution-users";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public SandboxFinancialInstitutionUsers(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, EntityName)
{ }
/// <inheritdoc />
public Task<IbanityCollection<SandboxFinancialInstitutionUserResponse>> List(int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(null, null, pageSize, pageBefore, pageAfter, cancellationToken);
/// <inheritdoc />
public Task<SandboxFinancialInstitutionUserResponse> Get(Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(null, id, cancellationToken);
/// <inheritdoc />
public Task<SandboxFinancialInstitutionUserResponse> Create(SandboxFinancialInstitutionUser sandboxFinancialInstitutionUser, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (sandboxFinancialInstitutionUser is null)
throw new ArgumentNullException(nameof(sandboxFinancialInstitutionUser));
var payload = new JsonApi.Data<SandboxFinancialInstitutionUser, object, object, object>
{
Type = "financialInstitutionUser",
Attributes = sandboxFinancialInstitutionUser
};
return InternalCreate(null, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<SandboxFinancialInstitutionUserResponse> Update(Guid id, SandboxFinancialInstitutionUser sandboxFinancialInstitutionUser, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (sandboxFinancialInstitutionUser is null)
throw new ArgumentNullException(nameof(sandboxFinancialInstitutionUser));
var payload = new JsonApi.Data<SandboxFinancialInstitutionUser, object, object, object>
{
Type = "financialInstitutionUser",
Attributes = sandboxFinancialInstitutionUser
};
return InternalUpdate(null, id, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task Delete(Guid id, CancellationToken? cancellationToken = null) =>
InternalDelete(null, id, cancellationToken);
}
/// <summary>
/// <p>This is an object representing a financial institution user. It is a fake financial institution customer you can create for test purposes.</p>
/// <p>From this object, you can follow the links to its related financial institution accounts and transactions.</p>
/// </summary>
public interface ISandboxFinancialInstitutionUsers
{
/// <summary>
/// List sandbox financial institution users
/// </summary>
/// <param name="pageSize">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<IbanityCollection<SandboxFinancialInstitutionUserResponse>> List(int? pageSize = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get sandbox financial institution user
/// </summary>
/// <param name="id">Sandbox financial institution User ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of financial institution resources</returns>
Task<SandboxFinancialInstitutionUserResponse> Get(Guid id, CancellationToken? cancellationToken = null);
/// <summary>
/// Create sandbox financial institution user
/// </summary>
/// <param name="sandboxFinancialInstitutionUser">Details of the sandbox financial institution user</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created sandbox financial institution user resource</returns>
Task<SandboxFinancialInstitutionUserResponse> Create(SandboxFinancialInstitutionUser sandboxFinancialInstitutionUser, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Update sandbox financial institution user
/// </summary>
/// <param name="id">Sandbox financial institution user ID</param>
/// <param name="sandboxFinancialInstitutionUser">Details of the sandbox financial institution user</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The created sandbox financial institution user resource</returns>
Task<SandboxFinancialInstitutionUserResponse> Update(Guid id, SandboxFinancialInstitutionUser sandboxFinancialInstitutionUser, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Delete sandbox financial institution user
/// </summary>
/// <param name="id">Sandbox financial institution user ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
Task Delete(Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Synchronizations.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="ISynchronizations" />
public class Synchronizations : ResourceClient<SynchronizationResponse, object, object, object, CustomerAccessToken>, ISynchronizations
{
private const string EntityName = "customer/synchronizations";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public Synchronizations(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, EntityName)
{ }
/// <inheritdoc />
public Task<SynchronizationResponse> Create(CustomerAccessToken token, SynchronizationRequest synchronization, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (synchronization is null)
throw new ArgumentNullException(nameof(synchronization));
var payload = new JsonApi.Data<SynchronizationRequest, object, object, object>
{
Type = "synchronization",
Attributes = synchronization
};
return InternalCreate(token, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<SynchronizationResponse> Get(CustomerAccessToken token, Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(token, id, cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<SynchronizationResponse>> List(CustomerAccessToken token, Guid financialInstitutionId, Guid accountInformationAccessRequestsId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(
token,
$"{UrlPrefix}/customer/financial-institutions/{financialInstitutionId}/account-information-access-requests/{accountInformationAccessRequestsId}/initial-account-transactions-synchronizations",
null,
pageLimit,
pageBefore,
pageAfter,
cancellationToken);
}
/// <summary>
/// <p>This is an object representing a resource synchronization. This object will give you the details of the synchronization, including its resource, type, and status.</p>
/// <p>The synchronization API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
public interface ISynchronizations
{
/// <summary>
/// Create Synchronization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="synchronization">Details of the synchronization, including its resource, type, and status</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A synchronization resource</returns>
Task<SynchronizationResponse> Create(CustomerAccessToken token, SynchronizationRequest synchronization, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Synchronization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="id">ID of the synchronization</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A synchronization resource</returns>
Task<SynchronizationResponse> Get(CustomerAccessToken token, Guid id, CancellationToken? cancellationToken = null);
/// <summary>
/// List Initial Account Transactions Synchronization for Account Information Access Request
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountInformationAccessRequestsId">Account information access requests ID</param>
/// <param name="pageLimit">Maximum number (1-100) of resources that might be returned. It is possible that the response contains fewer elements. Defaults to 10</param>
/// <param name="pageBefore">Cursor for pagination. Indicates that the API should return the synchronization resources which are immediately before this one in the list (the previous page)</param>
/// <param name="pageAfter">Cursor for pagination. Indicates that the API should return the synchronization resources which are immediately after this one in the list (the next page)</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of initiation account's transactions synchronization resources related to the account information access request</returns>
Task<IbanityCollection<SynchronizationResponse>> List(CustomerAccessToken token, Guid financialInstitutionId, Guid accountInformationAccessRequestsId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\TransactionDeleteRequests.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.JsonApi;
using Ibanity.Apis.Client.Products.XS2A.Models;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="ITransactionDeleteRequests" />
public class TransactionDeleteRequests : ResourceClient<TransactionDeleteRequestResponse, object, object, object, CustomerAccessToken>, ITransactionDeleteRequests
{
private const string EntityName = "transaction-delete-requests";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public TransactionDeleteRequests(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, EntityName)
{ }
/// <inheritdoc />
public Task<TransactionDeleteRequestResponse> CreateForApplication(TransactionDeleteRequest transactionDeleteRequest, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (transactionDeleteRequest is null)
throw new ArgumentNullException(nameof(transactionDeleteRequest));
var payload = new JsonApi.Data<TransactionDeleteRequest, object, object, object>
{
Type = "transactionDeleteRequest",
Attributes = transactionDeleteRequest
};
return InternalCreate(null, payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<TransactionDeleteRequestResponse> CreateForCustomer(CustomerAccessToken token, TransactionDeleteRequest transactionDeleteRequest, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (transactionDeleteRequest is null)
throw new ArgumentNullException(nameof(transactionDeleteRequest));
var payload = new JsonApi.Data<TransactionDeleteRequest, object, object, object>
{
Type = "transactionDeleteRequest",
Attributes = transactionDeleteRequest
};
return InternalCreate(token, $"{UrlPrefix}/customer/{EntityName}", payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
public Task<TransactionDeleteRequestResponse> CreateForAccount(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, TransactionDeleteRequest transactionDeleteRequest, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null)
{
if (token is null)
throw new ArgumentNullException(nameof(token));
if (transactionDeleteRequest is null)
throw new ArgumentNullException(nameof(transactionDeleteRequest));
var payload = new JsonApi.Data<TransactionDeleteRequest, object, object, object>
{
Type = "transactionDeleteRequest",
Attributes = transactionDeleteRequest
};
return InternalCreate(token, $"{UrlPrefix}/customer/financial-institutions/{financialInstitutionId}/accounts/{accountId}/{EntityName}", payload, idempotencyKey, cancellationToken);
}
/// <inheritdoc />
protected override TransactionDeleteRequestResponse Map(Data<TransactionDeleteRequestResponse, object, object, object> data)
{
if (data.Attributes == null)
data.Attributes = new TransactionDeleteRequestResponse();
return base.Map(data);
}
}
/// <summary>
/// This is an object representing a resource transaction-delete-request. This object will give you the details of the transaction-delete-request.
/// </summary>
public interface ITransactionDeleteRequests
{
/// <summary>
/// Create Transaction Delete Request For Application
/// </summary>
/// <param name="transactionDeleteRequest">Details of the transaction-delete-request</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A transaction delete request resource</returns>
Task<TransactionDeleteRequestResponse> CreateForApplication(TransactionDeleteRequest transactionDeleteRequest, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Create Transaction Delete Request For Customer
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="transactionDeleteRequest">Details of the transaction-delete-request</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A transaction delete request resource</returns>
Task<TransactionDeleteRequestResponse> CreateForCustomer(CustomerAccessToken token, TransactionDeleteRequest transactionDeleteRequest, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Create Transaction Delete Request For Account
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountId">Bank account ID</param>
/// <param name="transactionDeleteRequest">Details of the transaction-delete-request</param>
/// <param name="idempotencyKey">Several requests with the same idempotency key will be executed only once</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A transaction delete request resource</returns>
Task<TransactionDeleteRequestResponse> CreateForAccount(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, TransactionDeleteRequest transactionDeleteRequest, Guid? idempotencyKey = null, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Transactions.cs | using System;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
using Ibanity.Apis.Client.Products.XS2A.Models;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="ITransactions" />
public class Transactions : ResourceWithParentClient<Transaction, object, TransactionRelationships, object, CustomerAccessToken>, ITransactions
{
private const string GrandParentEntityName = "customer/financial-institutions";
private const string ParentEntityName = "accounts";
private const string EntityName = "transactions";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="accessTokenProvider">Service to refresh access tokens</param>
/// <param name="urlPrefix">Beginning of URIs, composed by Ibanity API endpoint, followed by product name</param>
public Transactions(IApiClient apiClient, IAccessTokenProvider<CustomerAccessToken> accessTokenProvider, string urlPrefix) :
base(apiClient, accessTokenProvider, urlPrefix, new[] { GrandParentEntityName, ParentEntityName, EntityName })
{ }
/// <inheritdoc />
public Task<IbanityCollection<Transaction>> List(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(token, new[] { financialInstitutionId, accountId }, null, pageLimit, pageBefore, pageAfter, cancellationToken);
/// <inheritdoc />
public Task<IbanityCollection<Transaction>> ListUpdatedForSynchronization(CustomerAccessToken token, Guid synchronizationId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null) =>
InternalCursorBasedList(
token,
$"customer/synchronizations/{synchronizationId}/updated-transactions",
null,
pageLimit,
pageBefore,
pageAfter,
cancellationToken);
/// <inheritdoc />
public Task<Transaction> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, Guid id, CancellationToken? cancellationToken = null) =>
InternalGet(token, new[] { financialInstitutionId, accountId }, id, cancellationToken);
/// <inheritdoc />
protected override Transaction Map(JsonApi.Data<Transaction, object, TransactionRelationships, object> data)
{
var result = base.Map(data);
result.AccountId = Guid.Parse(data.Relationships.Account.Data.Id);
return result;
}
}
/// <summary>
/// <p>This is an object representing an account transaction. This object will give you the details of the financial transaction, including its amount and description.</p>
/// <p>From this object, you can link back to its account.</p>
/// <p>The transaction API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
public interface ITransactions
{
/// <summary>
/// List Transactions
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountId">Bank account ID</param>
/// <param name="pageLimit">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of transaction resources</returns>
Task<IbanityCollection<Transaction>> List(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// List Updated Transactions for Synchronization
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="synchronizationId">Synchronization ID</param>
/// <param name="pageLimit">Number of items by page</param>
/// <param name="pageBefore">Cursor that specifies the first resource of the next page</param>
/// <param name="pageAfter">Cursor that specifies the last resource of the previous page</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>A list of transaction resources updated during the synchronization</returns>
Task<IbanityCollection<Transaction>> ListUpdatedForSynchronization(CustomerAccessToken token, Guid synchronizationId, int? pageLimit = null, Guid? pageBefore = null, Guid? pageAfter = null, CancellationToken? cancellationToken = null);
/// <summary>
/// Get Transaction
/// </summary>
/// <param name="token">Authentication token</param>
/// <param name="financialInstitutionId">Financial institution ID</param>
/// <param name="accountId">Bank account ID</param>
/// <param name="id">Transaction ID</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The specified transaction resource or 404 if not found</returns>
Task<Transaction> Get(CustomerAccessToken token, Guid financialInstitutionId, Guid accountId, Guid id, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products | raw_data\ibanity-dotnet\src\Client\Products\XS2A\XS2AClient.cs | using Ibanity.Apis.Client.Http;
namespace Ibanity.Apis.Client.Products.XS2A
{
/// <inheritdoc cref="IXS2AClient" />
public class XS2AClient : ProductClient<ITokenProviderWithoutCodeVerifier>, IXS2AClient
{
/// <summary>
/// Product name used as prefix in XS2A URIs.
/// </summary>
public const string UrlPrefix = "xs2a";
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
/// <param name="tokenService">Service to generate and refresh access tokens</param>
/// <param name="clientAccessTokenService">Service to generate and refresh client access tokens.</param>
/// <param name="customerTokenService">Service to generate and refresh customer access tokens.</param>
public XS2AClient(IApiClient apiClient, ITokenProviderWithoutCodeVerifier tokenService, IClientAccessTokenProvider clientAccessTokenService, ICustomerAccessTokenProvider customerTokenService)
: base(apiClient, tokenService, clientAccessTokenService, customerTokenService)
{
Customers = new Customers(apiClient, customerTokenService, UrlPrefix);
FinancialInstitutions = new FinancialInstitutions(apiClient, customerTokenService, UrlPrefix);
FinancialInstitutionCountries = new FinancialInstitutionCountries(apiClient, customerTokenService, UrlPrefix);
Synchronizations = new Synchronizations(apiClient, customerTokenService, UrlPrefix);
BatchSynchronizations = new BatchSynchronizations(apiClient, customerTokenService, UrlPrefix);
AccountInformationAccessRequests = new AccountInformationAccessRequests(apiClient, customerTokenService, UrlPrefix);
AccountInformationAccessRequestAuthorizations = new AccountInformationAccessRequestAuthorizations(apiClient, customerTokenService, UrlPrefix);
Accounts = new Accounts(apiClient, customerTokenService, UrlPrefix);
Transactions = new Transactions(apiClient, customerTokenService, UrlPrefix);
PendingTransactions = new PendingTransactions(apiClient, customerTokenService, UrlPrefix);
Holdings = new Holdings(apiClient, customerTokenService, UrlPrefix);
BulkPaymentInitiationRequests = new BulkPaymentInitiationRequests(apiClient, customerTokenService, UrlPrefix);
BulkPaymentInitiationRequestAuthorizations = new BulkPaymentInitiationRequestAuthorizations(apiClient, customerTokenService, UrlPrefix);
PaymentInitiationRequests = new PaymentInitiationRequests(apiClient, customerTokenService, UrlPrefix);
PaymentInitiationRequestAuthorizations = new PaymentInitiationRequestAuthorizations(apiClient, customerTokenService, UrlPrefix);
PeriodicPaymentInitiationRequests = new PeriodicPaymentInitiationRequests(apiClient, customerTokenService, UrlPrefix);
PeriodicPaymentInitiationRequestAuthorizations = new PeriodicPaymentInitiationRequestAuthorizations(apiClient, customerTokenService, UrlPrefix);
TransactionDeleteRequests = new TransactionDeleteRequests(apiClient, customerTokenService, UrlPrefix);
Sandbox = new Sandbox(apiClient, customerTokenService);
}
/// <inheritdoc />
public ICustomers Customers { get; }
/// <inheritdoc />
public IFinancialInstitutions FinancialInstitutions { get; }
/// <inheritdoc />
public IFinancialInstitutionCountries FinancialInstitutionCountries { get; }
/// <inheritdoc />
public ISynchronizations Synchronizations { get; }
/// <inheritdoc />
public IBatchSynchronizations BatchSynchronizations { get; }
/// <inheritdoc />
public IAccountInformationAccessRequests AccountInformationAccessRequests { get; }
/// <inheritdoc />
public IAccountInformationAccessRequestAuthorizations AccountInformationAccessRequestAuthorizations { get; }
/// <inheritdoc />
public IAccounts Accounts { get; }
/// <inheritdoc />
public ITransactions Transactions { get; }
/// <inheritdoc />
public IPendingTransactions PendingTransactions { get; }
/// <inheritdoc />
public IHoldings Holdings { get; }
/// <inheritdoc />
public IBulkPaymentInitiationRequests BulkPaymentInitiationRequests { get; }
/// <inheritdoc />
public IBulkPaymentInitiationRequestAuthorizations BulkPaymentInitiationRequestAuthorizations { get; }
/// <inheritdoc />
public IPaymentInitiationRequests PaymentInitiationRequests { get; }
/// <inheritdoc />
public IPaymentInitiationRequestAuthorizations PaymentInitiationRequestAuthorizations { get; }
/// <inheritdoc />
public IPeriodicPaymentInitiationRequests PeriodicPaymentInitiationRequests { get; }
/// <inheritdoc />
public IPeriodicPaymentInitiationRequestAuthorizations PeriodicPaymentInitiationRequestAuthorizations { get; }
/// <inheritdoc />
public ITransactionDeleteRequests TransactionDeleteRequests { get; }
/// <inheritdoc />
public ISandbox Sandbox { get; }
}
/// <summary>
/// Contains services for all XS2A-related resources.
/// </summary>
public interface IXS2AClient : IProductClientWithCustomerAccessToken
{
/// <summary>
/// <p>This is an object representing a customer. A customer resource is created with the creation of a related customer access token.</p>
/// <p>In the case that the contractual relationship between you and your customer is terminated, you should probably use the Delete Customer endpoint to erase ALL customer personal data.</p>
/// <p>In the case that your customer wants to revoke your access to some accounts, you should use the Delete Account endpoint instead.</p>
/// </summary>
ICustomers Customers { get; }
/// <summary>
/// This is an object representing a financial institution, providing its basic details - including whether it is a sandbox object or not.
/// </summary>
/// <remarks>You can manage fake financial institutions in the sandbox using the create, update, and delete methods. Obviously, these endpoints will not work for real, live financial institutions.</remarks>
IFinancialInstitutions FinancialInstitutions { get; }
/// <summary>
/// This endpoint provides a list of the unique countries for which there are financial institutions available in the list financial institutions endpoint. These codes can be used to filter the financial institutions by country.
/// </summary>
IFinancialInstitutionCountries FinancialInstitutionCountries { get; }
/// <summary>
/// <p>This is an object representing a resource synchronization. This object will give you the details of the synchronization, including its resource, type, and status.</p>
/// <p>The synchronization API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
ISynchronizations Synchronizations { get; }
/// <summary>
/// This is an object representing a resource batch-synchronization. This object will give you the details of the batch-synchronization.
/// </summary>
IBatchSynchronizations BatchSynchronizations { get; }
/// <summary>
/// <p>This is an object representing an account information access request. When you want to access the account information of one of your customers, you have to create one to start the authorization flow.</p>
/// <p>When creating the account information access request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the authorization process. At the end of the flow, they will be returned to the redirect uri that you defined.</p>
/// <p>If the access request is not authorized (for example when the customer cancels the flow), an error query parameter will be added to the redirect uri. The possible values of this parameter are access_denied and unsupported_multi_currency_account.</p>
/// <p>When authorizing account access by a financial institution user (in the sandbox), you should use 123456 as the digipass response. You can also use the Ibanity Sandbox Authorization Portal CLI to automate this authorization.</p>
/// </summary>
IAccountInformationAccessRequests AccountInformationAccessRequests { get; }
/// <summary>
/// <p>This object represent the authorization resource. When you perform an Authorization flow using TPP managed authorization flow, you need to create an authorization resource to complete the flow.</p>
/// <p>The attribute queryParameters contains the query parameters returned by the financial institution when the customer is redirected to your configured redirect uri.</p>
/// </summary>
IAccountInformationAccessRequestAuthorizations AccountInformationAccessRequestAuthorizations { get; }
/// <summary>
/// <p>This is an object representing a customer account. This object will provide details about the account, including the balance and the currency.</p>
/// <p>An account has related transactions and belongs to a financial institution.</p>
/// <p>The account API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
IAccounts Accounts { get; }
/// <summary>
/// <p>This is an object representing an account transaction. This object will give you the details of the financial transaction, including its amount and description.</p>
/// <p>From this object, you can link back to its account.</p>
/// <p>The transaction API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
ITransactions Transactions { get; }
/// <summary>
/// <p>This is an object representing an account pending transaction. This object will give you the details of the financial transaction, including its amount and description.</p>
/// <p>From this object, you can link back to its account.</p>
/// <p>The Pending transaction API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
IPendingTransactions PendingTransactions { get; }
/// <summary>
/// <p>This is an object representing an account holding. This object will give you the details of the financial holding</p>
/// <p>From this object, you can link back to its account.</p>
/// <p>The Holding API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
IHoldings Holdings { get; }
/// <summary>
/// This is an object representing a bulk payment initiation request. When you want to request the initiation of payments on behalf of one of your customers, you can create one to start the authorization flow.
/// </summary>
IBulkPaymentInitiationRequests BulkPaymentInitiationRequests { get; }
/// <summary>
/// <p>This object represent the authorization resource. When you perform an Authorization flow using TPP managed authorization flow, you need to create an authorization resource to complete the flow.</p>
/// <p>The attribute queryParameters contains the query parameters returned by the financial institution when the customer is redirected to your configured redirect uri.</p>
/// </summary>
IBulkPaymentInitiationRequestAuthorizations BulkPaymentInitiationRequestAuthorizations { get; }
/// <summary>
/// <p>This is an object representing a payment initiation request. When you want to initiate payment from one of your customers, you have to create one to start the authorization flow.</p>
/// <p>When creating the payment initiation request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the authorization process. At the end of the flow, they will be returned to the redirect uri that you defined.</p>
/// <p>If the payment initiation is not authorized (for example when the customer cancels the flow), an error query parameter will be added to the redirect uri with the value rejected.</p>
/// <p>When authorizing payment initiation from a financial institution user (in the sandbox), you should use 123456 as the digipass response.</p>
/// </summary>
IPaymentInitiationRequests PaymentInitiationRequests { get; }
/// <summary>
/// <p>This object represent the authorization resource. When you perform an Authorization flow using TPP managed authorization flow, you need to create an authorization resource to complete the flow.</p>
/// <p>The attribute queryParameters contains the query parameters returned by the financial institution when the customer is redirected to your configured redirect uri.</p>
/// </summary>
IPaymentInitiationRequestAuthorizations PaymentInitiationRequestAuthorizations { get; }
/// <summary>
/// <p>This is an object representing a periodic payment initiation request. When you want to initiate periodic payment from one of your customers, you have to create one to start the authorization flow.</p>
/// <p>When creating the periodic payment initiation request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the authorization process. At the end of the flow, they will be returned to the redirect uri that you defined.</p>
/// <p>If the periodic payment initiation is not authorized (for example when the customer cancels the flow), an error query parameter will be added to the redirect uri with the value rejected.</p>
/// <p>When authorizing periodic payment initiation from a financial institution user (in the sandbox), you should use 123456 as the digipass response.</p>
/// </summary>
IPeriodicPaymentInitiationRequests PeriodicPaymentInitiationRequests { get; }
/// <summary>
/// <p>This object represent the authorization resource. When you perform an Authorization flow using TPP managed authorization flow, you need to create an authorization resource to complete the flow.</p>
/// <p>The attribute queryParameters contains the query parameters returned by the financial institution when the customer is redirected to your configured redirect uri.</p>
/// </summary>
IPeriodicPaymentInitiationRequestAuthorizations PeriodicPaymentInitiationRequestAuthorizations { get; }
/// <summary>
/// <p>This is an object representing an account transaction delete request.</p>
/// <p>The transaction delete request API endpoints can be issued at the level of the application (all customers), a specific customer (all hiis/her accounts), or at account level. The customer access token is therefore only necessary for customer or account.</p>
/// </summary>
ITransactionDeleteRequests TransactionDeleteRequests { get; }
/// <summary>
/// Fake accounts and transactions.
/// </summary>
ISandbox Sandbox { get; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\Account.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing a customer account. This object will provide details about the account, including the balance and the currency.</p>
/// <p>An account has related transactions and belongs to a financial institution.</p>
/// <p>The account API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
[DataContract]
public class Account
{
/// <summary>
/// When the authorization towards the account is expected to end. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When the authorization towards the account is expected to end. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "authorizationExpirationExpectedAt", EmitDefaultValue = false)]
public DateTimeOffset? AuthorizationExpirationExpectedAt { get; set; }
/// <summary>
/// When the account was authorized for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When the account was authorized for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "authorizedAt", EmitDefaultValue = false)]
public DateTimeOffset AuthorizedAt { get; set; }
/// <summary>
/// Amount of account funds that can be accessed immediately
/// </summary>
/// <value>Amount of account funds that can be accessed immediately</value>
[DataMember(Name = "availableBalance", EmitDefaultValue = false)]
public decimal AvailableBalance { get; set; }
/// <summary>
/// When the available balance was changed for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When the available balance was changed for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "availableBalanceChangedAt", EmitDefaultValue = false)]
public DateTimeOffset AvailableBalanceChangedAt { get; set; }
/// <summary>
/// Reference date of the available balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>Reference date of the available balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "availableBalanceReferenceDate", EmitDefaultValue = false)]
public DateTimeOffset AvailableBalanceReferenceDate { get; set; }
/// <summary>
/// Last time that a variation (positive or negative) was detected in our system on the available balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>Last time that a variation (positive or negative) was detected in our system on the available balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "availableBalanceVariationObservedAt", EmitDefaultValue = false)]
public DateTimeOffset AvailableBalanceVariationObservedAt { get; set; }
/// <summary>
/// Currency of the account, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format
/// </summary>
/// <value>Currency of the account, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format</value>
[DataMember(Name = "currency", EmitDefaultValue = false)]
public string Currency { get; set; }
/// <summary>
/// Total funds currently in the account
/// </summary>
/// <value>Total funds currently in the account</value>
[DataMember(Name = "currentBalance", EmitDefaultValue = false)]
public decimal CurrentBalance { get; set; }
/// <summary>
/// When the current balance was changed for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When the current balance was changed for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "currentBalanceChangedAt", EmitDefaultValue = false)]
public DateTimeOffset CurrentBalanceChangedAt { get; set; }
/// <summary>
/// Reference date of the current balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>Reference date of the current balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "currentBalanceReferenceDate", EmitDefaultValue = false)]
public DateTimeOffset CurrentBalanceReferenceDate { get; set; }
/// <summary>
/// Last time that a variation (positive or negative) was detected in our system on the current balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>Last time that a variation (positive or negative) was detected in our system on the current balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "currentBalanceVariationObservedAt", EmitDefaultValue = false)]
public DateTimeOffset CurrentBalanceVariationObservedAt { get; set; }
/// <summary>
/// Description of the account
/// </summary>
/// <value>Description of the account</value>
[DataMember(Name = "description", EmitDefaultValue = false)]
public string Description { get; set; }
/// <summary>
/// Name of the account holder
/// </summary>
/// <value>Name of the account holder</value>
[DataMember(Name = "holderName", EmitDefaultValue = false)]
public string HolderName { get; set; }
/// <summary>
/// Internal resource reference given by the financial institution
/// </summary>
/// <value>Internal resource reference given by the financial institution</value>
[DataMember(Name = "internalReference", EmitDefaultValue = false)]
public Guid InternalReference { get; set; }
/// <summary>
/// Name of the account product
/// </summary>
/// <value>Name of the account product</value>
[DataMember(Name = "product", EmitDefaultValue = false)]
public string Product { get; set; }
/// <summary>
/// Financial institution's internal reference for this account
/// </summary>
/// <value>Financial institution's internal reference for this account</value>
[DataMember(Name = "reference", EmitDefaultValue = false)]
public string Reference { get; set; }
/// <summary>
/// Type of financial institution reference (can be <code>IBAN</code>, <code>BBAN</code>, <code>email</code>, <code>PAN</code>, <code>MASKEDPAN</code> or <code>MSISDN</code>)
/// </summary>
/// <value>Type of financial institution reference (can be <code>IBAN</code>, <code>BBAN</code>, <code>email</code>, <code>PAN</code>, <code>MASKEDPAN</code> or <code>MSISDN</code>)</value>
[DataMember(Name = "referenceType", EmitDefaultValue = false)]
public string ReferenceType { get; set; }
/// <summary>
/// Type of account. Can be <code>checking</code>, <code>savings</code>, <code>securities</code>, <code>card</code> or <code>psp</code>
/// </summary>
/// <value>Type of account. Can be <code>checking</code>, <code>savings</code>, <code>securities</code>, <code>card</code> or <code>psp</code></value>
[DataMember(Name = "subtype", EmitDefaultValue = false)]
public string Subtype { get; set; }
}
/// <inheritdoc cref="Account" />
[DataContract]
public class AccountResponse : Account, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// When this account was last synchronized.
/// </summary>
public DateTimeOffset SynchronizedAt { get; set; }
/// <summary>
/// Details of the most recently completed (with success or error) synchronization of the account
/// </summary>
public SynchronizationResponse LatestSynchronization { get; set; }
/// <summary>
/// <para>Indicates the availability of the account. The possible values are:</para>
/// <para>available (default)</para>
/// <para>readonly if the financial institution is undertaking maintenance and cannot be reached. Existing data is available but you cannot, for example, synchronize the account until the maintenance is complete</para>
/// </summary>
public string Availability { get; set; }
}
/// <summary>
/// Account metadata
/// </summary>
[DataContract]
public class AccountMeta
{
/// <summary>
/// When this account was last synchronized.
/// </summary>
[DataMember(Name = "synchronizedAt", EmitDefaultValue = false)]
public DateTimeOffset SynchronizedAt { get; set; }
/// <summary>
/// Details of the most recently completed (with success or error) synchronization of the account
/// </summary>
[DataMember(Name = "latestSynchronization", EmitDefaultValue = false)]
public JsonApi.Data<SynchronizationResponse, object, object, object> LatestSynchronization { get; set; }
/// <summary>
/// <para>Indicates the availability of the account. The possible values are:</para>
/// <para>available (default)</para>
/// <para>readonly if the financial institution is undertaking maintenance and cannot be reached. Existing data is available but you cannot, for example, synchronize the account until the maintenance is complete</para>
/// </summary>
[DataMember(Name = "availability", EmitDefaultValue = false)]
public string Availability { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\AccountInformationAccessRequest.cs | using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing an account information access request. When you want to access the account information of one of your customers, you have to create one to start the authorization flow.</p>
/// <p>When creating the account information access request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the authorization process. At the end of the flow, they will be returned to the redirect uri that you defined.</p>
/// <p>If the access request is not authorized (for example when the customer cancels the flow), an error query parameter will be added to the redirect uri. The possible values of this parameter are access_denied and unsupported_multi_currency_account.</p>
/// <p>When authorizing account access by a financial institution user (in the sandbox), you should use 123456 as the digipass response. You can also use the Ibanity Sandbox Authorization Portal CLI to automate this authorization.</p>
/// </summary>
[DataContract]
public class AccountInformationAccessRequest
{
/// <summary>
/// <p>An array of the references for the accounts to be accessed. The minimum and maximum permitted number of account references can be found in the <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>financial institution attributes</a>. For some financial institutions the accounts can be chosen later, during the authorization process.</p>
/// </summary>
/// <value><p>An array of the references for the accounts to be accessed. The minimum and maximum permitted number of account references can be found in the <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>financial institution attributes</a>. For some financial institutions the accounts can be chosen later, during the authorization process.</p></value>
[DataMember(Name = "requestedAccountReferences", EmitDefaultValue = false)]
public List<string> RequestedAccountReferences { get; set; }
}
/// <inheritdoc />
[DataContract]
public class AccountInformationAccessRequestRequest : AccountInformationAccessRequest
{
/// <summary>
/// URI that your customer will be redirected to at the end of the authorization flow. HTTPS is required for live applications.
/// </summary>
/// <value>URI that your customer will be redirected to at the end of the authorization flow. HTTPS is required for live applications.</value>
[DataMember(Name = "redirectUri", IsRequired = true, EmitDefaultValue = true)]
public string RedirectUri { get; set; }
/// <summary>
/// Your internal reference to the explicit consent provided by your consumer. You should store this consent reference in case of dispute.
/// </summary>
/// <value>Your internal reference to the explicit consent provided by your consumer. You should store this consent reference in case of dispute.</value>
[DataMember(Name = "consentReference", IsRequired = true, EmitDefaultValue = true)]
public string ConsentReference { get; set; }
/// <summary>
/// Represents the language to be used in the authorization interface (<code>\"en\"</code>, <code>\"nl\"</code>, or <code>\"fr\"</code>). The default language is English.
/// </summary>
/// <value>Represents the language to be used in the authorization interface (<code>\"en\"</code>, <code>\"nl\"</code>, or <code>\"fr\"</code>). The default language is English.</value>
[DataMember(Name = "locale", EmitDefaultValue = false)]
public string Locale { get; set; }
/// <summary>
/// Specifies the IP of the customer, to be passed to the financial institution. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.
/// </summary>
/// <value>Specifies the IP of the customer, to be passed to the financial institution. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.</value>
[DataMember(Name = "customerIpAddress", EmitDefaultValue = false)]
public string CustomerIpAddress { get; set; }
/// <summary>
/// When set to true, the returned <code>redirectUri</code> will be the one of the financial institution, avoiding an extra hop on Ibanity for the customer. It also fixes app-to-app redirects on IOS. Defaults to <code>false</code> to ensure backward compatibility.
/// </summary>
/// <value>When set to true, the returned <code>redirectUri</code> will be the one of the financial institution, avoiding an extra hop on Ibanity for the customer. It also fixes app-to-app redirects on IOS. Defaults to <code>false</code> to ensure backward compatibility.</value>
[DataMember(Name = "allowFinancialInstitutionRedirectUri", EmitDefaultValue = true)]
public bool? AllowFinancialInstitutionRedirectUri { get; set; }
/// <summary>
/// Allow support for multicurrency accounts. Defaults to <code>false</code>
/// </summary>
/// <value>Allow support for multicurrency accounts. Defaults to <code>false</code></value>
[DataMember(Name = "allowMulticurrencyAccounts", EmitDefaultValue = true)]
public bool? AllowMulticurrencyAccounts { get; set; }
/// <summary>
/// When set to true, TPP managed authorization flow will be enabled. The financial institution will redirect your customer to the <code>redirectUri</code> avoiding an extra hop on Ibanity. By default, the XS2A managed authorization flow is used. If set to <code>true</code>, a <code>state</code> must be provided.
/// </summary>
/// <value>When set to true, TPP managed authorization flow will be enabled. The financial institution will redirect your customer to the <code>redirectUri</code> avoiding an extra hop on Ibanity. By default, the XS2A managed authorization flow is used. If set to <code>true</code>, a <code>state</code> must be provided.</value>
[DataMember(Name = "skipIbanityCompletionCallback", EmitDefaultValue = true)]
public bool? SkipIbanityCompletionCallback { get; set; }
/// <summary>
/// The state you want to append to the redirectUri at the end of the authorization flow.
/// </summary>
/// <value>The state you want to append to the redirectUri at the end of the authorization flow.</value>
[DataMember(Name = "state", EmitDefaultValue = false)]
public string State { get; set; }
/// <summary>
/// Identifier the customer uses to log into the financial institution's online portal. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.
/// </summary>
/// <value>Identifier the customer uses to log into the financial institution's online portal. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.</value>
[DataMember(Name = "financialInstitutionCustomerReference", EmitDefaultValue = false)]
public string FinancialInstitutionCustomerReference { get; set; }
/// <summary>
/// Allowed type of accounts that will be accepted in the account information access request. Can be <code>checking</code>, <code>savings</code>, <code>securities</code>, <code>card</code> or <code>psp</code>. When not set, it defaults to checking accounts.
/// </summary>
/// <value>Allowed type of accounts that will be accepted in the account information access request. Can be <code>checking</code>, <code>savings</code>, <code>securities</code>, <code>card</code> or <code>psp</code>. When not set, it defaults to checking accounts.</value>
[DataMember(Name = "allowedAccountSubtypes", EmitDefaultValue = false)]
public List<string> AllowedAccountSubtypes { get; set; }
}
/// <inheritdoc />
[DataContract]
public class AccountInformationAccessRequestResponse : AccountInformationAccessRequest, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// Details of any errors that could have occurred during initial synchronization, due to invalid authorization or technical failure. <a href='https://documentation.ibanity.com//api#sync'>See possible errors</a>
/// </summary>
/// <value>Details of any errors that could have occurred during initial synchronization, due to invalid authorization or technical failure. <a href='https://documentation.ibanity.com//api#sync'>See possible errors</a></value>
[DataMember(Name = "errors", EmitDefaultValue = false)]
public Object Errors { get; set; }
/// <summary>
/// Current status of the account information access request. Possible values are <code>received</code>, <code>started</code>, <code>rejected</code>, <code>succeeded</code>, <code>partially-succeeded</code>, and <code>failed</code>. <a href='/xs2a/products#aiar-status-codes'>See status definitions.</a>
/// </summary>
/// <value>Current status of the account information access request. Possible values are <code>received</code>, <code>started</code>, <code>rejected</code>, <code>succeeded</code>, <code>partially-succeeded</code>, and <code>failed</code>. <a href='/xs2a/products#aiar-status-codes'>See status definitions.</a></value>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow
/// </summary>
[DataMember(Name = "redirectUri", EmitDefaultValue = false)]
public Uri Redirect { get; set; }
}
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow
/// </summary>
[DataContract]
public class AccountInformationAccessRequestLinks
{
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
[DataMember(Name = "redirect", EmitDefaultValue = false)]
public string RedirectString { get; set; }
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
public Uri Redirect => string.IsNullOrWhiteSpace(RedirectString)
? null
: new Uri(RedirectString);
}
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow
/// </summary>
[DataContract]
public class AccountInformationAccessRequestMeta
{
/// <summary>
/// Optional number of days to fetch past transactions. Default is 90
/// </summary>
[DataMember(Name = "requestedPastTransactionDays", EmitDefaultValue = false)]
public int? RequestedPastTransactionDays { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\AccountInformationAccessRequestAuthorization.cs | using System.Runtime.Serialization;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This object represent the authorization resource. When you perform an Authorization flow using TPP managed authorization flow, you need to create an authorization resource to complete the flow.</p>
/// <p>The attribute queryParameters contains the query parameters returned by the financial institution when the customer is redirected to your configured redirect uri.</p>
/// </summary>
[DataContract]
public class AccountInformationAccessRequestAuthorizationResponse : AuthorizationResponse
{
/// <summary>
/// Current status of the account information access request. Possible values are <code>received</code>, <code>started</code>, <code>rejected</code>, <code>succeeded</code>, <code>partially-succeeded</code>, and <code>failed</code>. <a href='/xs2a/products#aiar-status-codes'>See status definitions.</a>
/// </summary>
/// <value>Current status of the account information access request. Possible values are <code>received</code>, <code>started</code>, <code>rejected</code>, <code>succeeded</code>, <code>partially-succeeded</code>, and <code>failed</code>. <a href='/xs2a/products#aiar-status-codes'>See status definitions.</a></value>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\Authorization.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This object represent the authorization resource. When you perform an Authorization flow using TPP managed authorization flow, you need to create an authorization resource to complete the flow.</p>
/// <p>The attribute queryParameters contains the query parameters returned by the financial institution when the customer is redirected to your configured redirect uri.</p>
/// </summary>
[DataContract]
public class RequestAuthorization
{
/// <summary>
/// Parameters returned by the financial institution when the customer is redirected to your backend at the end of the authorization flow.
/// </summary>
/// <value>Parameters returned by the financial institution when the customer is redirected to your backend at the end of the authorization flow.</value>
[DataMember(Name = "queryParameters", EmitDefaultValue = true)]
public Object QueryParameters { get; set; }
}
/// <summary>
/// <p>This object represent the authorization resource. When you perform an Authorization flow using TPP managed authorization flow, you need to create an authorization resource to complete the flow.</p>
/// <p>The attribute queryParameters contains the query parameters returned by the financial institution when the customer is redirected to your configured redirect uri.</p>
/// </summary>
[DataContract]
public class AuthorizationResponse : Identified<Guid>
{
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow
/// </summary>
[DataMember(Name = "nextRedirect", EmitDefaultValue = false)]
public Uri NextRedirect { get; set; }
}
/// <inheritdoc />
[DataContract]
public class PaymentAuthorizationResponse : AuthorizationResponse
{
/// <summary>
/// Current status of the payment initiation request. Possible values are accepted-customer-profile, accepted-settlement-completed, accepted-settlement-in-progress, accepted-technical-validation, accepted-with-change, accepted-without-posting, received, pending, and rejected. See status definitions.
/// </summary>
[DataMember(Name = "paymentInitiationRequestStatus", EmitDefaultValue = false)]
public string PaymentInitiationRequestStatus { get; set; }
}
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow
/// </summary>
[DataContract]
public class AuthorizationLinks
{
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
[DataMember(Name = "nextRedirect", EmitDefaultValue = false)]
public string NextRedirectString { get; set; }
/// <summary>
/// URI to redirect to from your customer frontend to conduct the authorization flow.
/// </summary>
public Uri NextRedirect => string.IsNullOrWhiteSpace(NextRedirectString)
? null
: new Uri(NextRedirectString);
}
/// <summary>
/// Details about the associated bulk payment initiation request
/// </summary>
[DataContract]
public class PaymentInitiationRequestRelationship
{
/// <summary>
/// Current status of the payment initiation request. Possible values are accepted-customer-profile, accepted-settlement-completed, accepted-settlement-in-progress, accepted-technical-validation, accepted-with-change, accepted-without-posting, received, pending, and rejected. See status definitions.
/// </summary>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\BatchSynchronization.cs | using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// This is an object representing a resource batch-synchronization. This object will give you the details of the batch-synchronization.
/// </summary>
[DataContract]
public class BatchSynchronization
{
/// <summary>
/// Type of the resource to be synchronized. Currently must be <code>account</code>
/// </summary>
/// <value>Type of the resource to be synchronized. Currently must be <code>account</code></value>
[DataMember(Name = "resourceType", IsRequired = true, EmitDefaultValue = true)]
public string ResourceType { get; set; }
/// <summary>
/// Execution limit for execution of the batch-synchronization. Should the synchronization start after the given date, then it would be cancelled.
/// </summary>
/// <value>Execution limit for execution of the batch-synchronization. Should the synchronization start after the given date, then it would be cancelled.</value>
[DataMember(Name = "cancelAfter", EmitDefaultValue = false)]
public DateTimeOffset? CancelAfter { get; set; }
/// <summary>
/// Datetime to prevent the synchronization of the resource, if it was already synchronized after the given date.
/// </summary>
/// <value>Datetime to prevent the synchronization of the resource, if it was already synchronized after the given date.</value>
[DataMember(Name = "unlessSynchronizedAfter", EmitDefaultValue = false)]
public DateTimeOffset? UnlessSynchronizedAfter { get; set; }
/// <summary>
/// Array of what is being synchronized. Account information such as balance is updated using <code>accountDetails</code>, while <code>accountTransactions</code> is used to synchronize the transactions.
/// </summary>
/// <value>Array of what is being synchronized. Account information such as balance is updated using <code>accountDetails</code>, while <code>accountTransactions</code> is used to synchronize the transactions.</value>
[DataMember(Name = "subtypes", IsRequired = true, EmitDefaultValue = true)]
public List<string> Subtypes { get; set; }
}
/// <summary>
/// This is an object representing a resource batch-synchronization. This object will give you the details of the batch-synchronization.
/// </summary>
[DataContract]
public class BatchSynchronizationResponse : Identified<Guid> { }
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\BulkPaymentInitiationRequest.cs | using System;
using System.Collections.Generic;
using System.Globalization;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// This is an object representing a bulk payment initiation request. When you want to request the initiation of payments on behalf of one of your customers, you can create one to start the authorization flow.
/// </summary>
[DataContract]
public class BulkPaymentInitiationRequest
{
/// <summary>
/// URI that your customer will be redirected to at the end of the authorization flow. HTTPS is required for live applications.
/// </summary>
/// <value>URI that your customer will be redirected to at the end of the authorization flow. HTTPS is required for live applications.</value>
[DataMember(Name = "redirectUri", EmitDefaultValue = false)]
public string RedirectUri { get; set; }
/// <summary>
/// A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>financial institution attributes</a>
/// </summary>
/// <value>A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>financial institution attributes</a></value>
[DataMember(Name = "requestedExecutionDate", EmitDefaultValue = false)]
public string RequestedExecutionDateString
{
get => RequestedExecutionDate.HasValue
? RequestedExecutionDate.Value.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture)
: null;
set => RequestedExecutionDate = !string.IsNullOrWhiteSpace(value)
? (DateTimeOffset?)DateTimeOffset.Parse(value, CultureInfo.InvariantCulture)
: null;
}
/// <summary>
/// A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>financial institution attributes</a>
/// </summary>
/// <value>A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>financial institution attributes</a></value>
public DateTimeOffset? RequestedExecutionDate { get; set; }
/// <summary>
/// Specify the batch booking preference. Request this bulk payment to be listed as one global transaction, or one transaction per payment instruction. The financial institution may ignore this parameter
/// </summary>
/// <value>Specify the batch booking preference. Request this bulk payment to be listed as one global transaction, or one transaction per payment instruction. The financial institution may ignore this parameter</value>
[DataMember(Name = "batchBookingPreferred", EmitDefaultValue = false)]
public bool? BatchBookingPreferred { get; set; }
/// <summary>
/// Your internal reference to the explicit consent provided by your consumer. You should store this consent reference in case of dispute.
/// </summary>
/// <value>Your internal reference to the explicit consent provided by your consumer. You should store this consent reference in case of dispute.</value>
[DataMember(Name = "consentReference", EmitDefaultValue = false)]
public string ConsentReference { get; set; }
/// <summary>
/// Type of payment transfer. Will always be <code>sepa-credit-transfer</code>
/// </summary>
/// <value>Type of payment transfer. Will always be <code>sepa-credit-transfer</code></value>
[DataMember(Name = "productType", EmitDefaultValue = false)]
public string ProductType { get; set; }
/// <summary>
/// Name of the paying customer
/// </summary>
/// <value>Name of the paying customer</value>
[DataMember(Name = "debtorName", EmitDefaultValue = false)]
public string DebtorName { get; set; }
/// <summary>
/// Financial institution's internal reference for the payer's account
/// </summary>
/// <value>Financial institution's internal reference for the payer's account</value>
[DataMember(Name = "debtorAccountReference", EmitDefaultValue = false)]
public string DebtorAccountReference { get; set; }
/// <summary>
/// Type of account reference, such as <code>IBAN</code>. Mandatory when <code>debtorAccountReference</code> is provided.
/// </summary>
/// <value>Type of account reference, such as <code>IBAN</code>. Mandatory when <code>debtorAccountReference</code> is provided.</value>
[DataMember(Name = "debtorAccountReferenceType", EmitDefaultValue = false)]
public string DebtorAccountReferenceType { get; set; }
/// <summary>
/// When set to true, the returned <code>redirectUri</code> will be the one of the financial institution, avoiding an extra hop on Ibanity for the customer. It also fixes app-to-app redirects on IOS. Defaults to <code>false</code> to ensure backward compatibility.
/// </summary>
/// <value>When set to true, the returned <code>redirectUri</code> will be the one of the financial institution, avoiding an extra hop on Ibanity for the customer. It also fixes app-to-app redirects on IOS. Defaults to <code>false</code> to ensure backward compatibility.</value>
[DataMember(Name = "allowFinancialInstitutionRedirectUri", EmitDefaultValue = false)]
public bool AllowFinancialInstitutionRedirectUri { get; set; }
/// <summary>
/// When set to true, TPP managed authorization flow will be enabled. The financial institution will redirect your customer to the <code>redirectUri</code> avoiding an extra hop on Ibanity. By default, the XS2A managed authorization flow is used. If set to <code>true</code>, a <code>state</code> must be provided.
/// </summary>
/// <value>When set to true, TPP managed authorization flow will be enabled. The financial institution will redirect your customer to the <code>redirectUri</code> avoiding an extra hop on Ibanity. By default, the XS2A managed authorization flow is used. If set to <code>true</code>, a <code>state</code> must be provided.</value>
[DataMember(Name = "skipIbanityCompletionCallback", EmitDefaultValue = false)]
public bool SkipIbanityCompletionCallback { get; set; }
/// <summary>
/// Identifier the customer uses to log into the financial institution's online portal. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.
/// </summary>
/// <value>Identifier the customer uses to log into the financial institution's online portal. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.</value>
[DataMember(Name = "financialInstitutionCustomerReference", EmitDefaultValue = false)]
public string FinancialInstitutionCustomerReference { get; set; }
/// <summary>
/// <p>List of payment attribute objects to be included in the bulk payment.</p><p>Required attributes are <code>currency</code>, <code>amount</code>, <code>creditorName</code>, <code>creditorAccountReference</code>, <code>creditorAccountReferenceType</code> and <code>endToEndId</code>.</p><p>Optional attributes are <code>remittanceInformation</code>, <code>remittanceInformationType</code>, <code>creditorAgent</code>, and <code>creditorAgentType</code>.</p><p>For more information see the <a href='https://documentation.ibanity.com/xs2a/api#create-payment-initiation-request-attributes'>create payment initiation request attributes</a></p>
/// </summary>
/// <value><p>List of payment attribute objects to be included in the bulk payment.</p><p>Required attributes are <code>currency</code>, <code>amount</code>, <code>creditorName</code>, <code>creditorAccountReference</code>, <code>creditorAccountReferenceType</code> and <code>endToEndId</code>.</p><p>Optional attributes are <code>remittanceInformation</code>, <code>remittanceInformationType</code>, <code>creditorAgent</code>, and <code>creditorAgentType</code>.</p><p>For more information see the <a href='https://documentation.ibanity.com/xs2a/api#create-payment-initiation-request-attributes'>create payment initiation request attributes</a></p></value>
[DataMember(Name = "payments", EmitDefaultValue = false)]
public List<PaymentInitiationRequest> Payments { get; set; }
}
/// <summary>
/// This is an object representing a resource batch-synchronization. This object will give you the details of the batch-synchronization.
/// </summary>
[DataContract]
public class BulkPaymentInitiationRequestResponse : BulkPaymentInitiationRequest, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// Status of the bulk payment initiation request. <a href='/isabel-connect/products#bulk-payment-statuses'>See possible statuses</a>.
/// </summary>
/// <value>Status of the bulk payment initiation request. <a href='/isabel-connect/products#bulk-payment-statuses'>See possible statuses</a>.</value>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
/// <summary>
/// Details about the reason why the payment was refused by the financial institution.
/// </summary>
/// <value>Details about the reason why the payment was refused by the financial institution.</value>
[DataMember(Name = "statusReason", EmitDefaultValue = false)]
public Object StatusReason { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\BulkPaymentInitiationRequestAuthorization.cs | using System.Runtime.Serialization;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// Details about the associated bulk payment initiation request
/// </summary>
[DataContract]
public class BulkPaymentInitiationRequestAuthorizationRelationships
{
/// <summary>
/// Details about the associated bulk payment initiation request
/// </summary>
[DataMember(Name = "bulkPaymentInitiationRequest", EmitDefaultValue = false)]
public JsonApi.Relationship<PaymentInitiationRequestRelationship> BulkPaymentInitiationRequest { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\Customer.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing a customer. A customer resource is created with the creation of a related customer access token.</p>
/// <p>In the case that the contractual relationship between you and your customer is terminated, you should probably use the Delete Customer endpoint to erase ALL customer personal data.</p>
/// <p>In the case that your customer wants to revoke your access to some accounts, you should use the Delete Account endpoint instead.</p>
/// </summary>
[DataContract]
public class Customer : Identified<Guid> { }
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\FinancialInstitution.cs | using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// This is an object representing a financial institution, providing its basic details - including whether it is a sandbox object or not.
/// </summary>
[DataContract]
public class FinancialInstitution : Identified<Guid>
{
/// <summary>
/// Identifies the authorization models that are offered by the financial institution. <a href='/xs2a/products#authorization-models'>Learn more</a>.
/// </summary>
/// <value>Identifies the authorization models that are offered by the financial institution. <a href='/xs2a/products#authorization-models'>Learn more</a>.</value>
[DataMember(Name = "authorizationModels", EmitDefaultValue = false)]
public List<string> AuthorizationModels { get; set; }
/// <summary>
/// Identifier for the financial institution, in <a href='https://en.wikipedia.org/wiki/ISO_9362'>ISO9362</a> format.
/// </summary>
/// <value>Identifier for the financial institution, in <a href='https://en.wikipedia.org/wiki/ISO_9362'>ISO9362</a> format.</value>
[DataMember(Name = "bic", EmitDefaultValue = false)]
public string Bic { get; set; }
/// <summary>
/// Indicates whether the financial institution allows bulk payment initiation requests
/// </summary>
/// <value>Indicates whether the financial institution allows bulk payment initiation requests</value>
[DataMember(Name = "bulkPaymentsEnabled", EmitDefaultValue = false)]
public bool? BulkPaymentsEnabled { get; set; }
/// <summary>
/// Identifies which values are accepted for the bulk payment initiation request <code>productType</code>
/// </summary>
/// <value>Identifies which values are accepted for the bulk payment initiation request <code>productType</code></value>
[DataMember(Name = "bulkPaymentsProductTypes", EmitDefaultValue = false)]
public List<string> BulkPaymentsProductTypes { get; set; }
/// <summary>
/// Country of the financial institution, in <a href='https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2'>ISO 3166-1 alpha-2</a> format. Is <code>null</code> in the case of an international financial institution.
/// </summary>
/// <value>Country of the financial institution, in <a href='https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2'>ISO 3166-1 alpha-2</a> format. Is <code>null</code> in the case of an international financial institution.</value>
[DataMember(Name = "country", EmitDefaultValue = false)]
public string Country { get; set; }
/// <summary>
/// Indicates if a <code>financialInstitutionCustomerReference</code> must be provided for <a href='https://documentation.ibanity.com//api#create-account-information-access-request'>account information access requests</a> and <a href='#create-payment-initiation-request'>payment initiation requests</a> for this financial institution
/// </summary>
/// <value>Indicates if a <code>financialInstitutionCustomerReference</code> must be provided for <a href='https://documentation.ibanity.com//api#create-account-information-access-request'>account information access requests</a> and <a href='#create-payment-initiation-request'>payment initiation requests</a> for this financial institution</value>
[DataMember(Name = "financialInstitutionCustomerReferenceRequired", EmitDefaultValue = false)]
public bool? FinancialInstitutionCustomerReferenceRequired { get; set; }
/// <summary>
/// Indicates whether a <code>requestedExecutionDate</code> is supported for <a href='https://documentation.ibanity.com//api#payment-initiation-request'>payment initiation requests</a> from accounts belonging to this financial institution
/// </summary>
/// <value>Indicates whether a <code>requestedExecutionDate</code> is supported for <a href='https://documentation.ibanity.com//api#payment-initiation-request'>payment initiation requests</a> from accounts belonging to this financial institution</value>
[DataMember(Name = "futureDatedPaymentsAllowed", EmitDefaultValue = false)]
public bool? FutureDatedPaymentsAllowed { get; set; }
/// <summary>
/// Location of the logo image for the financial institution
/// </summary>
/// <value>Location of the logo image for the financial institution</value>
[DataMember(Name = "logoUrl", EmitDefaultValue = false)]
public string LogoUrl { get; set; }
/// <summary>
/// Indicates the start date of the maintenance.
/// </summary>
/// <value>Indicates the start date of the maintenance.</value>
[DataMember(Name = "maintenanceFrom", EmitDefaultValue = false)]
public Object MaintenanceFrom { get; set; }
/// <summary>
/// Indicates the end date of the maintenance.
/// </summary>
/// <value>Indicates the end date of the maintenance.</value>
[DataMember(Name = "maintenanceTo", EmitDefaultValue = false)]
public Object MaintenanceTo { get; set; }
/// <summary>
/// Indicates if there is an ongoing or scheduled maintenance. If present, the possible values are:<ul><li><code>internal</code>, meaning we are working on the connection and no data access is possible</li><li><code>financialInstitution</code>, indicating the financial institution cannot be reached, but existing data is available in read-only mode</li></ul>
/// </summary>
/// <value>Indicates if there is an ongoing or scheduled maintenance. If present, the possible values are:<ul><li><code>internal</code>, meaning we are working on the connection and no data access is possible</li><li><code>financialInstitution</code>, indicating the financial institution cannot be reached, but existing data is available in read-only mode</li></ul></value>
[DataMember(Name = "maintenanceType", EmitDefaultValue = false)]
public Object MaintenanceType { get; set; }
/// <summary>
/// Indicates the maximum permitted length of the <code>requestedAccountReferences</code> array when creating an <a href='https://documentation.ibanity.com//api#create-account-information-access-request'>account information access request</a> for the financial institution. When <code>0</code>, the account reference(s) must be provided during the subsequent authorization process rather than during the creation of the access request. When <code>null</code>, there is no upper limit to the number of account references that may be provided with the request.
/// </summary>
/// <value>Indicates the maximum permitted length of the <code>requestedAccountReferences</code> array when creating an <a href='https://documentation.ibanity.com//api#create-account-information-access-request'>account information access request</a> for the financial institution. When <code>0</code>, the account reference(s) must be provided during the subsequent authorization process rather than during the creation of the access request. When <code>null</code>, there is no upper limit to the number of account references that may be provided with the request.</value>
[DataMember(Name = "maxRequestedAccountReferences", EmitDefaultValue = false)]
public Object MaxRequestedAccountReferences { get; set; }
/// <summary>
/// Indicates the minimum permitted length of the <code>requestedAccountReferences</code> array when creating an <a href='https://documentation.ibanity.com//api#create-account-information-access-request'>account information access request</a> for the financial institution.
/// </summary>
/// <value>Indicates the minimum permitted length of the <code>requestedAccountReferences</code> array when creating an <a href='https://documentation.ibanity.com//api#create-account-information-access-request'>account information access request</a> for the financial institution.</value>
[DataMember(Name = "minRequestedAccountReferences", EmitDefaultValue = false)]
public decimal? MinRequestedAccountReferences { get; set; }
/// <summary>
/// Name of the financial institution
/// </summary>
/// <value>Name of the financial institution</value>
[DataMember(Name = "name", EmitDefaultValue = false)]
public string Name { get; set; }
/// <summary>
/// Indicates whether the financial institution allows <a href='https://documentation.ibanity.com//api#payment-initiation-request'>payment initiation requests</a>
/// </summary>
/// <value>Indicates whether the financial institution allows <a href='https://documentation.ibanity.com//api#payment-initiation-request'>payment initiation requests</a></value>
[DataMember(Name = "paymentsEnabled", EmitDefaultValue = false)]
public bool? PaymentsEnabled { get; set; }
/// <summary>
/// Identifies which values are accepted for the <a href='https://documentation.ibanity.com//api#payment-initiation-request'>payment initiation request</a> <code>productType</code>
/// </summary>
/// <value>Identifies which values are accepted for the <a href='https://documentation.ibanity.com//api#payment-initiation-request'>payment initiation request</a> <code>productType</code></value>
[DataMember(Name = "paymentsProductTypes", EmitDefaultValue = false)]
public List<string> PaymentsProductTypes { get; set; }
/// <summary>
/// Indicates whether the financial institution allows periodic payment initiation requests
/// </summary>
/// <value>Indicates whether the financial institution allows periodic payment initiation requests</value>
[DataMember(Name = "periodicPaymentsEnabled", EmitDefaultValue = false)]
public bool? PeriodicPaymentsEnabled { get; set; }
/// <summary>
/// Identifies which values are accepted for the periodic payment initiation request <code>productType</code>
/// </summary>
/// <value>Identifies which values are accepted for the periodic payment initiation request <code>productType</code></value>
[DataMember(Name = "periodicPaymentsProductTypes", EmitDefaultValue = false)]
public List<string> PeriodicPaymentsProductTypes { get; set; }
/// <summary>
/// Hexadecimal color code related to the primary branding color of the financial institution
/// </summary>
/// <value>Hexadecimal color code related to the primary branding color of the financial institution</value>
[DataMember(Name = "primaryColor", EmitDefaultValue = false)]
public string PrimaryColor { get; set; }
/// <summary>
/// Indicates whether credentials must be stored to access a customer's account information
/// </summary>
/// <value>Indicates whether credentials must be stored to access a customer's account information</value>
[DataMember(Name = "requiresCredentialStorage", EmitDefaultValue = false)]
public bool? RequiresCredentialStorage { get; set; }
/// <summary>
/// Indicates whether the IP address of the customer must be provided when creating an <a href='https://documentation.ibanity.com//api#create-account-information-access-request'>account information access request</a> or <a href='#create-payment-initiation-request'>payment initiation request</a> for the financial institution
/// </summary>
/// <value>Indicates whether the IP address of the customer must be provided when creating an <a href='https://documentation.ibanity.com//api#create-account-information-access-request'>account information access request</a> or <a href='#create-payment-initiation-request'>payment initiation request</a> for the financial institution</value>
[DataMember(Name = "requiresCustomerIpAddress", EmitDefaultValue = false)]
public bool? RequiresCustomerIpAddress { get; set; }
/// <summary>
/// Indicates whether the financial institution is one in the sandbox or the real deal
/// </summary>
/// <value>Indicates whether the financial institution is one in the sandbox or the real deal</value>
[DataMember(Name = "sandbox", EmitDefaultValue = false)]
public bool? Sandbox { get; set; }
/// <summary>
/// Hexadecimal color code related to the secondary branding color of the financial institution
/// </summary>
/// <value>Hexadecimal color code related to the secondary branding color of the financial institution</value>
[DataMember(Name = "secondaryColor", EmitDefaultValue = false)]
public string SecondaryColor { get; set; }
/// <summary>
/// Customer-friendly name of the financial institution's shared brand, if it is a member of one
/// </summary>
/// <value>Customer-friendly name of the financial institution's shared brand, if it is a member of one</value>
[DataMember(Name = "sharedBrandName", EmitDefaultValue = false)]
public string SharedBrandName { get; set; }
/// <summary>
/// Attribute used to group multiple individual financial institutions in the same country
/// </summary>
/// <value>Attribute used to group multiple individual financial institutions in the same country</value>
[DataMember(Name = "sharedBrandReference", EmitDefaultValue = false)]
public string SharedBrandReference { get; set; }
/// <summary>
/// Availability of the connection (experimental, beta, stable)
/// </summary>
/// <value>Availability of the connection (experimental, beta, stable)</value>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
}
/// <summary>
/// This is an object representing a financial institution, providing its basic details - including whether it is a sandbox object or not.
/// </summary>
public class SandboxFinancialInstitution
{
/// <summary>
/// Name of the financial institution
/// </summary>
/// <value>Name of the financial institution</value>
[DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)]
public string Name { get; set; }
/// <summary>
/// Location of the logo image for the financial institution
/// </summary>
/// <value>Location of the logo image for the financial institution</value>
[DataMember(Name = "logoUrl", EmitDefaultValue = false)]
public string LogoUrl { get; set; }
/// <summary>
/// Identifier for the financial institution, in <a href='https://en.wikipedia.org/wiki/ISO_9362'>ISO9362</a> format.
/// </summary>
/// <value>Identifier for the financial institution, in <a href='https://en.wikipedia.org/wiki/ISO_9362'>ISO9362</a> format.</value>
[DataMember(Name = "bic", EmitDefaultValue = false)]
public string Bic { get; set; }
/// <summary>
/// Country of the financial institution, in <a href='https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2'>ISO 3166-1 alpha-2</a> format. Is <code>null</code> in the case of an international financial institution.
/// </summary>
/// <value>Country of the financial institution, in <a href='https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2'>ISO 3166-1 alpha-2</a> format. Is <code>null</code> in the case of an international financial institution.</value>
[DataMember(Name = "country", EmitDefaultValue = false)]
public string Country { get; set; }
/// <summary>
/// Indicates if a <code>financialInstitutionCustomerReference</code> must be provided for <a href='https://documentation.ibanity.com/xs2a/api#create-account-information-access-request'>account information access requests</a> and <a href='#create-payment-initiation-request'>payment initiation requests</a> for this financial institution
/// </summary>
/// <value>Indicates if a <code>financialInstitutionCustomerReference</code> must be provided for <a href='https://documentation.ibanity.com/xs2a/api#create-account-information-access-request'>account information access requests</a> and <a href='#create-payment-initiation-request'>payment initiation requests</a> for this financial institution</value>
[DataMember(Name = "financialInstitutionCustomerReferenceRequired", EmitDefaultValue = true)]
public bool? FinancialInstitutionCustomerReferenceRequired { get; set; }
/// <summary>
/// Identifies the authorization models that are offered by the financial institution. <a href='/xs2a/products#authorization-models'>Learn more</a>.
/// </summary>
/// <value>Identifies the authorization models that are offered by the financial institution. <a href='/xs2a/products#authorization-models'>Learn more</a>.</value>
[DataMember(Name = "authorizationModels", EmitDefaultValue = false)]
public List<string> AuthorizationModels { get; set; }
/// <summary>
/// Attribute used to group multiple individual financial institutions in the same country
/// </summary>
/// <value>Attribute used to group multiple individual financial institutions in the same country</value>
[DataMember(Name = "sharedBrandReference", EmitDefaultValue = false)]
public string SharedBrandReference { get; set; }
/// <summary>
/// Customer-friendly name of the financial institution's shared brand, if it is a member of one
/// </summary>
/// <value>Customer-friendly name of the financial institution's shared brand, if it is a member of one</value>
[DataMember(Name = "sharedBrandName", EmitDefaultValue = false)]
public string SharedBrandName { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\FinancialInstitutionCountry.cs | using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// This endpoint provides a list of the unique countries for which there are financial institutions available in the list financial institutions endpoint. These codes can be used to filter the financial institutions by country.
/// </summary>
[DataContract]
public class FinancialInstitutionCountry : Identified<string> { }
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\Holding.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing an account holding. This object will give you the details of the financial holding</p>
/// <p>From this object, you can link back to its account.</p>
/// <p>The Holding API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
[DataContract]
public class Holding : Identified<Guid>
{
/// <summary>
/// Market value of 1 quantity
/// </summary>
/// <value>Market value of 1 quantity</value>
[DataMember(Name = "lastValuation", EmitDefaultValue = false)]
public decimal LastValuation { get; set; }
/// <summary>
/// The currency of the last valuation
/// </summary>
/// <value>The currency of the last valuation</value>
[DataMember(Name = "lastValuationCurrency", EmitDefaultValue = false)]
public string LastValuationCurrency { get; set; }
/// <summary>
/// The date of the last valuation
/// </summary>
/// <value>The date of the last valuation</value>
[DataMember(Name = "lastValuationDate", EmitDefaultValue = false)]
public DateTimeOffset LastValuationDate { get; set; }
/// <summary>
/// Name of the holding
/// </summary>
/// <value>Name of the holding</value>
[DataMember(Name = "name", EmitDefaultValue = false)]
public string Name { get; set; }
/// <summary>
/// Number of the holding
/// </summary>
/// <value>Number of the holding</value>
[DataMember(Name = "quantity", EmitDefaultValue = false)]
public decimal Quantity { get; set; }
/// <summary>
/// The reference of the holding
/// </summary>
/// <value>The reference of the holding</value>
[DataMember(Name = "reference", EmitDefaultValue = false)]
public string Reference { get; set; }
/// <summary>
/// Type of holding reference (such as <code>ISIN</code>)
/// </summary>
/// <value>Type of holding reference (such as <code>ISIN</code>)</value>
[DataMember(Name = "referenceType", EmitDefaultValue = false)]
public string ReferenceType { get; set; }
/// <summary>
/// Type of holding. Can be <code>SICAV</code>, <code>STOCK</code> or <code>OTHER</code>
/// </summary>
/// <value>Type of holding. Can be <code>SICAV</code>, <code>STOCK</code> or <code>OTHER</code></value>
[DataMember(Name = "subtype", EmitDefaultValue = false)]
public string Subtype { get; set; }
/// <summary>
/// The total value of the holding
/// </summary>
/// <value>The total value of the holding</value>
[DataMember(Name = "totalValuation", EmitDefaultValue = false)]
public decimal TotalValuation { get; set; }
/// <summary>
/// The currency of the total valuation
/// </summary>
/// <value>The currency of the total valuation</value>
[DataMember(Name = "totalValuationCurrency", EmitDefaultValue = false)]
public string TotalValuationCurrency { get; set; }
/// <summary>
/// ID of the account that this transaction belongs to.
/// </summary>
public Guid AccountId { get; set; }
}
/// <summary>
/// Link to the account that this holding belongs to.
/// </summary>
[DataContract]
public class HoldingRelationships
{
/// <summary>
/// Link to the account that this transaction belongs to.
/// </summary>
[DataMember(Name = "account", EmitDefaultValue = false)]
public JsonApi.Relationship Account { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\PaymentInitiationRequest.cs | using System;
using System.Globalization;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing a payment initiation request. When you want to initiate payment from one of your customers, you have to create one to start the authorization flow.</p>
/// <p>When creating the payment initiation request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the authorization process. At the end of the flow, they will be returned to the redirect uri that you defined.</p>
/// <p>If the payment initiation is not authorized (for example when the customer cancels the flow), an error query parameter will be added to the redirect uri with the value rejected.</p>
/// <p>When authorizing payment initiation from a financial institution user (in the sandbox), you should use 123456 as the digipass response.</p>
/// </summary>
[DataContract]
public class PaymentInitiationRequest
{
/// <summary>
/// URI that your customer will be redirected to at the end of the authorization flow. HTTPS is required for live applications.
/// </summary>
/// <value>URI that your customer will be redirected to at the end of the authorization flow. HTTPS is required for live applications.</value>
[DataMember(Name = "redirectUri", EmitDefaultValue = false)]
public string RedirectUri { get; set; }
/// <summary>
/// Your internal reference to the explicit consent provided by your consumer. You should store this consent reference in case of dispute.
/// </summary>
/// <value>Your internal reference to the explicit consent provided by your consumer. You should store this consent reference in case of dispute.</value>
[DataMember(Name = "consentReference", EmitDefaultValue = false)]
public string ConsentReference { get; set; }
/// <summary>
/// Type of payment transfer. Will always be <code>sepa-credit-transfer</code>
/// </summary>
/// <value>Type of payment transfer. Will always be <code>sepa-credit-transfer</code></value>
[DataMember(Name = "productType", EmitDefaultValue = false)]
public string ProductType { get; set; }
/// <summary>
/// Content of the remittance information (aka communication)
/// </summary>
/// <value>Content of the remittance information (aka communication)</value>
[DataMember(Name = "remittanceInformation", EmitDefaultValue = false)]
public string RemittanceInformation { get; set; }
/// <summary>
/// Type of remittance information, can be <code>structured</code> or <code>unstructured</code>
/// </summary>
/// <value>Type of remittance information, can be <code>structured</code> or <code>unstructured</code></value>
[DataMember(Name = "remittanceInformationType", EmitDefaultValue = false)]
public string RemittanceInformationType { get; set; }
/// <summary>
/// A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com//api#financial-institution-attributes'>financial institution attributes</a>
/// </summary>
/// <value>A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com//api#financial-institution-attributes'>financial institution attributes</a></value>
[DataMember(Name = "requestedExecutionDate", EmitDefaultValue = false)]
public string RequestedExecutionDateString
{
get => RequestedExecutionDate.HasValue
? RequestedExecutionDate.Value.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture)
: null;
set => RequestedExecutionDate = !string.IsNullOrWhiteSpace(value)
? (DateTimeOffset?)DateTimeOffset.Parse(value, CultureInfo.InvariantCulture)
: null;
}
/// <summary>
/// A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com//api#financial-institution-attributes'>financial institution attributes</a>
/// </summary>
/// <value>A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com//api#financial-institution-attributes'>financial institution attributes</a></value>
public DateTimeOffset? RequestedExecutionDate { get; set; }
/// <summary>
/// Currency of the payment initiation request, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format
/// </summary>
/// <value>Currency of the payment initiation request, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format</value>
[DataMember(Name = "currency", EmitDefaultValue = false)]
public string Currency { get; set; }
/// <summary>
/// Amount of funds being requested
/// </summary>
/// <value>Amount of funds being requested</value>
[DataMember(Name = "amount", EmitDefaultValue = false)]
public decimal Amount { get; set; }
/// <summary>
/// Name of the paying customer
/// </summary>
/// <value>Name of the paying customer</value>
[DataMember(Name = "debtorName", EmitDefaultValue = false)]
public string DebtorName { get; set; }
/// <summary>
/// Financial institution's internal reference for the payer's account
/// </summary>
/// <value>Financial institution's internal reference for the payer's account</value>
[DataMember(Name = "debtorAccountReference", EmitDefaultValue = false)]
public string DebtorAccountReference { get; set; }
/// <summary>
/// Type of account reference, such as <code>IBAN</code>. Mandatory when <code>debtorAccountReference</code> is provided.
/// </summary>
/// <value>Type of account reference, such as <code>IBAN</code>. Mandatory when <code>debtorAccountReference</code> is provided.</value>
[DataMember(Name = "debtorAccountReferenceType", EmitDefaultValue = false)]
public string DebtorAccountReferenceType { get; set; }
/// <summary>
/// Name of the payee
/// </summary>
/// <value>Name of the payee</value>
[DataMember(Name = "creditorName", EmitDefaultValue = false)]
public string CreditorName { get; set; }
/// <summary>
/// Financial institution's internal reference for the payee's account
/// </summary>
/// <value>Financial institution's internal reference for the payee's account</value>
[DataMember(Name = "creditorAccountReference", EmitDefaultValue = false)]
public string CreditorAccountReference { get; set; }
/// <summary>
/// Type of payee's account reference, such as <code>IBAN</code>
/// </summary>
/// <value>Type of payee's account reference, such as <code>IBAN</code></value>
[DataMember(Name = "creditorAccountReferenceType", EmitDefaultValue = false)]
public string CreditorAccountReferenceType { get; set; }
/// <summary>
/// Reference to the financial institution
/// </summary>
/// <value>Reference to the financial institution</value>
[DataMember(Name = "creditorAgent", EmitDefaultValue = false)]
public string CreditorAgent { get; set; }
/// <summary>
/// Type of financial institution reference, such as <code>BIC</code>
/// </summary>
/// <value>Type of financial institution reference, such as <code>BIC</code></value>
[DataMember(Name = "creditorAgentType", EmitDefaultValue = false)]
public string CreditorAgentType { get; set; }
/// <summary>
/// Identifier assigned by the initiating party to identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain and so it has to follow the <a href='https://www.iso20022.org/'>ISO 20022</a> constraint of being at most 35 characters long. A good way to generate such a unique identifier is to take a UUID and strip the dashes.
/// </summary>
/// <value>Identifier assigned by the initiating party to identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain and so it has to follow the <a href='https://www.iso20022.org/'>ISO 20022</a> constraint of being at most 35 characters long. A good way to generate such a unique identifier is to take a UUID and strip the dashes.</value>
[DataMember(Name = "endToEndId", EmitDefaultValue = false)]
public string EndToEndId { get; set; }
/// <summary>
/// Represents the language to be used in the authorization interface (<code>\"en\"</code>, <code>\"nl\"</code>, or <code>\"fr\"</code>). The default language is English.
/// </summary>
/// <value>Represents the language to be used in the authorization interface (<code>\"en\"</code>, <code>\"nl\"</code>, or <code>\"fr\"</code>). The default language is English.</value>
[DataMember(Name = "locale", EmitDefaultValue = false)]
public string Locale { get; set; }
/// <summary>
/// Specifies the IP of the customer, to be passed to the financial institution. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.
/// </summary>
/// <value>Specifies the IP of the customer, to be passed to the financial institution. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.</value>
[DataMember(Name = "customerIpAddress", EmitDefaultValue = false)]
public string CustomerIpAddress { get; set; }
/// <summary>
/// When set to true, the returned <code>redirectUri</code> will be the one of the financial institution, avoiding an extra hop on Ibanity for the customer. It also fixes app-to-app redirects on IOS. Defaults to <code>false</code> to ensure backward compatibility.
/// </summary>
/// <value>When set to true, the returned <code>redirectUri</code> will be the one of the financial institution, avoiding an extra hop on Ibanity for the customer. It also fixes app-to-app redirects on IOS. Defaults to <code>false</code> to ensure backward compatibility.</value>
[DataMember(Name = "allowFinancialInstitutionRedirectUri", EmitDefaultValue = false)]
public bool? AllowFinancialInstitutionRedirectUri { get; set; }
/// <summary>
/// When set to true, TPP managed authorization flow will be enabled. The financial institution will redirect your customer to the <code>redirectUri</code> avoiding an extra hop on Ibanity. By default, the XS2A managed authorization flow is used. If set to <code>true</code>, a <code>state</code> must be provided.
/// </summary>
/// <value>When set to true, TPP managed authorization flow will be enabled. The financial institution will redirect your customer to the <code>redirectUri</code> avoiding an extra hop on Ibanity. By default, the XS2A managed authorization flow is used. If set to <code>true</code>, a <code>state</code> must be provided.</value>
[DataMember(Name = "skipIbanityCompletionCallback", EmitDefaultValue = false)]
public bool? SkipIbanityCompletionCallback { get; set; }
/// <summary>
/// The state you want to append to the redirectUri at the end of the authorization flow.
/// </summary>
/// <value>The state you want to append to the redirectUri at the end of the authorization flow.</value>
[DataMember(Name = "state", EmitDefaultValue = false)]
public string State { get; set; }
/// <summary>
/// Identifier the customer uses to log into the financial institution's online portal. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.
/// </summary>
/// <value>Identifier the customer uses to log into the financial institution's online portal. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.</value>
[DataMember(Name = "financialInstitutionCustomerReference", EmitDefaultValue = false)]
public string FinancialInstitutionCustomerReference { get; set; }
}
/// <summary>
/// This is an object representing a resource batch-synchronization. This object will give you the details of the batch-synchronization.
/// </summary>
[DataContract]
public class PaymentInitiationRequestResponse : PaymentInitiationRequest, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// Current status of the payment initiation request. Possible values are <code>accepted-customer-profile</code>, <code>accepted-settlement-completed</code>, <code>accepted-settlement-in-progress</code>, <code>accepted-technical-validation</code>, <code>accepted-with-change</code>, <code>accepted-without-posting</code>, <code>received</code>, <code>pending</code>, and <code>rejected</code>. <a href='/xs2a/products#pir-status-codes'>See status definitions.</a>
/// </summary>
/// <value>Current status of the payment initiation request. Possible values are <code>accepted-customer-profile</code>, <code>accepted-settlement-completed</code>, <code>accepted-settlement-in-progress</code>, <code>accepted-technical-validation</code>, <code>accepted-with-change</code>, <code>accepted-without-posting</code>, <code>received</code>, <code>pending</code>, and <code>rejected</code>. <a href='/xs2a/products#pir-status-codes'>See status definitions.</a></value>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
/// <summary>
/// Details about the reason why the payment was refused by the financial institution.
/// </summary>
/// <value>Details about the reason why the payment was refused by the financial institution.</value>
[DataMember(Name = "statusReason", EmitDefaultValue = false)]
public string StatusReason { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\PaymentInitiationRequestAuthorization.cs | using System.Runtime.Serialization;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// Details about the associated payment initiation request
/// </summary>
[DataContract]
public class PaymentInitiationRequestAuthorizationRelationships
{
/// <summary>
/// Details about the associated payment initiation request
/// </summary>
[DataMember(Name = "paymentInitiationRequest", EmitDefaultValue = false)]
public JsonApi.Relationship<PaymentInitiationRequestRelationship> PaymentInitiationRequest { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\PendingTransaction.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing an account pending transaction. This object will give you the details of the financial transaction, including its amount and description.</p>
/// <p>From this object, you can link back to its account.</p>
/// <p>The Pending transaction API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
[DataContract]
public class PendingTransaction : Identified<Guid>
{
/// <summary>
/// Additional transaction-related information provided from the financial institution to the customer
/// </summary>
/// <value>Additional transaction-related information provided from the financial institution to the customer</value>
[DataMember(Name = "additionalInformation", EmitDefaultValue = false)]
public string AdditionalInformation { get; set; }
/// <summary>
/// Amount of the pending transaction. Can be positive or negative
/// </summary>
/// <value>Amount of the pending transaction. Can be positive or negative</value>
[DataMember(Name = "amount", EmitDefaultValue = false)]
public decimal Amount { get; set; }
/// <summary>
/// Bank transaction code, based on <a href='https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets'>ISO 20022</a>
/// </summary>
/// <value>Bank transaction code, based on <a href='https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets'>ISO 20022</a></value>
[DataMember(Name = "bankTransactionCode", EmitDefaultValue = false)]
public string BankTransactionCode { get; set; }
/// <summary>
/// Reference for card related to the transaction (if any). For example the last 4 digits of the card number.
/// </summary>
/// <value>Reference for card related to the transaction (if any). For example the last 4 digits of the card number.</value>
[DataMember(Name = "cardReference", EmitDefaultValue = false)]
public string CardReference { get; set; }
/// <summary>
/// Type of card reference (can be <code>PAN</code> or <code>MASKEDPAN</code>)
/// </summary>
/// <value>Type of card reference (can be <code>PAN</code> or <code>MASKEDPAN</code>)</value>
[DataMember(Name = "cardReferenceType", EmitDefaultValue = false)]
public string CardReferenceType { get; set; }
/// <summary>
/// Legal name of the counterpart
/// </summary>
/// <value>Legal name of the counterpart</value>
[DataMember(Name = "counterpartName", EmitDefaultValue = false)]
public string CounterpartName { get; set; }
/// <summary>
/// Number representing the counterpart's account
/// </summary>
/// <value>Number representing the counterpart's account</value>
[DataMember(Name = "counterpartReference", EmitDefaultValue = false)]
public string CounterpartReference { get; set; }
/// <summary>
/// When this pending transaction was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this pending transaction was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "createdAt", EmitDefaultValue = false)]
public DateTimeOffset? CreatedAt { get; set; }
/// <summary>
/// Identification of the creditor, e.g. a SEPA Creditor ID.
/// </summary>
/// <value>Identification of the creditor, e.g. a SEPA Creditor ID.</value>
[DataMember(Name = "creditorId", EmitDefaultValue = false)]
public string CreditorId { get; set; }
/// <summary>
/// Currency of the pending transaction, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format
/// </summary>
/// <value>Currency of the pending transaction, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format</value>
[DataMember(Name = "currency", EmitDefaultValue = false)]
public string Currency { get; set; }
/// <summary>
/// Description of the pending transaction
/// </summary>
/// <value>Description of the pending transaction</value>
[DataMember(Name = "description", EmitDefaultValue = false)]
public string Description { get; set; }
/// <summary>
/// A Base64-encoded SHA-256 digest of the transaction payload from the financial institution. This may NOT be unique if the exact same transaction happens on the same day, on the same account.
/// </summary>
/// <value>A Base64-encoded SHA-256 digest of the transaction payload from the financial institution. This may NOT be unique if the exact same transaction happens on the same day, on the same account.</value>
[DataMember(Name = "digest", EmitDefaultValue = false)]
public string Digest { get; set; }
/// <summary>
/// Identifier assigned by the initiating party to identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
/// </summary>
/// <value>Identifier assigned by the initiating party to identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.</value>
[DataMember(Name = "endToEndId", EmitDefaultValue = false)]
public string EndToEndId { get; set; }
/// <summary>
/// Date representing the moment the pending transaction has been recorded
/// </summary>
/// <value>Date representing the moment the pending transaction has been recorded</value>
[DataMember(Name = "executionDate", EmitDefaultValue = false)]
public DateTimeOffset? ExecutionDate { get; set; }
/// <summary>
/// A fee that was withheld from this transaction at the financial institution
/// </summary>
/// <value>A fee that was withheld from this transaction at the financial institution</value>
[DataMember(Name = "fee", EmitDefaultValue = false)]
public decimal? Fee { get; set; }
/// <summary>
/// Internal resource reference given by the financial institution
/// </summary>
/// <value>Internal resource reference given by the financial institution</value>
[DataMember(Name = "internalReference", EmitDefaultValue = false)]
public string InternalReference { get; set; }
/// <summary>
/// Unique reference of the mandate which is signed between the remitter and the debtor
/// </summary>
/// <value>Unique reference of the mandate which is signed between the remitter and the debtor</value>
[DataMember(Name = "mandateId", EmitDefaultValue = false)]
public string MandateId { get; set; }
/// <summary>
/// Bank transaction code prorietary to the financial institution. Content will vary per financial institution
/// </summary>
/// <value>Bank transaction code prorietary to the financial institution. Content will vary per financial institution</value>
[DataMember(Name = "proprietaryBankTransactionCode", EmitDefaultValue = false)]
public string ProprietaryBankTransactionCode { get; set; }
/// <summary>
/// Purpose code, based on <a href='https://www.iso20022.org/'>ISO 20022</a>
/// </summary>
/// <value>Purpose code, based on <a href='https://www.iso20022.org/'>ISO 20022</a></value>
[DataMember(Name = "purposeCode", EmitDefaultValue = false)]
public string PurposeCode { get; set; }
/// <summary>
/// Content of the remittance information (aka communication)
/// </summary>
/// <value>Content of the remittance information (aka communication)</value>
[DataMember(Name = "remittanceInformation", EmitDefaultValue = false)]
public string RemittanceInformation { get; set; }
/// <summary>
/// Type of remittance information. Can be <code>structured</code> or <code>unstructured</code>
/// </summary>
/// <value>Type of remittance information. Can be <code>structured</code> or <code>unstructured</code></value>
[DataMember(Name = "remittanceInformationType", EmitDefaultValue = false)]
public string RemittanceInformationType { get; set; }
/// <summary>
/// When this pending transaction was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this pending transaction was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "updatedAt", EmitDefaultValue = false)]
public DateTimeOffset? UpdatedAt { get; set; }
/// <summary>
/// Date representing the moment the pending transaction is considered effective
/// </summary>
/// <value>Date representing the moment the pending transaction is considered effective</value>
[DataMember(Name = "valueDate", EmitDefaultValue = false)]
public DateTimeOffset? ValueDate { get; set; }
/// <summary>
/// ID of the account that this transaction belongs to.
/// </summary>
public Guid AccountId { get; set; }
}
/// <summary>
/// Link to the account that this pending transaction belongs to
/// </summary>
[DataContract]
public class PendingTransactionRelationships
{
/// <summary>
/// Link to the account that this transaction belongs to.
/// </summary>
[DataMember(Name = "account", EmitDefaultValue = false)]
public JsonApi.Relationship Account { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\PeriodicPaymentInitiationRequest.cs | using System;
using System.Globalization;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing a periodic payment initiation request. When you want to initiate periodic payment from one of your customers, you have to create one to start the authorization flow.</p>
/// <p>When creating the periodic payment initiation request, you will receive the redirect link in the response. Your customer should be redirected to this url to begin the authorization process. At the end of the flow, they will be returned to the redirect uri that you defined.</p>
/// <p>If the periodic payment initiation is not authorized (for example when the customer cancels the flow), an error query parameter will be added to the redirect uri with the value rejected.</p>
/// <p>When authorizing periodic payment initiation from a financial institution user (in the sandbox), you should use 123456 as the digipass response.</p>
/// </summary>
[DataContract]
public class PeriodicPaymentInitiationRequest
{
/// <summary>
/// URI that your customer will be redirected to at the end of the authorization flow. HTTPS is required for live applications.
/// </summary>
/// <value>URI that your customer will be redirected to at the end of the authorization flow. HTTPS is required for live applications.</value>
[DataMember(Name = "redirectUri", EmitDefaultValue = false)]
public string RedirectUri { get; set; }
/// <summary>
/// Your internal reference to the explicit consent provided by your consumer. You should store this consent reference in case of dispute.
/// </summary>
/// <value>Your internal reference to the explicit consent provided by your consumer. You should store this consent reference in case of dispute.</value>
[DataMember(Name = "consentReference", EmitDefaultValue = false)]
public string ConsentReference { get; set; }
/// <summary>
/// Type of periodic payment transfer. Will always be <code>sepa-credit-transfer</code>
/// </summary>
/// <value>Type of periodic payment transfer. Will always be <code>sepa-credit-transfer</code></value>
[DataMember(Name = "productType", EmitDefaultValue = false)]
public string ProductType { get; set; }
/// <summary>
/// Content of the remittance information (aka communication)
/// </summary>
/// <value>Content of the remittance information (aka communication)</value>
[DataMember(Name = "remittanceInformation", EmitDefaultValue = false)]
public string RemittanceInformation { get; set; }
/// <summary>
/// Type of remittance information, can be <code>structured</code> or <code>unstructured</code>
/// </summary>
/// <value>Type of remittance information, can be <code>structured</code> or <code>unstructured</code></value>
[DataMember(Name = "remittanceInformationType", EmitDefaultValue = false)]
public string RemittanceInformationType { get; set; }
/// <summary>
/// A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>financial institution attributes</a>
/// </summary>
/// <value>A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>financial institution attributes</a></value>
[DataMember(Name = "requestedExecutionDate", EmitDefaultValue = false)]
public string RequestedExecutionDateString
{
get => RequestedExecutionDate.HasValue
? RequestedExecutionDate.Value.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture)
: null;
set => RequestedExecutionDate = !string.IsNullOrWhiteSpace(value)
? (DateTimeOffset?)DateTimeOffset.Parse(value, CultureInfo.InvariantCulture)
: null;
}
/// <summary>
/// A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>financial institution attributes</a>
/// </summary>
/// <value>A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution. See <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>financial institution attributes</a></value>
public DateTimeOffset? RequestedExecutionDate { get; set; }
/// <summary>
/// Currency of the periodic payment initiation request, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format
/// </summary>
/// <value>Currency of the periodic payment initiation request, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format</value>
[DataMember(Name = "currency", EmitDefaultValue = false)]
public string Currency { get; set; }
/// <summary>
/// Amount of funds being requested
/// </summary>
/// <value>Amount of funds being requested</value>
[DataMember(Name = "amount", EmitDefaultValue = false)]
public decimal Amount { get; set; }
/// <summary>
/// Name of the paying customer
/// </summary>
/// <value>Name of the paying customer</value>
[DataMember(Name = "debtorName", EmitDefaultValue = false)]
public string DebtorName { get; set; }
/// <summary>
/// Financial institution's internal reference for the payer's account
/// </summary>
/// <value>Financial institution's internal reference for the payer's account</value>
[DataMember(Name = "debtorAccountReference", EmitDefaultValue = false)]
public string DebtorAccountReference { get; set; }
/// <summary>
/// Type of account reference, such as <code>IBAN</code>. Mandatory when <code>debtorAccountReference</code> is provided.
/// </summary>
/// <value>Type of account reference, such as <code>IBAN</code>. Mandatory when <code>debtorAccountReference</code> is provided.</value>
[DataMember(Name = "debtorAccountReferenceType", EmitDefaultValue = false)]
public string DebtorAccountReferenceType { get; set; }
/// <summary>
/// Name of the payee
/// </summary>
/// <value>Name of the payee</value>
[DataMember(Name = "creditorName", EmitDefaultValue = false)]
public string CreditorName { get; set; }
/// <summary>
/// Financial institution's internal reference for the payee's account
/// </summary>
/// <value>Financial institution's internal reference for the payee's account</value>
[DataMember(Name = "creditorAccountReference", EmitDefaultValue = false)]
public string CreditorAccountReference { get; set; }
/// <summary>
/// Type of payee's account reference, such as <code>IBAN</code>
/// </summary>
/// <value>Type of payee's account reference, such as <code>IBAN</code></value>
[DataMember(Name = "creditorAccountReferenceType", EmitDefaultValue = false)]
public string CreditorAccountReferenceType { get; set; }
/// <summary>
/// Reference to the financial institution
/// </summary>
/// <value>Reference to the financial institution</value>
[DataMember(Name = "creditorAgent", EmitDefaultValue = false)]
public string CreditorAgent { get; set; }
/// <summary>
/// Type of financial institution reference, such as <code>BIC</code>
/// </summary>
/// <value>Type of financial institution reference, such as <code>BIC</code></value>
[DataMember(Name = "creditorAgentType", EmitDefaultValue = false)]
public string CreditorAgentType { get; set; }
/// <summary>
/// Identifier assigned by the initiating party to identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain and so it has to follow the <a href='https://www.iso20022.org/'>ISO 20022</a> constraint of being at most 35 characters long. A good way to generate such a unique identifier is to take a UUID and strip the dashes.
/// </summary>
/// <value>Identifier assigned by the initiating party to identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain and so it has to follow the <a href='https://www.iso20022.org/'>ISO 20022</a> constraint of being at most 35 characters long. A good way to generate such a unique identifier is to take a UUID and strip the dashes.</value>
[DataMember(Name = "endToEndId", EmitDefaultValue = false)]
public string EndToEndId { get; set; }
/// <summary>
/// Represents the language to be used in the authorization interface (<code>\"en\"</code>, <code>\"nl\"</code>, or <code>\"fr\"</code>). The default language is English.
/// </summary>
/// <value>Represents the language to be used in the authorization interface (<code>\"en\"</code>, <code>\"nl\"</code>, or <code>\"fr\"</code>). The default language is English.</value>
[DataMember(Name = "locale", EmitDefaultValue = false)]
public string Locale { get; set; }
/// <summary>
/// Specifies the IP of the customer, to be passed to the financial institution. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.
/// </summary>
/// <value>Specifies the IP of the customer, to be passed to the financial institution. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.</value>
[DataMember(Name = "customerIpAddress", EmitDefaultValue = false)]
public string CustomerIpAddress { get; set; }
/// <summary>
/// When set to true, the returned <code>redirectUri</code> will be the one of the financial institution, avoiding an extra hop on Ibanity for the customer. It also fixes app-to-app redirects on IOS. Defaults to <code>false</code> to ensure backward compatibility.
/// </summary>
/// <value>When set to true, the returned <code>redirectUri</code> will be the one of the financial institution, avoiding an extra hop on Ibanity for the customer. It also fixes app-to-app redirects on IOS. Defaults to <code>false</code> to ensure backward compatibility.</value>
[DataMember(Name = "allowFinancialInstitutionRedirectUri", EmitDefaultValue = true)]
public bool AllowFinancialInstitutionRedirectUri { get; set; }
/// <summary>
/// When set to true, TPP managed authorization flow will be enabled. The financial institution will redirect your customer to the <code>redirectUri</code> avoiding an extra hop on Ibanity. By default, the XS2A managed authorization flow is used. If set to <code>true</code>, a <code>state</code> must be provided.
/// </summary>
/// <value>When set to true, TPP managed authorization flow will be enabled. The financial institution will redirect your customer to the <code>redirectUri</code> avoiding an extra hop on Ibanity. By default, the XS2A managed authorization flow is used. If set to <code>true</code>, a <code>state</code> must be provided.</value>
[DataMember(Name = "skipIbanityCompletionCallback", EmitDefaultValue = true)]
public bool SkipIbanityCompletionCallback { get; set; }
/// <summary>
/// The state you want to append to the redirectUri at the end of the authorization flow.
/// </summary>
/// <value>The state you want to append to the redirectUri at the end of the authorization flow.</value>
[DataMember(Name = "state", EmitDefaultValue = false)]
public string State { get; set; }
/// <summary>
/// Date of the first execution of the periodic payment
/// </summary>
/// <value>Date of the first execution of the periodic payment</value>
[DataMember(Name = "startDate", EmitDefaultValue = false)]
public string StartDateString
{
get => StartDate.HasValue
? StartDate.Value.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture)
: null;
set => StartDate = !string.IsNullOrWhiteSpace(value)
? (DateTimeOffset?)DateTimeOffset.Parse(value, CultureInfo.InvariantCulture)
: null;
}
/// <summary>
/// Date of the first execution of the periodic payment
/// </summary>
/// <value>Date of the first execution of the periodic payment</value>
public DateTimeOffset? StartDate { get; set; }
/// <summary>
/// Date of the last execution of the periodic payment
/// </summary>
/// <value>Date of the last execution of the periodic payment</value>
[DataMember(Name = "endDate", EmitDefaultValue = false)]
public string EndDateString
{
get => EndDate.HasValue
? EndDate.Value.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture)
: null;
set => EndDate = !string.IsNullOrWhiteSpace(value)
? (DateTimeOffset?)DateTimeOffset.Parse(value, CultureInfo.InvariantCulture)
: null;
}
/// <summary>
/// Date of the last execution of the periodic payment
/// </summary>
/// <value>Date of the last execution of the periodic payment</value>
public DateTimeOffset? EndDate { get; set; }
/// <summary>
/// Frequency of the periodic payment. Can be <code>weekly</code>, <code>everyTwoWeeks</code>, <code>monthly</code>, <code>everyTwoMonths</code>, <code>quarterly</code>, <code>semiannual</code> or <code>annual</code>
/// </summary>
/// <value>Frequency of the periodic payment. Can be <code>weekly</code>, <code>everyTwoWeeks</code>, <code>monthly</code>, <code>everyTwoMonths</code>, <code>quarterly</code>, <code>semiannual</code> or <code>annual</code></value>
[DataMember(Name = "frequency", EmitDefaultValue = false)]
public string Frequency { get; set; }
/// <summary>
/// Defines what to do if the execution should fall on a closing day. Can be <code>following</code> to execute on the next opening day, or <code>preceding</code> to execute on the previous opening day
/// </summary>
/// <value>Defines what to do if the execution should fall on a closing day. Can be <code>following</code> to execute on the next opening day, or <code>preceding</code> to execute on the previous opening day</value>
[DataMember(Name = "executionRule", EmitDefaultValue = false)]
public string ExecutionRule { get; set; }
/// <summary>
/// Identifier the customer uses to log into the financial institution's online portal. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.
/// </summary>
/// <value>Identifier the customer uses to log into the financial institution's online portal. Required for some financial institutions as indicated in their <a href='https://documentation.ibanity.com/xs2a/api#financial-institution-attributes'>attributes</a>.</value>
[DataMember(Name = "financialInstitutionCustomerReference", EmitDefaultValue = false)]
public string FinancialInstitutionCustomerReference { get; set; }
}
/// <summary>
/// This is an object representing a resource batch-synchronization. This object will give you the details of the batch-synchronization.
/// </summary>
[DataContract]
public class PeriodicPaymentInitiationRequestResponse : PeriodicPaymentInitiationRequest, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// Current status of the periodic payment initiation request. Possible values are <code>accepted-customer-profile</code>, <code>accepted-settlement-completed</code>, <code>accepted-settlement-in-progress</code>, <code>accepted-technical-validation</code>, <code>accepted-with-change</code>, <code>accepted-without-posting</code>, <code>received</code>, <code>pending</code>, and <code>rejected</code>. <a href='/xs2a/products#pir-status-codes'>See status definitions.</a>
/// </summary>
/// <value>Current status of the periodic payment initiation request. Possible values are <code>accepted-customer-profile</code>, <code>accepted-settlement-completed</code>, <code>accepted-settlement-in-progress</code>, <code>accepted-technical-validation</code>, <code>accepted-with-change</code>, <code>accepted-without-posting</code>, <code>received</code>, <code>pending</code>, and <code>rejected</code>. <a href='/xs2a/products#pir-status-codes'>See status definitions.</a></value>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
/// <summary>
/// Details about the reason why the periodic payment was refused by the financial institution.
/// </summary>
/// <value>Details about the reason why the periodic payment was refused by the financial institution.</value>
[DataMember(Name = "statusReason", EmitDefaultValue = false)]
public string StatusReason { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\PeriodicPaymentInitiationRequestAuthorization.cs | using System.Runtime.Serialization;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// Details about the associated periodic payment initiation request
/// </summary>
[DataContract]
public class PeriodicPaymentInitiationRequestAuthorizationRelationships
{
/// <summary>
/// Details about the associated periodic payment initiation request
/// </summary>
[DataMember(Name = "periodicPaymentInitiationRequest", EmitDefaultValue = false)]
public JsonApi.Relationship<PaymentInitiationRequestRelationship> PeriodicPaymentInitiationRequest { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\SandboxFinancialInstitutionAccount.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing a financial institution account, a fake account you create for test purposes.</p>
/// <p>In addition to the regular account API calls, there are sandbox-specific endpoints available to manage your sandbox data.</p>
/// <p>A financial institution account belongs to a financial institution user and financial institution and can have many associated financial institution transactions.</p>
/// </summary>
[DataContract]
public class SandboxFinancialInstitutionAccount
{
/// <summary>
/// Type of financial institution account. Can be <code>checking</code>, <code>savings</code>, <code>securities</code>, <code>card</code> or <code>psp</code>
/// </summary>
/// <value>Type of financial institution account. Can be <code>checking</code>, <code>savings</code>, <code>securities</code>, <code>card</code> or <code>psp</code></value>
[DataMember(Name = "subtype", IsRequired = true, EmitDefaultValue = true)]
public string Subtype { get; set; }
/// <summary>
/// Financial institution's internal reference for this financial institution account
/// </summary>
/// <value>Financial institution's internal reference for this financial institution account</value>
[DataMember(Name = "reference", IsRequired = true, EmitDefaultValue = true)]
public string Reference { get; set; }
/// <summary>
/// Type of financial institution reference (can be <code>IBAN</code>, <code>BBAN</code>, <code>email</code>, <code>PAN</code>, <code>MASKEDPAN</code> or <code>MSISDN</code>)
/// </summary>
/// <value>Type of financial institution reference (can be <code>IBAN</code>, <code>BBAN</code>, <code>email</code>, <code>PAN</code>, <code>MASKEDPAN</code> or <code>MSISDN</code>)</value>
[DataMember(Name = "referenceType", IsRequired = true, EmitDefaultValue = true)]
public string ReferenceType { get; set; }
/// <summary>
/// Description of the financial institution account
/// </summary>
/// <value>Description of the financial institution account</value>
[DataMember(Name = "description", IsRequired = true, EmitDefaultValue = true)]
public string Description { get; set; }
/// <summary>
/// Currency of the financial institution account, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format
/// </summary>
/// <value>Currency of the financial institution account, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format</value>
[DataMember(Name = "currency", IsRequired = true, EmitDefaultValue = true)]
public string Currency { get; set; }
/// <summary>
/// Name of the account product
/// </summary>
/// <value>Name of the account product</value>
[DataMember(Name = "product", EmitDefaultValue = false)]
public string Product { get; set; }
/// <summary>
/// Name of the account holder
/// </summary>
/// <value>Name of the account holder</value>
[DataMember(Name = "holderName", EmitDefaultValue = false)]
public string HolderName { get; set; }
}
/// <inheritdoc />
[DataContract]
public class SandboxFinancialInstitutionAccountResponse : SandboxFinancialInstitutionAccount, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// Amount of financial institution account funds that can be accessed immediately
/// </summary>
/// <value>Amount of financial institution account funds that can be accessed immediately</value>
[DataMember(Name = "availableBalance", EmitDefaultValue = false)]
public decimal AvailableBalance { get; set; }
/// <summary>
/// When the available balance was changed for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When the available balance was changed for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "availableBalanceChangedAt", EmitDefaultValue = false)]
public DateTimeOffset AvailableBalanceChangedAt { get; set; }
/// <summary>
/// Reference date of the available balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>Reference date of the available balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "availableBalanceReferenceDate", EmitDefaultValue = false)]
public DateTimeOffset AvailableBalanceReferenceDate { get; set; }
/// <summary>
/// When this financial institution account was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this financial institution account was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "createdAt", EmitDefaultValue = false)]
public DateTimeOffset CreatedAt { get; set; }
/// <summary>
/// Total funds currently in the financial institution account
/// </summary>
/// <value>Total funds currently in the financial institution account</value>
[DataMember(Name = "currentBalance", EmitDefaultValue = false)]
public decimal CurrentBalance { get; set; }
/// <summary>
/// When the current balance was changed for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When the current balance was changed for the last time. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "currentBalanceChangedAt", EmitDefaultValue = false)]
public DateTimeOffset CurrentBalanceChangedAt { get; set; }
/// <summary>
/// Reference date of the current balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>Reference date of the current balance. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "currentBalanceReferenceDate", EmitDefaultValue = false)]
public DateTimeOffset CurrentBalanceReferenceDate { get; set; }
/// <summary>
/// When this financial institution account was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this financial institution account was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "updatedAt", EmitDefaultValue = false)]
public DateTimeOffset UpdatedAt { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\SandboxFinancialInstitutionHolding.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing a financial institution holding, a fake holding on a fake securities account you can create for test purposes.</p>
/// <p>In addition to the regular holding API calls, there are sandbox-specific endpoints available to manage your sandbox data.</p>
/// <p>From this object, you can follow the link to its related financial institution account</p>
/// </summary>
[DataContract]
public class SandboxFinancialInstitutionHolding
{
/// <summary>
/// Name of the financial institution holding
/// </summary>
/// <value>Name of the financial institution holding</value>
[DataMember(Name = "name", EmitDefaultValue = false)]
public string Name { get; set; }
/// <summary>
/// Type of holding. Can be <code>SICAV</code>, <code>STOCK</code> or <code>OTHER</code>
/// </summary>
/// <value>Type of holding. Can be <code>SICAV</code>, <code>STOCK</code> or <code>OTHER</code></value>
[DataMember(Name = "subtype", EmitDefaultValue = false)]
public string Subtype { get; set; }
/// <summary>
/// The reference of the holding
/// </summary>
/// <value>The reference of the holding</value>
[DataMember(Name = "reference", EmitDefaultValue = false)]
public string Reference { get; set; }
/// <summary>
/// Type of holding reference (such as <code>ISIN</code>)
/// </summary>
/// <value>Type of holding reference (such as <code>ISIN</code>)</value>
[DataMember(Name = "reference_type", EmitDefaultValue = false)]
public string ReferenceType { get; set; }
/// <summary>
/// Number of the financial institution holding
/// </summary>
/// <value>Number of the financial institution holding</value>
[DataMember(Name = "quantity", EmitDefaultValue = false)]
public decimal Quantity { get; set; }
/// <summary>
/// The date of the last valuation
/// </summary>
/// <value>The date of the last valuation</value>
[DataMember(Name = "lastValuationDate", EmitDefaultValue = false)]
public DateTimeOffset LastValuationDate { get; set; }
/// <summary>
/// The currency of the last valuation
/// </summary>
/// <value>The currency of the last valuation</value>
[DataMember(Name = "lastValuationCurrency", EmitDefaultValue = false)]
public string LastValuationCurrency { get; set; }
/// <summary>
/// Market value of 1 quantity
/// </summary>
/// <value>Market value of 1 quantity</value>
[DataMember(Name = "lastValuation", EmitDefaultValue = false)]
public decimal LastValuation { get; set; }
/// <summary>
/// The total value of the financial institution holding
/// </summary>
/// <value>The total value of the financial institution holding</value>
[DataMember(Name = "totalValuation", EmitDefaultValue = false)]
public decimal TotalValuation { get; set; }
/// <summary>
/// The currency of the total valuation
/// </summary>
/// <value>The currency of the total valuation</value>
[DataMember(Name = "totalValuationCurrency", EmitDefaultValue = false)]
public string TotalValuationCurrency { get; set; }
}
/// <inheritdoc />
[DataContract]
public class SandboxFinancialInstitutionHoldingResponse : SandboxFinancialInstitutionHolding, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// When this financial institution holding was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this financial institution holding was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "createdAt", EmitDefaultValue = false)]
public DateTimeOffset CreatedAt { get; set; }
/// <summary>
/// When this financial institution holding was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this financial institution holding was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "updatedAt", EmitDefaultValue = false)]
public DateTimeOffset UpdatedAt { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\SandboxFinancialInstitutionTransaction.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing a financial institution transaction, a fake transaction on a fake account you can create for test purposes.</p>
/// <p>In addition to the regular transaction API calls, there are sandbox-specific endpoints available to manage your sandbox data.</p>
/// <p>From this object, you can follow the link to its related financial institution account</p>
/// </summary>
[DataContract]
public class SandboxFinancialInstitutionTransaction
{
/// <summary>
/// Date representing the moment the financial institution transaction is considered effective
/// </summary>
/// <value>Date representing the moment the financial institution transaction is considered effective</value>
[DataMember(Name = "valueDate", IsRequired = true, EmitDefaultValue = true)]
public DateTimeOffset? ValueDate { get; set; }
/// <summary>
/// Date representing the moment the financial institution transaction has been recorded
/// </summary>
/// <value>Date representing the moment the financial institution transaction has been recorded</value>
[DataMember(Name = "executionDate", IsRequired = true, EmitDefaultValue = true)]
public DateTimeOffset? ExecutionDate { get; set; }
/// <summary>
/// Amount of the financial institution transaction. Can be positive or negative
/// </summary>
/// <value>Amount of the financial institution transaction. Can be positive or negative</value>
[DataMember(Name = "amount", IsRequired = true, EmitDefaultValue = true)]
public decimal? Amount { get; set; }
/// <summary>
/// Indicates whether the sandbox will return the transaction has 'pending' if the execution date is within the next 4 hours. (default 'false')
/// </summary>
/// <value>Indicates whether the sandbox will return the transaction has 'pending' if the execution date is within the next 4 hours. (default 'false')</value>
[DataMember(Name = "automaticBooking", IsRequired = true, EmitDefaultValue = true)]
public bool? AutomaticBooking { get; set; }
/// <summary>
/// Currency of the financial institution transaction, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format
/// </summary>
/// <value>Currency of the financial institution transaction, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format</value>
[DataMember(Name = "currency", IsRequired = true, EmitDefaultValue = true)]
public string Currency { get; set; }
/// <summary>
/// Legal name of the counterpart. Can only be updated if it was previously not provided (blank).
/// </summary>
/// <value>Legal name of the counterpart. Can only be updated if it was previously not provided (blank).</value>
[DataMember(Name = "counterpartName", EmitDefaultValue = false)]
public string CounterpartName { get; set; }
/// <summary>
/// Number representing the counterpart's account
/// </summary>
/// <value>Number representing the counterpart's account</value>
[DataMember(Name = "counterpartReference", EmitDefaultValue = false)]
public string CounterpartReference { get; set; }
/// <summary>
/// Description of the financial institution transaction
/// </summary>
/// <value>Description of the financial institution transaction</value>
[DataMember(Name = "description", IsRequired = true, EmitDefaultValue = true)]
public string Description { get; set; }
/// <summary>
/// Content of the remittance information (aka communication)
/// </summary>
/// <value>Content of the remittance information (aka communication)</value>
[DataMember(Name = "remittanceInformation", EmitDefaultValue = false)]
public string RemittanceInformation { get; set; }
/// <summary>
/// Type of remittance information, can be <code>structured</code> or <code>unstructured</code>
/// </summary>
/// <value>Type of remittance information, can be <code>structured</code> or <code>unstructured</code></value>
[DataMember(Name = "remittanceInformationType", IsRequired = true, EmitDefaultValue = true)]
public string RemittanceInformationType { get; set; }
/// <summary>
/// Identifier assigned by the initiating party to identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
/// </summary>
/// <value>Identifier assigned by the initiating party to identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.</value>
[DataMember(Name = "endToEndId", EmitDefaultValue = false)]
public string EndToEndId { get; set; }
/// <summary>
/// Purpose code, based on <a href='https://www.iso20022.org/'>ISO 20022</a>
/// </summary>
/// <value>Purpose code, based on <a href='https://www.iso20022.org/'>ISO 20022</a></value>
[DataMember(Name = "purposeCode", EmitDefaultValue = false)]
public string PurposeCode { get; set; }
/// <summary>
/// Unique reference of the mandate which is signed between the remitter and the debtor
/// </summary>
/// <value>Unique reference of the mandate which is signed between the remitter and the debtor</value>
[DataMember(Name = "mandateId", EmitDefaultValue = false)]
public string MandateId { get; set; }
/// <summary>
/// Identification of the creditor, e.g. a SEPA Creditor ID.
/// </summary>
/// <value>Identification of the creditor, e.g. a SEPA Creditor ID.</value>
[DataMember(Name = "creditorId", EmitDefaultValue = false)]
public string CreditorId { get; set; }
/// <summary>
/// Additional transaction-related information provided from the financial institution to the customer
/// </summary>
/// <value>Additional transaction-related information provided from the financial institution to the customer</value>
[DataMember(Name = "additionalInformation", EmitDefaultValue = false)]
public string AdditionalInformation { get; set; }
/// <summary>
/// Bank transaction code prorietary to the financial institution. Content will vary per financial institution
/// </summary>
/// <value>Bank transaction code prorietary to the financial institution. Content will vary per financial institution</value>
[DataMember(Name = "proprietaryBankTransactionCode", EmitDefaultValue = false)]
public string ProprietaryBankTransactionCode { get; set; }
/// <summary>
/// Bank transaction code, based on <a href='https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets'>ISO 20022</a>
/// </summary>
/// <value>Bank transaction code, based on <a href='https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets'>ISO 20022</a></value>
[DataMember(Name = "bankTransactionCode", EmitDefaultValue = false)]
public string BankTransactionCode { get; set; }
}
/// <inheritdoc />
[DataContract]
public class SandboxFinancialInstitutionTransactionResponse : SandboxFinancialInstitutionTransaction, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// Reference for card related to the transaction (if any). For example the last 4 digits of the card number.
/// </summary>
/// <value>Reference for card related to the transaction (if any). For example the last 4 digits of the card number.</value>
[DataMember(Name = "cardReference", EmitDefaultValue = false)]
public string CardReference { get; set; }
/// <summary>
/// Type of card reference (can be <code>PAN</code> or <code>MASKEDPAN</code>)
/// </summary>
/// <value>Type of card reference (can be <code>PAN</code> or <code>MASKEDPAN</code>)</value>
[DataMember(Name = "cardReferenceType", EmitDefaultValue = false)]
public string CardReferenceType { get; set; }
/// <summary>
/// When this financial institution transaction was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this financial institution transaction was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "createdAt", EmitDefaultValue = false)]
public DateTimeOffset CreatedAt { get; set; }
/// <summary>
/// A fee that was withheld from this transaction at the financial institution
/// </summary>
/// <value>A fee that was withheld from this transaction at the financial institution</value>
[DataMember(Name = "fee", EmitDefaultValue = false)]
public decimal? Fee { get; set; }
/// <summary>
/// When this financial institution transaction was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this financial institution transaction was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "updatedAt", EmitDefaultValue = false)]
public DateTimeOffset UpdatedAt { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\SandboxFinancialInstitutionUser.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing a financial institution user. It is a fake financial institution customer you can create for test purposes.</p>
/// <p>From this object, you can follow the links to its related financial institution accounts and transactions.</p>
/// </summary>
[DataContract]
public class SandboxFinancialInstitutionUser
{
/// <summary>
/// User's fake financial institution login
/// </summary>
/// <value>User's fake financial institution login</value>
[DataMember(Name = "login", EmitDefaultValue = false)]
public string Login { get; set; }
/// <summary>
/// User's fake financial institution login. Remember this is test data, so the password is stored and distributed unencrypted.
/// </summary>
/// <value>User's fake financial institution login. Remember this is test data, so the password is stored and distributed unencrypted.</value>
[DataMember(Name = "password", EmitDefaultValue = false)]
public string Password { get; set; }
/// <summary>
/// Last name of the user
/// </summary>
/// <value>Last name of the user</value>
[DataMember(Name = "lastName", EmitDefaultValue = false)]
public string LastName { get; set; }
/// <summary>
/// First name of the user
/// </summary>
/// <value>First name of the user</value>
[DataMember(Name = "firstName", EmitDefaultValue = false)]
public string FirstName { get; set; }
}
/// <inheritdoc />
[DataContract]
public class SandboxFinancialInstitutionUserResponse : SandboxFinancialInstitutionUser, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// When this financial institution user was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this financial institution user was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "createdAt", EmitDefaultValue = false)]
public DateTimeOffset CreatedAt { get; set; }
/// <summary>
/// When this financial institution user was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this financial institution user was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "updatedAt", EmitDefaultValue = false)]
public DateTimeOffset UpdatedAt { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\Synchronization.cs | using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing a resource synchronization. This object will give you the details of the synchronization, including its resource, type, and status.</p>
/// <p>The synchronization API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
[DataContract]
public class Synchronization
{
/// <summary>
/// Type of the resource to be synchronized. Currently must be <code>account</code>
/// </summary>
/// <value>Type of the resource to be synchronized. Currently must be <code>account</code></value>
[DataMember(Name = "resourceType", EmitDefaultValue = false)]
public string ResourceType { get; set; }
/// <summary>
/// Identifier of the resource to be synchronized
/// </summary>
/// <value>Identifier of the resource to be synchronized</value>
[DataMember(Name = "resourceId", EmitDefaultValue = false)]
public Guid ResourceId { get; set; }
/// <summary>
/// What is being synchronized. Account information such as balance is updated using <code>accountDetails</code>, while <code>accountTransactions</code> is used to synchronize the transactions.
/// </summary>
/// <value>What is being synchronized. Account information such as balance is updated using <code>accountDetails</code>, while <code>accountTransactions</code> is used to synchronize the transactions.</value>
[DataMember(Name = "subtype", EmitDefaultValue = false)]
public string Subtype { get; set; }
/// <summary>
/// When set to <code>true</code>, the TPP indicates that the customer is actively using the product during the call. In this case, the <code>customerIpAddress</code> is also required. When set to <code>false</code>, the TPP indicates that the call is made without the customer being present (scheduled / automated call).
/// </summary>
/// <value>When set to <code>true</code>, the TPP indicates that the customer is actively using the product during the call. In this case, the <code>customerIpAddress</code> is also required. When set to <code>false</code>, the TPP indicates that the call is made without the customer being present (scheduled / automated call).</value>
[DataMember(Name = "customerOnline", EmitDefaultValue = true)]
public bool CustomerOnline { get; set; }
}
/// <inheritdoc />
[DataContract]
public class SynchronizationRequest : Synchronization
{
/// <summary>
/// If the customer is online (<code>customerOnline</code> is set to <code>true</code>), this must contain the IP address of the customer
/// </summary>
/// <value>If the customer is online (<code>customerOnline</code> is set to <code>true</code>), this must contain the IP address of the customer</value>
[DataMember(Name = "customerIpAddress", EmitDefaultValue = true)]
public string CustomerIpAddress { get; set; }
}
/// <inheritdoc />
[DataContract]
public class SynchronizationResponse : Synchronization, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
/// <summary>
/// When this synchronization was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this synchronization was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "createdAt", EmitDefaultValue = false)]
public DateTimeOffset CreatedAt { get; set; }
/// <summary>
/// Details of any errors that have occurred during synchronization, due to invalid authorization or technical failure. <a href='https://documentation.ibanity.com//api#sync'>See possible errors</a>
/// </summary>
/// <value>Details of any errors that have occurred during synchronization, due to invalid authorization or technical failure. <a href='https://documentation.ibanity.com//api#sync'>See possible errors</a></value>
[DataMember(Name = "errors", EmitDefaultValue = false)]
public List<Object> Errors { get; set; }
/// <summary>
/// Current status of the synchronization, which changes from <code>pending</code> to <code>running</code> to <code>success</code> or <code>error</code>
/// </summary>
/// <value>Current status of the synchronization, which changes from <code>pending</code> to <code>running</code> to <code>success</code> or <code>error</code></value>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
/// <summary>
/// When this synchronization was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this synchronization was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "updatedAt", EmitDefaultValue = false)]
public DateTimeOffset UpdatedAt { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\Transaction.cs | using System;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing an account transaction. This object will give you the details of the financial transaction, including its amount and description.</p>
/// <p>From this object, you can link back to its account.</p>
/// <p>The transaction API endpoints are customer specific and therefore can only be accessed by providing the corresponding customer access token.</p>
/// </summary>
[DataContract]
public class Transaction : Identified<Guid>
{
/// <summary>
/// Additional transaction-related information provided from the financial institution to the customer
/// </summary>
/// <value>Additional transaction-related information provided from the financial institution to the customer</value>
[DataMember(Name = "additionalInformation", EmitDefaultValue = false)]
public string AdditionalInformation { get; set; }
/// <summary>
/// Amount of the transaction. Can be positive or negative
/// </summary>
/// <value>Amount of the transaction. Can be positive or negative</value>
[DataMember(Name = "amount", EmitDefaultValue = false)]
public decimal Amount { get; set; }
/// <summary>
/// Bank transaction code, based on <a href='https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets'>ISO 20022</a>
/// </summary>
/// <value>Bank transaction code, based on <a href='https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets'>ISO 20022</a></value>
[DataMember(Name = "bankTransactionCode", EmitDefaultValue = false)]
public string BankTransactionCode { get; set; }
/// <summary>
/// Reference for card related to the transaction (if any). For example the last 4 digits of the card number.
/// </summary>
/// <value>Reference for card related to the transaction (if any). For example the last 4 digits of the card number.</value>
[DataMember(Name = "cardReference", EmitDefaultValue = false)]
public string CardReference { get; set; }
/// <summary>
/// Type of card reference (can be <code>PAN</code> or <code>MASKEDPAN</code>)
/// </summary>
/// <value>Type of card reference (can be <code>PAN</code> or <code>MASKEDPAN</code>)</value>
[DataMember(Name = "cardReferenceType", EmitDefaultValue = false)]
public string CardReferenceType { get; set; }
/// <summary>
/// Legal name of the counterpart
/// </summary>
/// <value>Legal name of the counterpart</value>
[DataMember(Name = "counterpartName", EmitDefaultValue = false)]
public string CounterpartName { get; set; }
/// <summary>
/// Number representing the counterpart's account
/// </summary>
/// <value>Number representing the counterpart's account</value>
[DataMember(Name = "counterpartReference", EmitDefaultValue = false)]
public string CounterpartReference { get; set; }
/// <summary>
/// When this transaction was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this transaction was created. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "createdAt", EmitDefaultValue = false)]
public DateTimeOffset CreatedAt { get; set; }
/// <summary>
/// Identification of the creditor, e.g. a SEPA Creditor ID.
/// </summary>
/// <value>Identification of the creditor, e.g. a SEPA Creditor ID.</value>
[DataMember(Name = "creditorId", EmitDefaultValue = false)]
public string CreditorId { get; set; }
/// <summary>
/// Currency of the transaction, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format
/// </summary>
/// <value>Currency of the transaction, in <a href='https://en.wikipedia.org/wiki/ISO_4217'>ISO4217</a> format</value>
[DataMember(Name = "currency", EmitDefaultValue = false)]
public string Currency { get; set; }
/// <summary>
/// Description of the transaction
/// </summary>
/// <value>Description of the transaction</value>
[DataMember(Name = "description", EmitDefaultValue = false)]
public string Description { get; set; }
/// <summary>
/// A Base64-encoded SHA-256 digest of the transaction payload from the financial institution. This may NOT be unique if the exact same transaction happens on the same day, on the same account.
/// </summary>
/// <value>A Base64-encoded SHA-256 digest of the transaction payload from the financial institution. This may NOT be unique if the exact same transaction happens on the same day, on the same account.</value>
[DataMember(Name = "digest", EmitDefaultValue = false)]
public string Digest { get; set; }
/// <summary>
/// Identifier assigned by the initiating party to identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
/// </summary>
/// <value>Identifier assigned by the initiating party to identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.</value>
[DataMember(Name = "endToEndId", EmitDefaultValue = false)]
public string EndToEndId { get; set; }
/// <summary>
/// Date representing the moment the transaction has been recorded
/// </summary>
/// <value>Date representing the moment the transaction has been recorded</value>
[DataMember(Name = "executionDate", EmitDefaultValue = false)]
public DateTimeOffset ExecutionDate { get; set; }
/// <summary>
/// A fee that was withheld from this transaction at the financial institution
/// </summary>
/// <value>A fee that was withheld from this transaction at the financial institution</value>
[DataMember(Name = "fee", EmitDefaultValue = false)]
public decimal? Fee { get; set; }
/// <summary>
/// Internal resource reference given by the financial institution
/// </summary>
/// <value>Internal resource reference given by the financial institution</value>
[DataMember(Name = "internalReference", EmitDefaultValue = false)]
public string InternalReference { get; set; }
/// <summary>
/// Unique reference of the mandate which is signed between the remitter and the debtor
/// </summary>
/// <value>Unique reference of the mandate which is signed between the remitter and the debtor</value>
[DataMember(Name = "mandateId", EmitDefaultValue = false)]
public string MandateId { get; set; }
/// <summary>
/// Bank transaction code prorietary to the financial institution. Content will vary per financial institution
/// </summary>
/// <value>Bank transaction code prorietary to the financial institution. Content will vary per financial institution</value>
[DataMember(Name = "proprietaryBankTransactionCode", EmitDefaultValue = false)]
public string ProprietaryBankTransactionCode { get; set; }
/// <summary>
/// Purpose code, based on <a href='https://www.iso20022.org/'>ISO 20022</a>
/// </summary>
/// <value>Purpose code, based on <a href='https://www.iso20022.org/'>ISO 20022</a></value>
[DataMember(Name = "purposeCode", EmitDefaultValue = false)]
public string PurposeCode { get; set; }
/// <summary>
/// Content of the remittance information (aka communication)
/// </summary>
/// <value>Content of the remittance information (aka communication)</value>
[DataMember(Name = "remittanceInformation", EmitDefaultValue = false)]
public string RemittanceInformation { get; set; }
/// <summary>
/// Type of remittance information. Can be <code>structured</code> or <code>unstructured</code>
/// </summary>
/// <value>Type of remittance information. Can be <code>structured</code> or <code>unstructured</code></value>
[DataMember(Name = "remittanceInformationType", EmitDefaultValue = false)]
public string RemittanceInformationType { get; set; }
/// <summary>
/// When this transaction was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec
/// </summary>
/// <value>When this transaction was last synchronized successfully. Formatted according to <a href='https://en.wikipedia.org/wiki/ISO_8601'>ISO8601</a> spec</value>
[DataMember(Name = "updatedAt", EmitDefaultValue = false)]
public DateTimeOffset UpdatedAt { get; set; }
/// <summary>
/// Date representing the moment the transaction is considered effective
/// </summary>
/// <value>Date representing the moment the transaction is considered effective</value>
[DataMember(Name = "valueDate", EmitDefaultValue = false)]
public DateTimeOffset ValueDate { get; set; }
/// <summary>
/// ID of the account that this transaction belongs to.
/// </summary>
public Guid AccountId { get; set; }
}
/// <summary>
/// Link to the account that this transaction belongs to.
/// </summary>
[DataContract]
public class TransactionRelationships
{
/// <summary>
/// Link to the account that this transaction belongs to.
/// </summary>
[DataMember(Name = "account", EmitDefaultValue = false)]
public JsonApi.Relationship Account { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Products\XS2A | raw_data\ibanity-dotnet\src\Client\Products\XS2A\Models\TransactionDeleteRequest.cs | using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Products.XS2A.Models
{
/// <summary>
/// <p>This is an object representing a resource transaction delete request.</p>
/// <p>The transaction delete request API endpoints can be issued at the level of the application (all customers), a specific customer (all hiis/her accounts), or at account level. The customer access token is therefore only necessary for customer or account.</p>
/// </summary>
[DataContract]
public class TransactionDeleteRequest
{
/// <summary>
/// The requested date before which the transactions should be deleted.
/// </summary>
/// <value>The requested date before which the transactions should be deleted.</value>
[DataMember(Name = "beforeDate", EmitDefaultValue = false)]
public string BeforeDate { get; set; }
}
/// <inheritdoc />
[DataContract]
public class TransactionDeleteRequestRequest : TransactionDeleteRequest
{
}
/// <inheritdoc />
[DataContract]
public class TransactionDeleteRequestResponse : TransactionDeleteRequest, IIdentified<Guid>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public Guid Id { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client | raw_data\ibanity-dotnet\src\Client\Utils\Clock.cs | using System;
namespace Ibanity.Apis.Client.Utils
{
/// <inheritdoc />
public class Clock : IClock
{
/// <inheritdoc />
public DateTimeOffset Now => DateTimeOffset.Now;
}
/// <summary>
/// Allow to get current date and time.
/// </summary>
public interface IClock
{
/// <summary>
/// Current date and time.
/// </summary>
DateTimeOffset Now { get; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client | raw_data\ibanity-dotnet\src\Client\Utils\Identified.cs | using System.Runtime.Serialization;
namespace Ibanity.Apis.Client.Utils
{
/// <inheritdoc />
[DataContract]
public class Identified<T> : IIdentified<T>
{
/// <inheritdoc />
[DataMember(Name = "id", EmitDefaultValue = false)]
public T Id { get; set; }
}
/// <summary>
/// Resource identified by some unique value.
/// </summary>
/// <typeparam name="T"></typeparam>
public interface IIdentified<T>
{
/// <summary>
/// Unique identifier.
/// </summary>
T Id { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client | raw_data\ibanity-dotnet\src\Client\Utils\PaginatedCollection.cs | using System;
using System.Collections.Generic;
namespace Ibanity.Apis.Client.Utils
{
/// <summary>
/// <para>List of resources.</para>
/// <para>Contains a token to get the next page.</para>
/// </summary>
/// <typeparam name="T">Resource type.</typeparam>
#pragma warning disable CA1711 // Keep 'Collection' name
public class PaginatedCollection<T>
#pragma warning restore CA1711
{
/// <summary>
/// Token allowing to fetch the next page.
/// </summary>
public ContinuationToken ContinuationToken { get; set; }
/// <summary>
/// Actual list.
/// </summary>
public List<T> Items { get; set; }
}
/// <summary>
/// <para>List of resources.</para>
/// <para>Contains a token to get the next page.</para>
/// </summary>
/// <typeparam name="T">Resource type.</typeparam>
#pragma warning disable CA1711 // Keep 'Collection' name
public class IbanityCollection<T> : PaginatedCollection<T>
#pragma warning restore CA1711
{
/// <summary>
/// Maximum number (1-100) of resources that might be returned. It is possible that the response contains fewer elements. Defaults to 10.
/// </summary>
public long? PageLimit { get; set; }
/// <summary>
/// Cursor that specifies the first resource of the next page.
/// </summary>
public Guid? BeforeCursor { get; set; }
/// <summary>
/// Cursor that specifies the last resource of the previous page.
/// </summary>
public Guid? AfterCursor { get; set; }
/// <summary>
/// Link to the first page.
/// </summary>
public string FirstLink { get; set; }
/// <summary>
/// Link to the previous page.
/// </summary>
public string PreviousLink { get; set; }
/// <summary>
/// Link to the next page.
/// </summary>
public string NextLink { get; set; }
}
/// <summary>
/// <para>List of resources.</para>
/// <para>Contains a token to get the next page.</para>
/// </summary>
/// <typeparam name="T">Resource type.</typeparam>
#pragma warning disable CA1711 // Keep 'Collection' name
public class IsabelCollection<T> : PaginatedCollection<T>
#pragma warning restore CA1711
{
/// <summary>
/// Start position of the results by giving the number of records to be skipped.
/// </summary>
public long? Offset { get; set; }
/// <summary>
/// Number of total resources in the requested scope.
/// </summary>
public long? Total { get; set; }
}
/// <summary>
/// <para>List of resources.</para>
/// <para>Contains a token to get the next page.</para>
/// </summary>
/// <typeparam name="T">Resource type.</typeparam>
#pragma warning disable CA1711 // Keep 'Collection' name
public class EInvoicingCollection<T> : PaginatedCollection<T>
#pragma warning restore CA1711
{
/// <summary>
/// Start position of the results by giving the page index.
/// </summary>
public long? Number { get; set; }
/// <summary>
/// Number (1-2000) of document resources returned.
/// </summary>
public int? Size { get; set; }
/// <summary>
/// Number of total resources in the requested scope.
/// </summary>
public long? Total { get; set; }
}
/// <summary>
/// <para>List of resources.</para>
/// <para>Contains a token to get the next page.</para>
/// </summary>
/// <typeparam name="T">Resource type.</typeparam>
#pragma warning disable CA1711 // Keep 'Collection' name
public class PageBasedXS2ACollection<T> : PaginatedCollection<T>
#pragma warning restore CA1711
{
/// <summary>
/// Start position of the results by giving the page index.
/// </summary>
public long? Number { get; set; }
/// <summary>
/// Number (1-2000) of document resources returned.
/// </summary>
public int? Size { get; set; }
/// <summary>
/// Number of total pages in the requested scope.
/// </summary>
public long? TotalPages { get; set; }
/// <summary>
/// Number of total resources in the requested scope.
/// </summary>
public long? TotalEntries { get; set; }
/// <summary>
/// Link to the first page.
/// </summary>
public string FirstLink { get; set; }
/// <summary>
/// Link to the previous page.
/// </summary>
public string PreviousLink { get; set; }
/// <summary>
/// Link to the next page.
/// </summary>
public string NextLink { get; set; }
/// <summary>
/// Link to the next page.
/// </summary>
public string LastLink { get; set; }
}
/// <summary>
/// Token allowing to fetch the next page of a <see cref="IbanityCollection<T>" /> or a <see cref="IsabelCollection<T>" />.
/// </summary>
public class ContinuationToken
{
internal ContinuationToken() { }
internal string NextUrl { get; set; }
internal long? PageOffset { get; set; }
internal int? PageSize { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client | raw_data\ibanity-dotnet\src\Client\Utils\Serializer.cs | using System;
using Newtonsoft.Json;
namespace Ibanity.Apis.Client.Utils
{
/// <summary>
/// Convert an object to and from a JSON string.
/// </summary>
public class JsonSerializer : ISerializer<string>
{
/// <summary>
/// Convert an object to a JSON string.
/// </summary>
/// <typeparam name="T">Object type</typeparam>
/// <param name="value">Object to transform</param>
/// <returns>The JSON representation of the argument</returns>
public string Serialize<T>(T value) =>
JsonConvert.SerializeObject(value);
/// <summary>
/// Create an object from a JSON string.
/// </summary>
/// <typeparam name="T">Object type</typeparam>
/// <param name="value">JSON of an object</param>
/// <returns>An instance matching the JSON value</returns>
public T Deserialize<T>(string value) =>
JsonConvert.DeserializeObject<T>(value ?? throw new ArgumentNullException(nameof(value)));
/// <summary>
/// Create an object from a JSON string.
/// </summary>
/// <param name="value">JSON of an object</param>
/// <param name="type">Object type</param>
/// <returns>An instance matching the JSON value</returns>
public object Deserialize(string value, Type type) =>
JsonConvert.DeserializeObject(
value ?? throw new ArgumentNullException(nameof(value)),
type ?? throw new ArgumentNullException(nameof(type)));
}
/// <summary>
/// Convert an object to and from a transferable format.
/// </summary>
/// <typeparam name="TTransfer">Transferable format type</typeparam>
public interface ISerializer<TTransfer>
{
/// <summary>
/// Convert an object to a transferable format.
/// </summary>
/// <typeparam name="T">Object type</typeparam>
/// <param name="value">Object to transform</param>
/// <returns>Object in transferable format</returns>
TTransfer Serialize<T>(T value);
/// <summary>
/// Create an object from a transferable format.
/// </summary>
/// <typeparam name="T">Object type</typeparam>
/// <param name="value">Transferable representation of an object</param>
/// <returns>Deserialized object</returns>
T Deserialize<T>(TTransfer value);
/// <summary>
/// Create an object from a transferable format.
/// </summary>
/// <param name="value">Transferable representation of an object</param>
/// <param name="type">Object type</param>
/// <returns>Deserialized object</returns>
object Deserialize(TTransfer value, Type type);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Utils | raw_data\ibanity-dotnet\src\Client\Utils\Logging\ILogger.cs | using System;
namespace Ibanity.Apis.Client.Utils.Logging
{
/// <summary>
/// Logging interface.
/// </summary>
/// <remarks>To be implemented by the application using the library.</remarks>
public interface ILogger
{
/// <summary>
/// Is TRACE level enabled?
/// </summary>
bool TraceEnabled { get; }
/// <summary>
/// Write TRACE message.
/// </summary>
/// <param name="message">Message to write</param>
void Trace(string message);
/// <summary>
/// Is DEBUG level enabled?
/// </summary>
bool DebugEnabled { get; }
/// <summary>
/// Write DEBUG message.
/// </summary>
/// <param name="message">Message to write</param>
void Debug(string message);
/// <summary>
/// Is INFO level enabled?
/// </summary>
bool InfoEnabled { get; }
/// <summary>
/// Write INFO message.
/// </summary>
/// <param name="message">Message to write</param>
void Info(string message);
/// <summary>
/// Is WARN level enabled?
/// </summary>
bool WarnEnabled { get; }
/// <summary>
/// Write WARN message.
/// </summary>
/// <param name="message">Message to write</param>
void Warn(string message);
/// <summary>
/// Write WARN message.
/// </summary>
/// <param name="message">Message to write</param>
/// <param name="exception">Exception that occurred</param>
void Warn(string message, Exception exception);
/// <summary>
/// Is ERROR level enabled?
/// </summary>
bool ErrorEnabled { get; }
/// <summary>
/// Write ERROR message.
/// </summary>
/// <param name="message">Message to write</param>
void Error(string message);
/// <summary>
/// Write ERROR message.
/// </summary>
/// <param name="message">Message to write</param>
/// <param name="exception">Exception that occurred</param>
void Error(string message, Exception exception);
/// <summary>
/// Is FATAL level enabled?
/// </summary>
bool FatalEnabled { get; }
/// <summary>
/// Write FATAL message.
/// </summary>
/// <param name="message">Message to write</param>
void Fatal(string message);
/// <summary>
/// Write FATAL message.
/// </summary>
/// <param name="message">Message to write</param>
/// <param name="exception">Exception that occurred</param>
void Fatal(string message, Exception exception);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Utils | raw_data\ibanity-dotnet\src\Client\Utils\Logging\ILoggerFactory.cs | namespace Ibanity.Apis.Client.Utils.Logging
{
/// <summary>
/// Create an new logger instance.
/// </summary>
public interface ILoggerFactory
{
/// <summary>
/// Create an new logger instance.
/// </summary>
/// <typeparam name="T">Type used as logger name</typeparam>
/// <returns>A ready to use logger instance</returns>
ILogger CreateLogger<T>();
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Utils | raw_data\ibanity-dotnet\src\Client\Utils\Logging\LoggerFactoryNotNullDecorator.cs | using System;
namespace Ibanity.Apis.Client.Utils.Logging
{
/// <inheritdoc />
/// <remarks>Ensure the underlying logger factory doesn't return a <c>null</c> logger.</remarks>
public class LoggerFactoryNotNullDecorator : ILoggerFactory
{
private readonly ILoggerFactory _underlyingInstance;
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="underlyingInstance">Actual logger factory</param>
public LoggerFactoryNotNullDecorator(ILoggerFactory underlyingInstance) =>
_underlyingInstance = underlyingInstance ?? throw new ArgumentNullException(nameof(underlyingInstance));
/// <inheritdoc />
public ILogger CreateLogger<T>()
{
var logger = _underlyingInstance.CreateLogger<T>();
if (logger == null)
throw new IbanityConfigurationException("Logger factory returns a null logger");
return logger;
}
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Utils | raw_data\ibanity-dotnet\src\Client\Utils\Logging\NullLogger.cs | using System;
namespace Ibanity.Apis.Client.Utils.Logging
{
/// <summary>
/// This logger does nothing.
/// </summary>
/// <remarks>Used as a stub when there isn't any logger configured.</remarks>
public class NullLogger : ILogger
{
/// <summary>
/// Singleton instance.
/// </summary>
public static readonly ILogger Instance = new NullLogger();
private NullLogger() { }
/// <inheritdoc />
/// <remarks>Always false.</remarks>
public bool TraceEnabled => false;
/// <inheritdoc />
/// <remarks>Does nothing.</remarks>
public void Trace(string message) { }
/// <inheritdoc />
/// <remarks>Always false.</remarks>
public bool DebugEnabled => false;
/// <inheritdoc />
/// <remarks>Does nothing.</remarks>
public void Debug(string message) { }
/// <inheritdoc />
/// <remarks>Always false.</remarks>
public bool InfoEnabled => false;
/// <inheritdoc />
/// <remarks>Does nothing.</remarks>
public void Info(string message) { }
/// <inheritdoc />
/// <remarks>Always false.</remarks>
public bool WarnEnabled => false;
/// <inheritdoc />
/// <remarks>Does nothing.</remarks>
public void Warn(string message) { }
/// <inheritdoc />
/// <remarks>Does nothing.</remarks>
public void Warn(string message, Exception exception) { }
/// <inheritdoc />
/// <remarks>Always false.</remarks>
public bool ErrorEnabled => false;
/// <inheritdoc />
/// <remarks>Does nothing.</remarks>
public void Error(string message) { }
/// <inheritdoc />
/// <remarks>Does nothing.</remarks>
public void Error(string message, Exception exception) { }
/// <inheritdoc />
/// <remarks>Always false.</remarks>
public bool FatalEnabled => false;
/// <inheritdoc />
/// <remarks>Does nothing.</remarks>
public void Fatal(string message) { }
/// <inheritdoc />
/// <remarks>Does nothing.</remarks>
public void Fatal(string message, Exception exception) { }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Utils | raw_data\ibanity-dotnet\src\Client\Utils\Logging\SimpleLoggerFactory.cs | using System;
namespace Ibanity.Apis.Client.Utils.Logging
{
/// <inheritdoc />
/// <remarks>Always returns the same logger.</remarks>
public class SimpleLoggerFactory : ILoggerFactory
{
private readonly ILogger _logger;
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="logger">Logger to be returned</param>
public SimpleLoggerFactory(ILogger logger) =>
_logger = logger ?? throw new ArgumentNullException(nameof(logger));
/// <inheritdoc />
public ILogger CreateLogger<T>() => _logger;
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client | raw_data\ibanity-dotnet\src\Client\Webhooks\InvalidSignatureException.cs | namespace Ibanity.Apis.Client.Webhooks
{
/// <summary>
/// Invalid webhook signature.
/// </summary>
public class InvalidSignatureException : IbanityException
{
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="message">Error description</param>
public InvalidSignatureException(string message) :
base("Invalid signature: " + message)
{
}
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client | raw_data\ibanity-dotnet\src\Client\Webhooks\WebhooksService.cs | using System;
using System.Collections.Generic;
using System.Linq;
using System.Security.Cryptography;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Utils;
using Ibanity.Apis.Client.Webhooks.Jwt;
using Ibanity.Apis.Client.Webhooks.Models;
namespace Ibanity.Apis.Client.Webhooks
{
/// <inheritdoc />
public class WebhooksService : IWebhooksService
{
private static readonly IReadOnlyDictionary<string, Type> Types = new Dictionary<string, Type>
{
{ "pontoConnect.synchronization.succeededWithoutChange", typeof(Payload<Models.PontoConnect.NestedSynchronizationSucceededWithoutChange>) },
{ "pontoConnect.synchronization.failed", typeof(Payload<Models.PontoConnect.NestedSynchronizationFailed>) },
{ "pontoConnect.account.detailsUpdated", typeof(Payload<Models.PontoConnect.NestedAccountDetailsUpdated>) },
{ "pontoConnect.account.reauthorized", typeof(Payload<Models.PontoConnect.NestedAccountReauthorized>) },
{ "pontoConnect.account.transactionsCreated", typeof(Payload<Models.PontoConnect.NestedAccountTransactionsCreated>) },
{ "pontoConnect.account.transactionsUpdated", typeof(Payload<Models.PontoConnect.NestedAccountTransactionsUpdated>) },
{ "pontoConnect.integration.created", typeof(Payload<Models.PontoConnect.NestedIntegrationCreated>) },
{ "pontoConnect.integration.revoked", typeof(Payload<Models.PontoConnect.NestedIntegrationRevoked>) },
{ "pontoConnect.integration.accountAdded", typeof(Payload<Models.PontoConnect.NestedIntegrationAccountAdded>) },
{ "pontoConnect.integration.accountRevoked", typeof(Payload<Models.PontoConnect.NestedIntegrationAccountRevoked>) },
{ "pontoConnect.organization.blocked", typeof(Payload<Models.PontoConnect.NestedOrganizationBlocked>) },
{ "pontoConnect.organization.unblocked", typeof(Payload<Models.PontoConnect.NestedOrganizationUnblocked>) },
{ "xs2a.synchronization.succeededWithoutChange", typeof(Payload<Models.XS2A.NestedSynchronizationSucceededWithoutChange>) },
{ "xs2a.synchronization.failed", typeof(Payload<Models.XS2A.NestedSynchronizationFailed>) },
{ "xs2a.account.detailsUpdated", typeof(Payload<Models.XS2A.NestedAccountDetailsUpdated>) },
{ "xs2a.account.transactionsCreated", typeof(Payload<Models.XS2A.NestedAccountTransactionsCreated>) },
{ "xs2a.account.transactionsUpdated", typeof(Payload<Models.XS2A.NestedAccountTransactionsUpdated>) },
{ "xs2a.account.transactionsDeleted", typeof(Payload<Models.XS2A.NestedAccountTransactionsDeleted>) },
{ "xs2a.bulkPaymentInitiationRequest.authorizationCompleted", typeof(Payload<Models.XS2A.NestedBulkPaymentInitiationRequestAuthorizationCompleted>) },
{ "xs2a.bulkPaymentInitiationRequest.statusUpdate", typeof(Payload<Models.XS2A.NestedBulkPaymentInitiationRequestStatusUpdated>) },
{ "xs2a.paymentInitiationRequest.authorizationCompleted", typeof(Payload<Models.XS2A.NestedPaymentInitiationRequestAuthorizationCompleted>) },
{ "xs2a.paymentInitiationRequest.statusUpdate", typeof(Payload<Models.XS2A.NestedPaymentInitiationRequestStatusUpdated>) },
{ "xs2a.periodicPaymentInitiationRequest.authorizationCompleted", typeof(Payload<Models.XS2A.NestedPeriodicPaymentInitiationRequestAuthorizationCompleted>) },
{ "xs2a.periodicPaymentInitiationRequest.statusUpdate", typeof(Payload<Models.XS2A.NestedPeriodicPaymentInitiationRequestStatusUpdated>) }
};
private readonly ISerializer<string> _serializer;
private readonly IVerifier _jwtVerifier;
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="serializer">To-string serializer</param>
/// <param name="jwksService">Get public keys from authorization server</param>
/// <param name="jwtVerifier">JSON Web Token verifier</param>
public WebhooksService(ISerializer<string> serializer, IJwksService jwksService, IVerifier jwtVerifier)
{
_serializer = serializer ?? throw new ArgumentNullException(nameof(serializer));
JwksService = jwksService ?? throw new ArgumentNullException(nameof(jwksService));
_jwtVerifier = jwtVerifier ?? throw new ArgumentNullException(nameof(jwtVerifier));
}
/// <inheritdoc />
public IJwksService JwksService { get; }
/// <summary>
/// Get event type.
/// </summary>
/// <param name="payload">Webhook payload</param>
/// <returns></returns>
public string GetPayloadType(string payload) =>
_serializer.Deserialize<Payload<PayloadData>>(payload)?.Data?.Type;
/// <inheritdoc />
public async Task<IWebhookEvent> VerifyAndDeserialize(string payload, string signature, CancellationToken? cancellationToken)
{
await EnsureSignatureAndDigestAreValid(payload, signature, cancellationToken).ConfigureAwait(false);
var payloadType = GetPayloadType(payload) ?? throw new IbanityException("Can't get event type");
if (!Types.TryGetValue(payloadType, out var type))
throw new IbanityException("Can't find event type: " + payloadType);
var deserializedPayload = (Payload)_serializer.Deserialize(payload, type);
return deserializedPayload.UntypedData.Flatten();
}
private async Task EnsureSignatureAndDigestAreValid(string payload, string signature, CancellationToken? cancellationToken)
{
var digest = await VerifyAndGetDigest(signature, cancellationToken).ConfigureAwait(false);
byte[] computedDigest;
using (var algorithm = new SHA512Managed())
computedDigest = algorithm.ComputeHash(Encoding.UTF8.GetBytes(payload));
var digestBytes = Convert.FromBase64String(digest);
if (!digestBytes.SequenceEqual(computedDigest))
throw new InvalidSignatureException("Digest mismatch");
}
private async Task<string> VerifyAndGetDigest(string signature, CancellationToken? cancellationToken)
{
var token = await _jwtVerifier.Verify(signature, cancellationToken).ConfigureAwait(false);
return token.Payload.Digest;
}
}
/// <summary>
/// Allows to verify and deserialize webhook payloads.
/// </summary>
public interface IWebhooksService
{
/// <summary>
/// Verify JWT signature and deserialize payload.
/// </summary>
/// <param name="payload">Webhook payload</param>
/// <param name="signature">Signature header content (JWT token)</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
/// <returns>The event payload</returns>
Task<IWebhookEvent> VerifyAndDeserialize(string payload, string signature, CancellationToken? cancellationToken = null);
/// <summary>
/// Get public key from JSON Web Key Set endpoint.
/// </summary>
IJwksService JwksService { get; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Webhooks | raw_data\ibanity-dotnet\src\Client\Webhooks\Jwt\JwksPayload.cs | using System.Runtime.Serialization;
namespace Ibanity.Apis.Client.Webhooks.Jwt
{
/// <summary>
/// A set of JWKs.
/// </summary>
[DataContract]
public class JsonWebKeySet
{
/// <summary>
/// An array of JWKs.
/// </summary>
[DataMember(Name = "keys", EmitDefaultValue = false)]
public JsonWebKey[] Keys { get; set; }
}
/// <summary>
/// A cryptographic key. The members of the object represent properties of the key, including its value.
/// </summary>
[DataContract]
public class JsonWebKey
{
/// <summary>
/// The specific cryptographic algorithm used with the key.
/// </summary>
[DataMember(Name = "alg", EmitDefaultValue = false)]
public string Algorithm { get; set; }
/// <summary>
/// The family of cryptographic algorithms used with the key.
/// </summary>
[DataMember(Name = "kty", EmitDefaultValue = false)]
public string AlgorithmFamily { get; set; }
/// <summary>
/// How the key was meant to be used; <c>sig</c> represents the signature.
/// </summary>
[DataMember(Name = "use", EmitDefaultValue = false)]
public string Usage { get; set; }
/// <summary>
/// The x.509 certificate chain.
/// </summary>
/// <remarks>The first entry in the array is the certificate to use for token verification; the other certificates can be used to verify this first certificate.</remarks>
[DataMember(Name = "x5c", EmitDefaultValue = false)]
public string CertificateChain { get; set; }
/// <summary>
/// The modulus for the RSA public key.
/// </summary>
[DataMember(Name = "n", EmitDefaultValue = false)]
public string Modulus { get; set; }
/// <summary>
/// The exponent for the RSA public key.
/// </summary>
[DataMember(Name = "e", EmitDefaultValue = false)]
public string Exponent { get; set; }
/// <summary>
/// The unique identifier for the key.
/// </summary>
[DataMember(Name = "kid", EmitDefaultValue = false)]
public string Id { get; set; }
/// <summary>
/// The thumbprint of the x.509 cert (SHA-1 thumbprint).
/// </summary>
[DataMember(Name = "x5t", EmitDefaultValue = false)]
public string Thumbprint { get; set; }
/// <summary>
/// Is this <see cref="JsonWebKey" /> active?
/// </summary>
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Webhooks | raw_data\ibanity-dotnet\src\Client\Webhooks\Jwt\JwksService.cs | using System;
using System.Linq;
using System.Security.Cryptography;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Http;
namespace Ibanity.Apis.Client.Webhooks.Jwt
{
/// <inheritdoc />
public class JwksService : IJwksService
{
private readonly IApiClient _apiClient;
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="apiClient">Generic API client</param>
public JwksService(IApiClient apiClient) =>
_apiClient = apiClient ?? throw new ArgumentNullException(nameof(apiClient));
/// <inheritdoc />
public async Task<RSA> GetPublicKey(string keyId, CancellationToken? cancellationToken)
{
var response = await _apiClient.Get<JsonWebKeySet>("webhooks/keys", null, cancellationToken ?? CancellationToken.None).ConfigureAwait(false);
var keys = response.Keys.
Where(k =>
k.Usage == "sig" &&
k.Status == "ACTIVE" &&
k.Id == keyId).
ToArray();
if (keys.Length != 1)
{
if (response.Keys.Any())
throw new InvalidOperationException($"Can't find {keyId} active signature key. Got: {string.Join(" - ", response.Keys.Select(k => $"{k.Id ?? "no ID"} ({k.Usage ?? "no usage"} - {k.Status ?? "no status"})"))}");
else
throw new InvalidOperationException($"Can't find {keyId} active signature key. No key received");
}
var jwk = keys.Single();
var key = RSA.Create();
key.ImportParameters(new RSAParameters
{
Modulus = GetBytes(jwk.Modulus),
Exponent = GetBytes(jwk.Exponent)
});
return key;
}
private static byte[] GetBytes(string base64) =>
Convert.FromBase64String(base64.Replace('-', '+').Replace('_', '/'));
}
/// <summary>
/// Get public key from JSON Web Key Set endpoint.
/// </summary>
public interface IJwksService
{
/// <summary>
/// Get public keys from authorization server.
/// </summary>
/// <returns>RSA keys collection</returns>
Task<RSA> GetPublicKey(string keyId, CancellationToken? cancellationToken = null);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Webhooks | raw_data\ibanity-dotnet\src\Client\Webhooks\Jwt\JwksServiceCachingDecorator.cs | using System;
using System.Collections.Concurrent;
using System.Linq;
using System.Security.Cryptography;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Utils;
namespace Ibanity.Apis.Client.Webhooks.Jwt
{
/// <summary>
/// Wrapper around the actual service, caching results for some time.
/// </summary>
public class JwksServiceCachingDecorator : IJwksService
{
private readonly ConcurrentDictionary<string, CacheEntry> _cache = new ConcurrentDictionary<string, CacheEntry>();
private struct CacheEntry
{
public DateTimeOffset InsertedAt { get; set; }
public RSA Value { get; set; }
}
private readonly IJwksService _underlyingInstance;
private readonly IClock _clock;
private readonly TimeSpan _ttl;
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="underlyingInstance">Actual service</param>
/// <param name="clock">Returns current date and time</param>
/// <param name="ttl">Time to live</param>
public JwksServiceCachingDecorator(IJwksService underlyingInstance, IClock clock, TimeSpan ttl)
{
_underlyingInstance = underlyingInstance ?? throw new ArgumentNullException(nameof(underlyingInstance));
_clock = clock ?? throw new ArgumentNullException(nameof(clock));
_ttl = ttl;
}
/// <inheritdoc />
public async Task<RSA> GetPublicKey(string keyId, CancellationToken? cancellationToken = null)
{
var threshold = _clock.Now - _ttl;
var toRemove = _cache.
Where(kvp => kvp.Value.InsertedAt < threshold).
Select(kvp => kvp.Key).
ToArray();
foreach (var id in toRemove)
_cache.TryRemove(id, out _);
if (_cache.TryGetValue(keyId, out var entry))
return entry.Value;
entry = new CacheEntry
{
InsertedAt = _clock.Now,
Value = await _underlyingInstance.GetPublicKey(keyId, cancellationToken).ConfigureAwait(false)
};
_cache[keyId] = entry;
return entry.Value;
}
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Webhooks | raw_data\ibanity-dotnet\src\Client\Webhooks\Jwt\Parser.cs | using System;
using System.Text;
using Ibanity.Apis.Client.Utils;
using Ibanity.Apis.Client.Webhooks.Jwt.Models;
namespace Ibanity.Apis.Client.Webhooks.Jwt
{
/// <inheritdoc />
public class Parser : IParser
{
private readonly ISerializer<string> _serializer;
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="serializer">To-string serializer</param>
public Parser(ISerializer<string> serializer) =>
_serializer = serializer ?? throw new ArgumentNullException(nameof(serializer));
/// <inheritdoc />
public Header GetHeader(string token)
{
var (header, _, _) = GetParts(token);
return _serializer.Deserialize<Header>(GetStringFromBase64(header));
}
/// <inheritdoc />
public T GetPayload<T>(string token) where T : Payload
{
var (_, payload, _) = GetParts(token);
return _serializer.Deserialize<T>(GetStringFromBase64(payload));
}
/// <inheritdoc />
public byte[] GetSignature(string token)
{
var (_, _, signature) = GetParts(token);
return GetBytesFromBase64(signature);
}
/// <inheritdoc />
public string RemoveSignature(string token)
{
var (header, payload, _) = GetParts(token);
return $"{header}.{payload}";
}
private static (string, string, string) GetParts(string token)
{
if (string.IsNullOrWhiteSpace(token))
throw new ArgumentException($"'{nameof(token)}' cannot be null or whitespace.", nameof(token));
var parts = token.Split(new[] { '.' }, StringSplitOptions.RemoveEmptyEntries);
if (parts.Length != 3)
throw new InvalidSignatureException("Expected 3 parts in token but got " + parts.Length);
return (parts[0], parts[1], parts[2]);
}
private static string GetStringFromBase64(string base64)
{
if (string.IsNullOrWhiteSpace(base64))
throw new ArgumentException($"'{nameof(base64)}' cannot be null or whitespace.", nameof(base64));
return Encoding.UTF8.GetString(GetBytesFromBase64(base64));
}
private static byte[] GetBytesFromBase64(string base64) =>
Convert.FromBase64String(
(base64.Length % 4 == 0 ? base64 : base64 + "====".Substring(base64.Length % 4)).Replace('-', '+').Replace('_', '/'));
}
/// <summary>
/// Parse Json Web Tokens.
/// </summary>
public interface IParser
{
/// <summary>
/// Extract header part.
/// </summary>
/// <param name="token">Json Web Token</param>
/// <returns>Header object</returns>
Header GetHeader(string token);
/// <summary>
/// Extract payload part.
/// </summary>
/// <typeparam name="T">Payload type</typeparam>
/// <param name="token">Json Web Token</param>
/// <returns>Payload object</returns>
T GetPayload<T>(string token) where T : Payload;
/// <summary>
/// Extract signature part.
/// </summary>
/// <param name="token">Json Web Token</param>
/// <returns>Signature bytes</returns>
byte[] GetSignature(string token);
/// <summary>
/// Extract header and payload parts.
/// </summary>
/// <param name="token">Json Web Token</param>
/// <returns>Token without the signature part</returns>
string RemoveSignature(string token);
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Webhooks | raw_data\ibanity-dotnet\src\Client\Webhooks\Jwt\Verifier.cs | using System;
using System.Security.Cryptography;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Ibanity.Apis.Client.Utils;
using Ibanity.Apis.Client.Webhooks.Jwt.Models;
namespace Ibanity.Apis.Client.Webhooks.Jwt
{
/// <inheritdoc />
public class Rs512Verifier : IVerifier
{
private readonly IParser _parser;
private readonly IJwksService _jwksService;
private readonly IClock _clock;
private readonly TimeSpan _allowedClockSkew;
/// <summary>
/// Build a new instance.
/// </summary>
/// <param name="parser">JWT parser</param>
/// <param name="jwksService">JWKS client</param>
/// <param name="clock">Returns current date and time</param>
/// <param name="allowedClockSkew">Leniency in date comparisons</param>
public Rs512Verifier(IParser parser, IJwksService jwksService, IClock clock, TimeSpan allowedClockSkew)
{
_parser = parser ?? throw new ArgumentNullException(nameof(parser));
_jwksService = jwksService ?? throw new ArgumentNullException(nameof(jwksService));
_clock = clock ?? throw new ArgumentNullException(nameof(clock));
_allowedClockSkew = allowedClockSkew;
}
/// <inheritdoc />
public async Task<Token> Verify(string token, CancellationToken? cancellationToken)
{
var header = _parser.GetHeader(token);
if (header.Algorithm != "RS512")
throw new InvalidSignatureException("Only RS512 algorithm is supported but got " + header.Algorithm);
var publicKey = await _jwksService.GetPublicKey(header.KeyId, cancellationToken).ConfigureAwait(false);
byte[] hash;
using (var sha512 = SHA512.Create())
hash = sha512.ComputeHash(Encoding.UTF8.GetBytes(_parser.RemoveSignature(token)));
var rsaDeformatter = new RSAPKCS1SignatureDeformatter(publicKey);
rsaDeformatter.SetHashAlgorithm("SHA512");
if (!rsaDeformatter.VerifySignature(hash, _parser.GetSignature(token)))
throw new InvalidSignatureException("Can't verify signature");
var payload = _parser.GetPayload<IbanityPayload>(token);
EnsureClaimsAreValid(payload);
return new Token
{
Header = header,
Payload = payload
};
}
private void EnsureClaimsAreValid(IbanityPayload payload)
{
var now = _clock.Now;
var notAfter = now + _allowedClockSkew;
if (payload.IssuedAt > notAfter)
throw new InvalidSignatureException($"Token issued in the future ({payload.IssuedAt:O} is after {notAfter:O})");
var notBefore = now - _allowedClockSkew;
if (payload.Expiration < notBefore)
throw new InvalidSignatureException($"Expired token ({payload.Expiration:O} is before {notBefore:O})");
}
}
/// <summary>
/// Verify if JWT token is valid.
/// </summary>
public interface IVerifier
{
/// <summary>
/// Verify if JWT token is valid.
/// </summary>
/// <param name="token">JWT token</param>
/// <param name="cancellationToken">Allow to cancel a long-running task</param>
Task<Token> Verify(string token, CancellationToken? cancellationToken);
}
/// <summary>
/// Parsed JWT token.
/// </summary>
public class Token
{
/// <summary>
/// Token header.
/// </summary>
public Header Header { get; set; }
/// <summary>
/// Token payload.
/// </summary>
public IbanityPayload Payload { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Webhooks\Jwt | raw_data\ibanity-dotnet\src\Client\Webhooks\Jwt\Models\Header.cs | using System.Runtime.Serialization;
namespace Ibanity.Apis.Client.Webhooks.Jwt.Models
{
/// <summary>
/// Token header.
/// </summary>
[DataContract]
public class Header
{
/// <summary>
/// Signature algorithm.
/// </summary>
[DataMember(Name = "alg", EmitDefaultValue = false)]
public string Algorithm { get; set; }
/// <summary>
/// Key ID.
/// </summary>
[DataMember(Name = "kid", EmitDefaultValue = false)]
public string KeyId { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Webhooks\Jwt | raw_data\ibanity-dotnet\src\Client\Webhooks\Jwt\Models\IbanityPayload.cs | using System.Runtime.Serialization;
namespace Ibanity.Apis.Client.Webhooks.Jwt.Models
{
/// <inheritdoc />
[DataContract]
public class IbanityPayload : Payload
{
/// <summary>
/// Message digest.
/// </summary>
[DataMember(Name = "digest", EmitDefaultValue = false)]
public string Digest { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Webhooks\Jwt | raw_data\ibanity-dotnet\src\Client\Webhooks\Jwt\Models\Payload.cs | using System;
using System.Runtime.Serialization;
namespace Ibanity.Apis.Client.Webhooks.Jwt.Models
{
/// <summary>
/// Token payload.
/// </summary>
[DataContract]
public class Payload
{
/// <summary>
/// Expiration time (seconds since Unix epoch).
/// </summary>
[DataMember(Name = "exp", EmitDefaultValue = false)]
public long ExpirationEpoch { get; set; }
/// <summary>
/// Expiration time.
/// </summary>
public DateTimeOffset Expiration => DateTimeOffset.FromUnixTimeSeconds(ExpirationEpoch);
/// <summary>
/// Issued at (seconds since Unix epoch).
/// </summary>
[DataMember(Name = "iat", EmitDefaultValue = false)]
public long IssuedAtEpoch { get; set; }
/// <summary>
/// Issued at.
/// </summary>
public DateTimeOffset IssuedAt => DateTimeOffset.FromUnixTimeSeconds(IssuedAtEpoch);
/// <summary>
/// Who created and signed this token.
/// </summary>
[DataMember(Name = "iss", EmitDefaultValue = false)]
public string Issuer { get; set; }
/// <summary>
/// JWT ID (unique identifier for this token).
/// </summary>
[DataMember(Name = "jti", EmitDefaultValue = false)]
public string Id { get; set; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Webhooks | raw_data\ibanity-dotnet\src\Client\Webhooks\Models\IWebhookEvent.cs | namespace Ibanity.Apis.Client.Webhooks.Models
{
/// <summary>
/// Webhook event payload.
/// </summary>
public interface IWebhookEvent
{
/// <summary>
/// Event type.
/// </summary>
string Type { get; }
/// <summary>
/// Event ID.
/// </summary>
string Id { get; }
}
}
| 0 |
raw_data\ibanity-dotnet\src\Client\Webhooks | raw_data\ibanity-dotnet\src\Client\Webhooks\Models\Payload.cs | using System;
using System.Runtime.Serialization;
namespace Ibanity.Apis.Client.Webhooks.Models
{
/// <summary>
/// Webhooks body.
/// </summary>
[DataContract]
public abstract class Payload
{
internal abstract PayloadData UntypedData { get; }
}
/// <summary>
/// Webhooks body.
/// </summary>
/// <typeparam name="T">Payload data type</typeparam>
[DataContract]
public class Payload<T> : Payload where T : PayloadData
{
/// <summary>
/// Actual item.
/// </summary>
[DataMember(Name = "data", EmitDefaultValue = false)]
public T Data { get; set; }
internal override PayloadData UntypedData => Data;
}
/// <summary>
/// Actual payload without attributes and relationships.
/// </summary>
[DataContract]
public class PayloadData : JsonApi.Data
{
/// <summary>
/// Move nested object values at top level.
/// </summary>
/// <returns>An object without nested properties</returns>
public virtual IWebhookEvent Flatten() { throw new NotImplementedException(); }
}
/// <summary>
/// Actual payload with attributes and relationships.
/// </summary>
/// <typeparam name="TAttributes">Resource attribute type</typeparam>
/// <typeparam name="TRelationships">Resource relationships type</typeparam>
[DataContract]
public abstract class PayloadData<TAttributes, TRelationships> : PayloadData
{
/// <summary>
/// Resource actual content.
/// </summary>
[DataMember(Name = "attributes", EmitDefaultValue = false)]
public TAttributes Attributes { get; set; }
/// <summary>
/// Resource relationships.
/// </summary>
[DataMember(Name = "relationships", EmitDefaultValue = false)]
public TRelationships Relationships { get; set; }
}
}
| 0 |