SDKs overview
IBANforge provides software development kits (SDKs) and client libraries designed to facilitate the integration of its financial validation services into various programming environments. These SDKs abstract the direct interaction with the IBANforge RESTful API, offering language-native methods for common operations such as International Bank Account Number (IBAN) validation, Bank Identifier Code (BIC) lookups, and broader bank account validation. The aim is to reduce integration complexity and accelerate development cycles by providing pre-built functionalities and handling API request/response parsing.
The SDKs are maintained by IBANforge itself, ensuring compatibility with the latest API versions and features. While the official SDKs cover widely used programming languages, community contributions may extend support to additional environments or provide specialized utilities. The core functionality across all SDKs focuses on ensuring the accuracy of financial transaction data, which is crucial for reducing payment errors and aiding in fraud prevention, aligning with common financial industry practices described by organizations like the International Organization for Standardization (ISO) for data exchange.
Developers can utilize these SDKs to implement real-time validation checks at the point of data entry, preventing incorrect IBANs or BICs from entering payment systems. This proactive approach supports compliance efforts, such as adherence to GDPR, by minimizing the processing of erroneous data and enhancing overall data quality within financial applications. The availability of a free tier allows developers to test integration and functionality before committing to a paid plan, offering 500 API requests per month for evaluation purposes.
Official SDKs by language
IBANforge offers official SDKs for several popular programming languages, each designed to provide a consistent and idiomatic interface to the IBANforge API. These SDKs are actively maintained to ensure they reflect the latest API features and best practices for secure and efficient data handling.
| Language | Package/Module Name | Installation Command (CLI) | Maturity |
|---|---|---|---|
| Python | ibanforge-python |
pip install ibanforge-python |
Stable |
| Node.js | @ibanforge/node |
npm install @ibanforge/node |
Stable |
| PHP | ibanforge/php-sdk |
composer require ibanforge/php-sdk |
Stable |
| Ruby | ibanforge-ruby |
gem install ibanforge-ruby |
Stable |
Installation
Installing an IBANforge SDK typically involves using the package manager specific to your chosen programming language. This process fetches the library and its dependencies, making it available for import into your project. Before installation, ensure you have the appropriate language runtime and package manager installed on your development environment.
Python SDK Installation
To install the Python SDK, use pip, the Python package installer:
pip install ibanforge-python
Node.js SDK Installation
For Node.js projects, use npm or yarn to add the IBANforge package:
npm install @ibanforge/node
# or
yarn add @ibanforge/node
PHP SDK Installation
PHP developers can install the SDK using Composer, the dependency manager for PHP:
composer require ibanforge/php-sdk
Ruby SDK Installation
To install the Ruby SDK, use Bundler or the gem command:
gem install ibanforge-ruby
After installation, you will need your IBANforge API key, which is typically configured as an environment variable or passed directly to the SDK client upon initialization. This key authenticates your requests to the IBANforge API.
Quickstart example
The following examples demonstrate how to perform a basic IBAN validation using the official SDKs. These snippets illustrate the typical workflow: initializing the client with your API key and calling a validation method.
Python Quickstart
This Python example validates an IBAN and prints the validation result.
import os
from ibanforge import Client
# Replace with your actual API key or set as environment variable
api_key = os.environ.get("IBANFORGE_API_KEY", "YOUR_IBANFORGE_API_KEY")
client = Client(api_key=api_key)
try:
iban_to_validate = "DE89370400440532013000"
validation_result = client.validate_iban(iban_to_validate)
print(f"IBAN: {iban_to_validate}")
print(f"Is Valid: {validation_result.is_valid}")
print(f"Bank Name: {validation_result.bank_data.name if validation_result.bank_data else 'N/A'}")
print(f"Country: {validation_result.country_code}")
except Exception as e:
print(f"An error occurred: {e}")
Node.js Quickstart
This Node.js example performs an IBAN validation using async/await and logs the outcome.
const IBANforge = require('@ibanforge/node');
// Replace with your actual API key or set as environment variable
const apiKey = process.env.IBANFORGE_API_KEY || 'YOUR_IBANFORGE_API_KEY';
const client = new IBANforge.Client(apiKey);
async function validateIban() {
try {
const ibanToValidate = 'DE89370400440532013000';
const validationResult = await client.validateIban(ibanToValidate);
console.log(`IBAN: ${ibanToValidate}`);
console.log(`Is Valid: ${validationResult.isValid}`);
console.log(`Bank Name: ${validationResult.bankData ? validationResult.bankData.name : 'N/A'}`);
console.log(`Country: ${validationResult.countryCode}`);
} catch (error) {
console.error(`An error occurred: ${error.message}`);
}
}
validateIban();
PHP Quickstart
The PHP quickstart validates an IBAN and retrieves bank details.
<?php
require 'vendor/autoload.php';
use IBANforge\Client;
// Replace with your actual API key or set as environment variable
$apiKey = getenv('IBANFORGE_API_KEY') ?: 'YOUR_IBANFORGE_API_KEY';
$client = new Client($apiKey);
try {
$ibanToValidate = 'DE89370400440532013000';
$validationResult = $client->validateIban($ibanToValidate);
echo "IBAN: " . $ibanToValidate . "\n";
echo "Is Valid: " . ($validationResult->isValid ? 'true' : 'false') . "\n";
echo "Bank Name: " . ($validationResult->bankData ? $validationResult->bankData->name : 'N/A') . "\n";
echo "Country: " . $validationResult->countryCode . "\n";
} catch (\Exception $e) {
echo "An error occurred: " . $e->getMessage() . "\n";
}
?>
Ruby Quickstart
This Ruby example demonstrates IBAN validation and error handling.
require 'ibanforge'
# Replace with your actual API key or set as environment variable
api_key = ENV['IBANFORGE_API_KEY'] || 'YOUR_IBANFORGE_API_KEY'
client = IBANforge::Client.new(api_key: api_key)
begin
iban_to_validate = 'DE89370400440532013000'
validation_result = client.validate_iban(iban_to_validate)
puts "IBAN: #{iban_to_validate}"
puts "Is Valid: #{validation_result.is_valid}"
puts "Bank Name: #{validation_result.bank_data&.name || 'N/A'}"
puts "Country: #{validation_result.country_code}"
rescue StandardError => e
puts "An error occurred: #{e.message}"
end
These examples can be adapted to perform other operations supported by the IBANforge API, such as BIC lookups or SEPA validation, by referring to the official IBANforge documentation.
Community libraries
In addition to the officially supported SDKs, the broader developer community may create and maintain client libraries or integrations for IBANforge. These community-driven projects can offer support for languages not covered by official SDKs, provide specialized functionalities, or integrate IBANforge services into specific frameworks or platforms. Community libraries often reflect diverse approaches and may sometimes offer experimental features or different architectural patterns.
While official SDKs are directly maintained by IBANforge, community libraries are typically open-source and their maintenance and support depend on their respective contributors. Developers considering using a community library should verify its active maintenance, documentation quality, and compatibility with the latest IBANforge API versions. Reviewing the project's repository (e.g., on GitHub) for recent commits, issue activity, and testing practices is recommended to assess its reliability and security. For instance, developers often look for community-maintained tools on platforms like GitHub to find extensions for various APIs, including those in the financial sector.
As of the current date, specific widely adopted community libraries for IBANforge were not identified. Developers seeking community support or contributions are encouraged to check the IBANforge community forums or relevant open-source repositories.