Bank Accounts services

Services about bank accounts creation, deletion and modification.

info

Only IBAN from the following countries of the SEPA zone are accepted.

Eurozone countries: Austria (AT), Belgium (BE), Cyprus (CY), Estonia (EE), Finland (FI), France (FR), Germany (DE), Greece (GR), Ireland (IE), Italia (IT), Latvia (LV), Lithuania (LT), Luxembourg (LU), Malta (MT), Netherlands (NL), Portugal (PT), Slovakia (SK), Slovenia (SI), Spain (ES),
Other European union countries: Bulgaria (BG), Croatia (HR), Czech Republic (CZ), Denmark (DK), Hungary (HU), Poland (PL), Romania (RO), Sweden (SE), United Kingdom (GB)
Other European countries: Island(IS) Liechtenstein (LI), Norway (NO)

Add a Bank Account - Manual verification

Add a bank account by providing a proof of IBAN document file:

The document will be added as PROOF_OF_IBAN to the account’s document list and the bank account status will be set to TO_VALIDATE until it is reviewed by our back office.
If validation succeeds, the status is change to ACTIVE and to INVALID if not.
The notification (webhook) BANKACCOUNT_VALIDATION_VALIDATED or BANKACCOUNT_VALIDATION_INVALIDATED is sent accordingly.

Request

POST /bankaccounts

Body - Property	Type	Value	Description
account_id	string	max size = 64 optional default = the partner account id	Account id
number	string	max size = 34	Bank account number (IBAN)
bic	string	max size = 12 optional	Bank identifier Code
holder_name	string	max size = 64 authorized characters= `[a-z] [A-Z] [0-9] / - ? : ( ) . , ' + space`	Bank Accout Holder name
tag	string	max size = 100 optional	Custom metadata
file_content	string	File content as string encoded in base64 optional	Base 64 encoded file content of the proof of iban document

Request Sample - Manual verification

POST /bankaccounts

{
  "account_id": "AS-459652557845695458",
  "tag": "My first bank account",
  "number": "FR7630006000011234567890189",
  "holder_name": "Michel Dubois",
  "file_content": "....Base64...."
}

Response

HTTP status	Case
201	Success
Body - Property	Type	Description
bankaccount	BANK_ACCOUNT	Bank account data

Response Sample

HTTP/1.1 201 CREATED

{
  "id": "BA-6876432164464461",
  "account_id": "AS-459652557845695458",
  "creation_date": "2017-09-25T12:01:18+0100",
  "status": "ACTIVE",
  "tag": "My first bank account",
  "number": "FR7630006000011234567890189",
  "bic": "PSPBFIHH",
  "bank_name": "SUOMEN PANKKI - FINLANDS BANK",
  "holder_name": "Michel Dubois",
  "verification_method": "DOCUMENT"
}

Add a Bank Account - Instant VOP verification

Add a bank account and verify it using the VOP verification process (real time check):

If the VOP verification result is MATCH or CLOSE_MATCH, the bank account is ACTIVE immediately.
In other case, the bank account is not created and an error is returned. As fallback, the Manual verification method can be done.

tip

To test in the Sandbox, please refer to the VOP Sandbox.

Request

POST /bankaccounts/vop

Body - Property	Type	Value	Description
account_id	string	max size = 64 optional default = the partner account id	Account id
number	string	max size = 34	Bank account number (IBAN)
tag	string	max size = 100 optional	Custom metadata

Request Sample - VOP verification

POST /bankaccounts/vop

{
  "account_id": "AS-459652557845695458",
  "number": "FR7630006000011234567890189",
  "tag": "An other bank account"
}

Response

HTTP status	Case
201	Success
Body - Property	Type	Description
bankaccount	BANK_ACCOUNT	Bank account data

Error code	Error description
2330	BankAccount VOP check not available
2331	BankAccount VOP check IBAN invalid
2332	BankAccount VOP check not match

Response Sample

HTTP/1.1 201 CREATED

{
  "id": "BA-6876432164464461",
  "account_id": "AS-459652557845695458",
  "creation_date": "2017-09-25T12:01:18+0100",
  "status": "ACTIVE",
  "tag": "My first bank account",
  "number": "FR7630006000011234567890189",
  "holder_name": "Michel Dubois",
  "verification_method": "VOP"
}

Get a Bank Account

Request

GET /bankaccounts/[id]

URL - Property	Type	Value	Description
id	string	max size = 64	Bank account id

Request Sample

GET /bankaccounts/BA-6876432164464461

Response

HTTP status	Case
200	Success
Body - Property	Type Description	Description
bankaccount	BANK_ACCOUNT	Bank account data

Response Sample

HTTP/1.1 200 OK

{
  "id": "BA-6876432164464461",
  "account_id": "AS-459652557845695458",
  "creation_date": "2017-09-25T12:01:18+0100",
  "status": "ACTIVE",
  "tag": "My first bank account",
  "number": "FI137XXXXXXXX00072",
  "bic": "PSPBFIHH",
  "bank_name": "SUOMEN PANKKI - FINLANDS BANK",
  "holder_name": "Dubois",
  "verification_method": "NONE"
}

List of Bank Accounts

