Policy

Rate Limiting

The API imposes rate limits per minute. The various services have distinct limits.

Exceeding limits will result in an error being returned. You should incorporate appropriate error handling for the 429 error response code in your API connection. See our recommended approach in the errors section.

Depreciation

In our evolving technological landscape, we remain committed to enhancing our services for our clients. As part of this commitment, we continuously seek out advancements that allow us to deliver better experiences. However, progress often necessitates change, and occasionally, we must bid farewell to outdated code sections.

The Purpose of Deprecation

When a feature, design, or practice becomes obsolete, we label it as deprecated. This label serves as a signal to our developers and clients that an alternative solution is recommended. Deprecation occurs for various reasons:

Superseded Functionality: A feature may have been replaced by a more efficient or powerful counterpart.
Safety Concerns: Deprecated elements might pose security risks or no longer align with best practices.
Efficiency: We strive to streamline our systems, and deprecated components hinder this goal.

Our Approach

Rather than abruptly removing deprecated features, we follow a thoughtful process:

Marking as Deprecated: When we identify a feature for deprecation, we clearly label it as such. This provides transparency and allows clients to plan accordingly.
Backward Compatibility: We maintain backward compatibility during the deprecation period. Your existing projects can continue functioning without disruption.
Recommended Alternatives: In our API documentation, we highlight the recommended alternatives to deprecated features. We encourage you to adopt these alternatives promptly.

Data

In order to maintain the security and integrity of our bank account reporting API, we have implemented limits on how far back in time clients can request data. By imposing time constraints on data requests, we aim to ensure that users receive accurate and relevant account information within a reasonable timeframe, while also safeguarding against potential security vulnerabilities and data privacy concerns.

For our reporting API you can request transactions going back two years from the current date.

API Response Time

Response times across all endpoints and objects should be within 100ms. However, in busy times and for requests for large amounts of data this could be longer.

Logging and Audit Trails

The API service maintains detailed logs and audit trails of user activities, including changes to access. These logs help track user actions, monitor permissions, and ensure the integration team can help when there are any queries.

If you require any logging history to assist with your development, please let us know and we'll be happy to assist.

Pagination

Responses to some API queries are paginated. This means results are divided into smaller groups over several pages. This makes it possible for systems with limited processing capabilities to ingest larger data sets.

All endpoints with pagination return a page size of up to 250 records by default.

IsLastPage returns true if the current page is the last page of the report, and false if additional pages are to be rendered.