Field | Description |
---|---|
id long | Bank's unique identifier. |
name string | Bank's name. |
form array | An array of bank field that holds the online bank connection form information and requirements. |
country_code string | Bank's ISO 3166-1 alpha-2 country code. Currently we only support banks from "fr", "gb", "de", "es". |
automatic_refresh boolean | Flag that indicates if the items from the given bank will refresh automatically. It is set to false when the bank requires a One-Time Password on every connection.If false , you must call Refresh an item manually to refresh the item. |
resource_type string, constant | |
resource_uri string |
BANK FIELD
label string | Field's name on the bank's website. |
type string | Field's type. Possible values: USER , PWD , PWD2 .Depending on the bank: - USER represents a customer's id.- PWD represents a customer's password.- PWD2 represents an additional customer's password, memorable question or passphrase. |
isNum string | "1" meaning that the field only accepts numbers. |
maxLength number | Field's maximum length.null meaning their is no limit. |
Example bank resource
{
"id": 17,
"name": "La Banque Postale",
"form": [
{
"label": "Identifiant",
"type": "USER",
"isNum": "0",
"maxLength": null
},
{
"label": "Mot de passe",
"type": "PWD",
"isNum": "1",
"maxLength": 6
}
],
"country_code": "FR",
"automatic_refresh": true,
"resource_uri": "/v2/banks/17",
"resource_type": "bank"
}