Pluggy Connect

Get your web application quickly and seamlessly integrated to our platform by using our drop-in Connect Widget!

Currently available for the following environments:

Navigate to each project to find more detailed usage information in each README. You can also check out our Quickstarts repo to help you get started with your own integration.

👍

interested in contributing?

Let us know if you require or if you are interested in contributing a library for a language not represented here! Write us to [email protected]

Available configurations

Note: all parameters are optional, except for the connectToken.

Property

Description

Type

connectToken

Your Pluggy Connect token, which will be used to access the API.

string

includeSandbox

Whether to display Sandbox connectors in the Connector selection step (not intended for production use)

boolean

updateItem

Item id to update. If specified, the modal will display directly the credentials form of the item to be updated.

string

connectorTypes

List of Connector Types. If defined, only Connectors of the specified connector types will be listed.

ConnectorType[]

connectorIds

List of Connector IDs. If defined, only Connectors of the specified connector IDs will be listed.

number[]

countries

List of country codes (ISO-3166-1 alpha 2 format). If defined, only Connectors of the specified countries will be listed.

CountryCode[]

language

Language ISO string used to display the widget. If not specified, or selected language is not supported, the default language 'pt' will be used.

string

onSuccess

Function to execute when an Item has been created/updated successfully.

(data: { item: Item }) => void

onError

Function to execute on a general error loading the widget, or when an Item creation/update status has not been successful.

(error: { message: string; data?: { item: Item } }) => void

onOpen

Function to execute when the widget modal has been opened.

() => void

onClose

Function to execute when the widget modal has been closed.

() => void

onEvent

Function to execute to handle custom user interaction events. See below for more info.

(event: string, metadata: { timestamp: number }) => void

onEvent

Use this callback to handle specific user interaction events.

The first event string parameter is the name of event, and the second, a metadata object that is related to such event. The available events that can be handled through this method are:

Event name

Description

'SUBMITTED_CONSENT'

User has confirmed terms & privacy consent on the first Welcome screen.

'SELECTED_INSTITUTION'

User has selected an institution to connect to.

'SUBMITTED_LOGIN'

User has submitted credentials to create the connection Item.

'SUBMITTED_MFA'

User has submitted an extra parameter that has been requested by the institution to connect.