🏦Banking Details API

Save time for creating, verifying, and formatting international bank account information (IBAN, BIC/SWIFT, and BBAN) with our Banking Details API. Handle bank account details processes programmatically and obtain country-specific banking details standards.

You need to provide your API key for every API request you make. Please refer to the Getting Started section for more details.

You can check our Errors section to understand how we handle errors and the responses you will receive in cases when errors occur.

IBAN (International Bank Account Number)

Validate IBAN (/iban/validate)

Endpoint used for checking whether a provided IBAN (International Bank Account Number) has a valid value.

Request parameters

Example

GET /iban/validate?iban=BE68539007547034

RESPONSE:

{
  "iban": "BE68539007547034",
  "is_valid": true
}

Response structure

Every successful response will have the structure explained in the table below:

IBAN details (/iban/details)

Endpoint used for getting bank details (BBAN and country) from the IBAN.

Request parameters

Example

GET /iban/details?iban=FR1420041010050500013M02606

RESPONSE:

{
  "iban": "FR1420041010050500013M02606",
  "bban": "20041010050500013M02606",
  "country": "FR"
}

Response structure

Every successful response will have the structure explained in the table below:

Compose IBAN (/iban/compose)

Endpoint used for generating IBAN value from BBAN and country code.

Request parameters

Example

GET /iban/compose?country=NO&bban=86011117947

RESPONSE:

{
  "country": "NO",
  "bban": "86011117947",
  "iban": "NO9386011117947"
}

Response structure

Every successful response will have the structure explained in the table below:

Electronic IBAN format (/iban/format/electronic)

Endpoint used for converting IBAN values to the electronic format which is used for payment processing.

Request parameters

Example

GET /iban/format/electronic?iban=FR14-2004-1010-0505-0001-3M02-606

RESPONSE:

{
  "iban": "FR14-2004-1010-0505-0001-3M02-606",
  "iban_formatted": "FR1420041010050500013M02606"
}

Response structure

Every successful response will have the structure explained in the table below:

Friendly IBAN format (/iban/format/friendly)

Endpoint used for converting IBAN values to the user-friendly format which is usually used for displaying IBAN values in the UI.

Request parameters

Examples

GET /iban/format/friendly?iban=FR1420041010050500013M02606

RESPONSE:

{
  "iban": "FR1420041010050500013M02606",
  "separator": " ",
  "iban_formatted": "FR14 2004 1010 0505 0001 3M02 606"
}

Our API uses a single space as a default separator for the friendly IBAN format. However, you can specify your custom separator:

GET /iban/format/friendly?iban=FR1420041010050500013M02606&separator=-

RESPONSE:

{
  "iban": "FR1420041010050500013M02606",
  "separator": "-",
  "iban_formatted": "FR14-2004-1010-0505-0001-3M02-606"
}

Response structure

Every successful response will have the structure explained in the table below:

BIC (Business Identifier Code)

Validate BIC (/bic/validate)

Endpoint used for validating BIC values.

Request parameters

Example

GET /bic/validate?bic=AEBAGRAA

RESPONSE:

{
  "bic": "AEBAGRAA",
  "is_valid": true
}

Response structure

Every successful response will have the structure explained in the table below:

BIC details (/bic/details)

Endpoint used for getting bank details from BIC values.

Request parameters

Example

GET /bic/details?bic=XCYSCY2N

RESPONSE:

{
  "bic": "XCYSCY2N",
  "bank_code": "XCYS",
  "country": "CY",
  "location_code": "2N",
  "is_test_bic": false,
  "branch_code": "619"
}

Response structure

Every successful response will have the structure explained in the table below:

BBAN (Basic Bank Account Number)

Validate BBAN (/bban/validate)

Endpoint used for validating BBAN value for a specified country.

Request parameters

Example

GET /bban/validate?bban=21000418450200051332&country=ES

RESPONSE:

{
  "bban": "21000418450200051332",
  "country": "ES",
  "is_valid": true
}

Response structure

Every successful response will have the structure explained in the table below:

Country-specific banking data

Country banking details (/country/details)

Endpoint used for getting country-specific banking details.

Request parameters

Example

GET /country/details?country=DE

RESPONSE:
{
  "country": "DE",
  "is_sepa_country": true,
  "is_iban_used": true,
  "iban_length": 22,
  "bban_format": "^[0-9]{18}$"
}

Response structure

Every successful response will have the structure explained in the table below:

Is country in SEPA (/country/is_sepa)

Endpoint used for checking if the country is in the Single Euro Payments Area (SEPA).

Request parameters

Example

GET /country/is_sepa?country=BE

RESPONSE:
{
  "country": "BE",
  "is_sepa_country": true
}

Response structure

Every successful response will have the structure explained in the table below:

Last updated