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
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
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
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
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
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
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
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:
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:
PaymentAmount object
Product values
ConnectorUpdateRequest object
ConnectorSourcesList object
ConnectorSource object
ConnectorSourceUpdateRequest object
Last updated