Sepa

This service provides methods related to the Single Euro Payments Area (SEPA).

Summary

Sepa	This service provides methods related to the Single Euro Payments Area (SEPA).
Service methods
sepaConvertBankAccountNumber	Convert a domestic bank account number to a valid IBAN number.
sepaValidateInternationalBankAccountNumberFormat	Validate format of an International Bank Account Number (IBAN)
sepaIbanDetails	Display Iban specifics
sepaMatchAccountHolder	Match an IBAN with bank account name.
Deprecated methods
sepaConvertBasicBankAccountNumber	Notice: this method is deprecated, use sepaConvertBankAccountNumber instead
Type definitions
SepaBankAccountData
SepaBankAccountIbanData
SepaIbanDetails	Provides details about IBAN.
BbanDetails	Each (SEPA) country adopting IBAN account numbers, defines national IBAN specific values.
SepaBankDetails	Details about bank of the account.
SepaInternationalBankAccountNumberFormatValidationReport	Details about IBAN account number
SepaMatchAccountHolderResult	Provides details about the IBAN account holder when found.
SepaMatchBankAccountDetails	Information about the bank account.
SepaMatchBankAccountHolder	Information about the account holder.
SepaMatchNameMatchingResult	Indicates the matching result of the provided input name and found account name.
Test data
Available Countries	The following countries are available within the Sepa service.

sepaConvertBankAccountNumber

Convert a domestic bank account number to a valid IBAN number. This method supports Dutch and German banks only.

Parameters

account_number	Bank Account Number. Domestic bank account number.
nbi	National Bank Identifier. Varies per country, see below for examples.
country_code	The ISO2 country code for the given BBAN number (default: NL)

nbi examples. This code varies per country

Germany: Bankleitzahl (up to 8 digits). Examples: 30060010, 30520037, 31040061
Netherlands: Dutch Bank Code (4 letters). Examples: ABNA, ASNB, INGB, KNAB, RABO, SNSB, TRIO, ZWLB

https://en.wikipedia.org- /wiki- /International_Bank_Account_Number

Returns

out	SepaBankAccountIbanData

sepaMatchAccountHolder

Match an IBAN with bank account name. Account name must be between 3 and 70 characters.

Parameters

iban	International Bank Account Number (IBAN)
name	name of the account holder (natural person or organization)

Returns

out	SepaMatchAccountHolderResult

sepaConvertBasicBankAccountNumber

Notice: this method is deprecated, use sepaConvertBankAccountNumber instead

Convert a local Basic Bank Account Number (BBAN) to its International Bank Account Number (IBAN) counterpart.

From the 1st of August 2014 the SEPA payment standards will become mandatory for payments within the SEPA area. All local BBAN need to be converted to IBAN to comply with these regulations.

Parameters

bban	Basic Bank Account Number (BBAN)
country_iso	The ISO2 or ISO3 country code for the given BBAN number (default: NL)

Returns

out	SepaBankAccountData

SepaIbanDetails

Provides details about IBAN. IBAN can be split into two parts:

1. international section. All IBAN numbers adhere to this. Country code and check digits
2. national section (BBAN). with all the domestic details available per country. Varies per country.

check_digits	IBAN validation check digits
country_code	IBAN country code
bban	full BBAN value
bban_details	BBAN details

BbanDetails

Each (SEPA) country adopting IBAN account numbers, defines national IBAN specific values. BbanDetails is a list all possible values.

bban_bank_id	(optional) field
bban_branch_id	(optional) field
bban_account	(optional) field
bban_account_prefix	(optional) field
bban_account_type	(optional) field
bban_checksum	(optional) field
bban_currency	(optional) field
bban_holder_kennitala	(optional) field
bban_owner_number	(optional) field
bban_sort_code	(optional) field
bban_zero	(optional) field

SepaMatchAccountHolderResult

Provides details about the IBAN account holder when found. Details on the bank account and the account holder are returned when an IBAN is found and the status is active. SepaMatchNameMatchingResult is provided only when the provided input name is a mismatch.

iban	The given IBAN
iban_found	True if there is a record on this IBAN.
bank_account_details	SepaMatchBankAccountDetails Details about the bank account, when found.
bank_account_holder	SepaMatchBankAccountHolder Details about the account holder, when found.
name_matching_result	SepaMatchNameMatchingResult Name matching information (Organisations only).

