Field | Description |
---|---|
id long | Bank's unique identifier. |
resource_uri string | |
resource_type string, constant | |
name string | Bank's name. |
country_code string | Bank's ISO 3166-1 alpha-2 country code. Currently we only support banks from FR , GB , DE , ES and NL . |
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. |
primary_color | |
secondary_color | |
logo_url | |
deeplink_ios | |
deeplink_android | |
transfer_enabled boolean (will be deprecated) | This field won't be used anymore in the API next version so we suggest you to use capabilities field instead |
payment_enabled boolean (will be deprecated) | This field won't be used anymore in the API next version so we suggest you to use capabilities field instead |
form array | An array of bank field that holds the online bank connection form information and requirements. |
capabilities array | An array of the bank's capabilities : ais , single_transfer , bulk_transfer , single_payment and bulk_payment . |
transfer list | This field is displayed if the bank has single_transfer and/or bulk_transfer .The list contains two fields: nb_max_transactions and max_size_label . |
payment list | This field is displayed if the bank has single_payment and/or bulk_payment .The list contains two fields: nb_max_transactions and max_size_label . |
PARENT BANK
name string | Parent bank's name. |
logo_url url | Logo of the parent bank. |
banks array | Banks under this parent bank. |
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,
"resource_uri": "/v2/banks/17",
"resource_type": "bank",
"name": "La Banque Postale Particulier",
"parent_name": "La Banque Postale",
"country_code": "FR",
"automatic_refresh": true,
"primary_color": null,
"secondary_color": null,
"logo_url": "https://web.bankin.com/img/banks-logo/france/[email protected]",
"deeplink_ios": null,
"deeplink_android": null,
"transfer_enabled": true, // will be deprecated
"payment_enabled": false, // will be deprecated
"form": [
{
"label": "Identifiant",
"type": "USER",
"isNum": "0",
"maxLength": 11
},
{
"label": "Mot de passe",
"type": "PWD",
"isNum": "1",
"maxLength": 6
}
],
"authentication_type": "INTERNAL_CREDS",
"capabilities": [
"ais",
"single_transfer",
"single_payment"
],
"transfer": {
"nb_max_transactions": 1,
"max_size_label": 140
},
"payment": {
"nb_max_transactions": 1,
"max_size_label": 140
}
}