Connectors
Connectors represent business institutions that Powens can establish connections with, in order to extract data.
API endpoints
Authentication: endpoints listed in this page do not require authentication.
Connectors
List connectors
GET
https://{domain}.biapi.pro/2.0/connectors
List all connectors available on the domain.
This endpoint does not require authentication.
Query Parameters
id_payment
String
Filter on a payment id to get only the connectors compatible with this payment.
Response body: ConnectorsList object
Get a connector
GET
https://{domain}.biapi.pro/2.0/connectors/{connectorUuid}
Get a single connector by UUID.
This endpoint does not require authentication.
Path Parameters
connectorUuid*
String
UUID of the connector. IDs are also accepted (deprecated).
Response body: Connector object
Update a connector
PUT
https://{domain}.biapi.pro/2.0/connectors/{connectorUuid}
This endpoint requires header authentication with a config token.
Request body: ConnectorUpdateRequest object
Path Parameters
connectorUuid*
String
UUID of the connector. IDs are also accepted (deprecated).
Response body: Connector object
Batch enable/disable connectors
PATCH
https://{domain}.biapi.pro/2.0/connectors
This endpoint requires header authentication with a config token.
Request body: A key-value object with connector UUIDs as keys, and ConnectorUpdateRequest object as value.
Batch enable/disable connectors (deprecated)
PUT
https://{domain}.biapi.pro/2.0/connectors/{connectorIds}
This endpoint requires header authentication with a config token.
Request body: ConnectorUpdateRequest object
Path Parameters
connectorIds*
String
Comma-separated list of connector IDs to update.
Response body: Connector object
Connector sources
List connector sources
GET
https://{domain}.biapi.pro/2.0/connectors/{connectorUuid}/sources
This endpoint does not require authentication.
Path Parameters
connectorUuid*
String
UUID or the related connector.
Query Parameters
Response body: ConnectorSourcesList object
Get a connector source
GET
https://{domain}.biapi.pro/2.0/connectors/{connectorUuid}/sources/{sourceId}
This endpoint does not require authentication.
Path Parameters
connectorUuid*
String
UUID or the related connector.
sourceId*
Integer
ID of the connector source.
Response body: ConnectorSource object
Update a connector source
PUT
https://{domain}.biapi.pro/2.0/connectors/{connectorUuid}/sources/{sourceId}
This endpoint requires header authentication with a config token.
Request body: ConnectorSourceUpdateRequest object
Path Parameters
connectorUuid*
String
UUID or the related connector.
sourceId*
Integer
ID of the connector source.
Response body: ConnectorSource object
Data model
ConnectorsList object
Connector object
id
Integer
ID of the connector, not stable across API domains.
uuid
String
Unique connector identifier, stable across API domains.
name
String
Name of the bank or provider.
hidden
Boolean or null
Whether this connector is hidden from users.
charged
Boolean
Usage of this connector is charged.
code
String or null
Bank code.
beta
Boolean
If true, this connector is likely unstable.
color
String or null
Branding color of the bank or provider.
slug
String or null
A short letter code to identify the connector. Slugs are not unique.
sync_frequency
Decimal or null
How many days to wait between syncs.
months_to_fetch
Integer or null
Number of months of history to fetch when synchronizing a connection.
available_auth_mechanisms
Array of AuthMechanism strings
The list of available mechanisms to add a connection (internal use only).
siret
String
SIRET code, for providers.
restricted
Boolean
If true, new connections cannot be added with this connector.
capabilities
Array of strings
The list of capabilities implemented on the connector. E.g. profile
means that the connector is able to return identity information.
account_usages
Array of BankAccountUsage strings
The list of account usages returned by the sources of the connector.
payment_settings
PaymentSettings object
An object providing information about payment feature on this connector. Only present if Pay product is enabled on the connector.
products
Array of Product strings
The list of products implemented on the connector. (e.g. pay
means that the connector has Pay product).
Available expands
The following parameters can be used for response properties expansion:
fields
Array of ConnectorField objects
The list of initial form fields associated with the connector. Only relevant when building a custom connection integration.
payment
_fields
Array of ConnectorPaymentField objects
The list of initial form fields to use when validating a payment. Only relevant when implementing your own payment validation webview.
countries
Array of ConnectorCountry objects
Countries where users can open or have accounts/subscriptions with the given institution.
urls
Array of strings
List of connector's URLs from which we get the data.
AuthMechanism values
credentials
Connections will use a set of fields to save user credentials.
webauth
Connections will use a web-based flow to obtain access.
Forward compatibility requirement: additional mechanisms may be added in the future. When implementing mechanism handling, always safely handle unsupported values.
ConnectorField object
name
String
The technical name of the field, used as a key when sending the values for the field.
connector_sources
Array of strings
The list of connector source names for which the field is relevant. Fields should be presented sequentially according to the source being added. The value can differ with the auth_mechanism
preferentially used.
auth_mechanisms
Array of AuthMechanism strings
The list of mechanisms for which the field is relevant. Fields should be presented sequentially according to the source being added.
type
ConnectorFieldType string
Type of the field, to be used to present an appropriate UI form field to the end-user. Implementations should ignore unsupported types and fallback to a text field.
label
String
A short display label for the field.
required
Boolean
If true, the parameter is required, with a non-empty value, when creating a connection.
regex
String or null
An optional regular expression (PCRE-compatible) that the field value must validate.
values
Array of objects
For list
fields, a closed list of fixed values to chose from. Entries are composed of label
(string, display value of the field) and value
(string, the actual value to send for the field).
ConnectorPaymentField object
name
String
The technical name of the field, used as a key when sending the values for the field.
auth_mechanisms
Array of strings
The list of validation mechanisms for which the field is relevant. Fields should be presented sequentially according to the source being added.
type
ConnectorFieldType string
Type of the field, to be used to present an appropriate UI form field to the end-user. Implementations should ignore unsupported types and fallback to a text field.
label
String
A short display label for the field.
required
Boolean
If true, the parameter is required, with a non-empty value, when creating a connection.
regex
String or null
An optional regular expression (PCRE-compatible) that the field value must validate.
values
Array of objects
For list
fields, a closed list of fixed values to chose from. Entries are composed of label
(string, display value of the field) and value
(string, the actual value to send for the field).
ConnectorFieldType values
text
A simple text field.
password
A simple text field for a sensitive value. Implementations should provide secure typing for such fields.
date
A date field. Input should be proposed in a user-friendly manner with a picker or a localized text input, but the value must be submitted as an ISO 8601 date string (yyyy-mm-dd).
list
A field whose value must be chosen in a closed list of values
. The field can be presented with a dropdown or a similar control.
ConnectorCountry object
id
String
The country ISO 3166‑1 alpha‑2 code.
name
String
The country name.
PaymentSettings object
available_validate_mechanisms
Array of strings
The list of payment validation mechanisms supported by this connector. As of Sept. 2023, the only supported mechanism is webauth
.
beneficiary_types
Array of PaymentAccountSchemeName
The list of supported payment beneficiary types for this connector.
maximum_number_of_instructions
Integer
The maximum number of individual instructions for one payment. If 1
, the connector does not support Bulk payments.
providing_payer_account
Indicates if the connector needs the payer account identification in order to initiate a payment with their bank.
partial_status_tracking
Array of ExecutionDate
Indicates for which payment date types a payment can reach the final state accepted
for this connector, meaning the bank does not provide us with the full tracking of the payment status. See PaymentState values for more information. An empty list indicates that payments will never get the state accepted
on this connector.
is_app_to_app_used
Whether redirects can be caught by native applications on mobile platforms.
bank_provides_payer_account
Boolean or null
Whether the bank provides the payer account or not. null
means this information is not yet available.
bank_provides_payer_label
Boolean or null
Whether the bank provides the payer account label or not. null
means this information is not yet available.
transfer_date_types_where_
trusted_beneficiary_required
Array of ExecutionDate
List of execution date types for which the beneficiary must be trusted beforehand by the payer.
minimum_amount
PaymentAmount
The minimum amount for a payment on this connector. The amount can differ between payment types.
maximum_amount
PaymentAmount
The maximum amount for a payment on this connector. The amount can differ between payment types. Note that this amount is not necessarily a hard limit and a PSU payment account could have a specific transfer limit (whether higher or lower).
minimum_date_delta_days
Decimal
The minimum number of days in the future for a deferred or periodic payment.
maximum_date_delta_days
Decimal or null
The maximum number of days in the future for a deferred or periodic payment.
An example payment_settings
object is the following:
ProvidingPayerAccount values
not_used
The payer account is not necessary and must not be given.
optional
The payer account is optional. Providing the account may have an impact on the bank's webview (e.g. the payment account may be preselected for the user, or the user may not have the possibility to change it for another one).
mandatory
The payer account must be provided. The bank does not allow a payment initiation without this information.
PaymentAppToAppUsed object
android
Boolean or Null
Whether redirections can be caught by a native application or not on Android.
ios
Boolean or Null
Whether redirections can be caught by a native application or not on Apple iOS.
For all platforms, null
means that the information is not available yet. Note that true
does not mean the redirections are necessarily caught by a native application, since the end user may not have installed the appropriate application for this to happen.
An example PaymentAppToAppUsed
object is the following:
PaymentAmount object
first_open_day
Decimal
No
The amount limit for first open day payments.
instant
Decimal
No
The amount limit for instant payments.
deferred
Decimal
No
The amount limit for deferred payments.
periodic
Decimal
No
The amount limit for periodic payments.
Product values
bank
Bank product.
wealth
Wealth product.
bill
Bill product.
pay
Pay product.
ConnectorUpdateRequest object
hidden
Boolean
No
Whether the connector is hidden from users.
sync_periodicity
Decimal
No
Number of days between two automatic synchronizations. Overload global sync_periodicity
parameter.
ConnectorSourcesList object
ConnectorSource object
id
Integer
ID of the connector source.
id_connector
Integer
ID of the related connector.
name
String
Name of the connector source.
auth_mechanism
AuthMechanism string or null
Authentication mechanism to use to add a connection source.
available_auth_mechanisms
Array of AuthMechanism strings
The list of available mechanisms to add a connection source.
disabled
DateTime or null
If set, this source is ignored on synchronizing the connection.
priority
Integer
The source priority order for the synchronization. Sources must be added following priority order.
ConnectorSourceUpdateRequest object
disabled
DateTime or null
No
If set, this source is ignored on synchronizing the connection.
Last updated