SepaMatchBankAccountDetails

Information about the bank account.

foreign

True when the account is not Dutch

country_code

Two letter country code from the IBAN. Format: ISO-3166-1 alpha-2

status

(optional) if the status is omitted it is either active or unknown. Other status:

INACTIVE

the account is not active at the moment

SepaMatchBankAccountHolder

Information about the account holder.

type

the type of account holder:

NP	Natural Person. Account holder is a person
ORG	Organisation. Account holder is an organisation
UNKNOWN	Unknown. No Account holder information is available

number_of_account_holders

Contains the number of account holders.

joint_account

true when there is more than 1 account holder.

municipality

The municipality of the residence of the account holder information, only set when account is an organisation.

SepaMatchNameMatchingResult

Indicates the matching result of the provided input name and found account name. 3 types of results can be returned. A name suggestion is provided in the case of MISTYPE. When the IBAN belongs to an organisation, and the match type is either MISTYPE or NOT_MATCHING the legal name will be provided

type

types:

MATCHING	the provided name matches 100%
NOT_MATCHING	the provided name is not matching
MISTYPE	the provided name is probably a mistype

name_suggestion

Available in case of matching type = MISTYPE.

Available Countries

The following countries are available within the Sepa service. (ISO2 Country name)

AD	Andorra
AE	United Arab Emirates
AL	Albania
AT	Austria
AZ	Azerbaijan
BA	Bosnia and Herzegovina
BE	Belgium
BG	Bulgaria
BH	Bahrain
BL	Saint Barthélemy (Fr)
BR	Brazil
BY	Belarus
CH	Switzerland
CR	Costa Rica
CY	Cyprus
CZ	Czechia
DE	Germany
DK	Denmark
DO	Dominican Republic
EE	Estonia
ES	Estland
FI	Finland
FO	Faroe Islands
FR	France
GB	United Kingdom of Great-Britain and Northern Ireland
GE	Georgia
GF	French Guinana
GI	Gibraltar
GL	Greenland
GP	Guadeloupe
GR	Greece
GT	Guatemala
HR	Croatia
HU	Hungary
IE	Ireland
IL	Israel
IS	Iceland
IT	Italy
JO	Jordan
KW	Kuwait
KZ	Kazakhstan
LB	Lebanon
LC	Saint Lucia (Fr)
LI	Lichenstein
LT	Lithuania
LU	Luxembourg
LV	Latvia
MC	Monaco
MD	Moldova, Republic of
ME	Montenegro
MF	Saint Martin (Fr)
MK	Macedonia
MQ	Martinique (Fr)
MR	Mauritania
MT	Malta
MU	Mauritius
MZ	Mozambique
NC	New Caledonia (Fr)
NL	Netherlands
NO	Norway
PF	French Polynesia (Fr)
PK	Pakistan
PL	Poland
PM	Saint Pierre and Miquelon (Fr)
PS	Palestina
PT	Portugal
QA	Qatar
RE	Réunion (Fr)
RO	Romania
RS	Serbia
SA	Saudi Arabia
SC	Seychelles
SE	Sweden
SI	Slovenia
SK	Slovakia
SM	San Marino
ST	Sao Tome and Principe
TF	French Southern Territories (Fr)
TL	Timor-Leste
TN	Tunisia
TR	Turkey
UA	Ukraine
VG	Virgin Islands, British
WF	Wallis and Futuna (Fr)
XK	Kosovo
YT	Mayotte (Fr)

Sepa

Service methods

sepaConvertBankAccountNumber

Parameters

nbi examples. This code varies per country

Returns

See also

sepaValidateInternationalBankAccountNumberFormat

Parameters

Returns

sepaIbanDetails

Parameters

Returns

sepaMatchAccountHolder

Parameters

Returns

Deprecated methods

sepaConvertBasicBankAccountNumber

Parameters

Returns

See also

Type definitions

SepaBankAccountData

SepaBankAccountIbanData

SepaIbanDetails

BbanDetails

SepaBankDetails

SepaInternationalBankAccountNumberFormatValidationReport

SepaMatchAccountHolderResult

SepaMatchBankAccountDetails

SepaMatchBankAccountHolder

SepaMatchNameMatchingResult

Test data

Available Countries