Request

GET /bankaccounts?account_id=[account_id]&per_page=[per_page]&page=[page]

URL - Property	Type	Value	Description
account_id	string	max size = 64 optional	Account id If defined, returns only bank accounts associated to this account.
per_page	integer	min = 1 max = 100 optional default = 20	Number of bank accounts per page
page	integer	min = 1 optional default = 1	Requested page index

Request Sample

GET /bankaccounts?per_page=5&page=2

Request Sample

GET /bankaccounts?account_id=A-459652557845695458

Response

HTTP status	Case
200	Success
Body - Property	Type	Description
bankaccounts	BANK_ACCOUNT []	Bank account list

Response Sample

HTTP/1.1 200 OK

[
  {
    "id": "BA-6446446168764321",
    "account_id": "A-459652557845695458",
    "creation_date": "2017-07-13T22:01:18+0100",
    "tag": "My old bank account",
    "status": "INACTIVE",
    "number": "FI135XXXXXXXX00056",
    "bic": "OKOYFIHH",
    "bank_name": "OP CORPORATE BANK PLC",
    "holder_name": "Michel Dubois",
    "verification_method": "DOCUMENT"
  },
  {
    "id": "BA-6876432164464461",
    "account_id": "A-459652557845695458",
    "creation_date": "2017-09-25T12:01:18+0100",
    "tag": "My last bank account",
    "status": "ACTIVE",
    "number": "FI137XXXXXXXX00072",
    "bic": "PSPBFIHH",
    "bank_name": "SUOMEN PANKKI - FINLANDS BANK",
    "holder_name": "Michel Dubois",
    "verification_method": "VOP"
  }
]

Update a Bank Account

Request

PUT /bankaccounts/[id]

URL - Property	Type	Value	Description
id	string	max size = 64	Bank account id
Body - Property	Type	Value	Description
tag	string	max size = 100 optional	Custom metadata
holder_name	string	max size = 64 optional authorized characters = `[a-z] [A-Z] [0-9] / - ? : ( ) . , ' + space`	Bank Accout Holder name
status	enum	ACTIVE INACTIVE optional	Status of the Bank Account.

warning

Bank account can be set to INACTIVE if it is not required or if account have other associated ACTIVE bank account.

Request Sample

PUT /bankaccounts/BA-6876432164464461

{
  "tag": "My first bank account",
  "status": "INACTIVE"
}

Response

HTTP status	Case
200	Success
Body
- None -

Response Sample

HTTP/1.1 200 OK

Delete a Bank Account

Delete a bank account associated to an account.

warning

Bank account can be deleted if it is not required or if account have other associated ACTIVE bank account.

Request

DELETE /bankaccounts/[id]

URL - Property	Type	Value	Description
id	string	max size = 64	Bank account id

Request Sample

DELETE /bankaccounts/BA-6876432164464461

Response

HTTP status	Case
204	Success
Body
- None -

Response Sample

HTTP/1.1 204 No Content

Common Objects

BANK_ACCOUNT

Property	Type	Value	Description
id	string	max size = 64	Bank account id
account_id	string	max size = 64	Account id
creation_date	string	size = 24 Format: yyyy-MM-dd'T'HH:mm:ssZ	Bank account creation date.
tag	string	max size = 100	Custom metadata
status	enum	ACTIVE INACTIVE TO_VALIDATE INVALID	Bank account status
number	string	max size = 34	Masked IBAN (International Bank Account Number). The IBAN consists of the country code, two check digits and the account number. The height digits before the five last ones will be masked (i.e FI137XXXXXXXX00072).
bic	string	max size = 12 optional	The BIC (Business Identifier Code, SWIFT code) that identifies the bank or bank group.
bank_name	string	optional	The bank name (automatically found from IBAN number).
holder_name	string	max size = 64	Bank Account Holder name
document_id	string	max size = 64 optional	Document Id of the associated PROOF_OF_IBAN
verification_method	enum	NONE DOCUMENT STRONG_AUTH VOP	Bank Account verification method

Add a Bank Account - Manual verification​

Request​

Request Sample - Manual verification​

Response​

Response Sample​

Add a Bank Account - Instant VOP verification​

Request​

Request Sample - VOP verification​

Response​

Response Sample​

Get a Bank Account​

Request​

Request Sample​

Response​

Response Sample​

List of Bank Accounts​

Request​

Request Sample​

Request Sample​

Response​

Response Sample​

Update a Bank Account​

Request​

Request Sample​

Response​

Response Sample​

Delete a Bank Account​

Request​

Request Sample​

Response​

Response Sample​

Common Objects​

BANK_ACCOUNT​

Add a Bank Account - Manual verification

Request

Request Sample - Manual verification

Response

Response Sample

Add a Bank Account - Instant VOP verification

Request

Request Sample - VOP verification

Response

Response Sample

Get a Bank Account

Request

Request Sample

Response

Response Sample

List of Bank Accounts

Request

Request Sample

Request Sample

Response

Response Sample

Update a Bank Account

Request

Request Sample

Response

Response Sample

Delete a Bank Account

Request

Request Sample

Response

Response Sample

Common Objects

BANK_ACCOUNT