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

200: OK List of connectors

Response body: ConnectorsList object

Deprecated route aliases:

/banks
/providers

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

200: OK Connector

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

200: OK Connector updated

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.

200: OK Connectors updated

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

200: OK Connectors updated

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

Query Parameters

200: OK List of connector sources

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

200: OK Connector source details

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

200: OK Connector source updated

Response body: ConnectorSource object

Data model

ConnectorsList object

Connector object

Available expands

The following parameters can be used for response properties expansion:

AuthMechanism values

Forward compatibility requirement: additional mechanisms may be added in the future. When implementing mechanism handling, always safely handle unsupported values.

ConnectorField object

ConnectorPaymentField object

ConnectorFieldType values

ConnectorCountry object

PaymentSettings object

An example payment_settings object is the following:

{
  "available_validate_mechanisms": ["webauth"],
  "beneficiary_types": ["iban"],
  "execution_date_types": ["first_open_day", "deferred", "periodic"],
  "execution_frequencies": ["monthly", ...],
  "maximum_number_of_instructions": 10,
  "partial_status_tracking": ["first_open_day"],
  "is_app_to_app_used": {
    "android": false,
    "ios": null
  },
  "bank_provides_payer_account": true,
  "bank_provides_payer_label": null,
  "transfer_date_types_where_trusted_beneficiary_required": ["periodic"],
  "cancellation_available": true,
  "minimum_amount": {
    "first_open_day": 0.,
    "deferred": 0.,
    "instant": 0.
  },
  "maximum_amount": {
    "first_open_day": 4000.,
    "deferred": 4000.,
    "instant": 1000.
  },
  "minimum_date_delta_days": 1,
  "maximum_date_delta_days": 30,
}

ProvidingPayerAccount values

PaymentAppToAppUsed object

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:

{
  "android": false,
  "ios": null
}

PaymentAmount object

Product values

ConnectorUpdateRequest object

ConnectorSourcesList object

ConnectorSource object

ConnectorSourceUpdateRequest object