Using our production environment you can access Live and Sandbox connectors. For testing purposes, you can experiment with your integration using our Sandbox connector (which represents our Sandbox environment). This will let you see how the transactions update daily and test all the possible valid connections and erroneous flows.
Warning
All the sandbox items that are not updated for more than 30 days will be deleted without any possibility to get them back in the future.
You will find different flows:
- Basic flow (we also include a special Caixa flow)
- Basic flow Business
- MFA 1-step
- MFA 2-step
- Joint accounts (Bradesco Conta Conjunta flow)
- QR Login flow
- Open Finance flow
For a successful flow, the credentials are:
- Correct password:
password-ok - Correct MFA Token:
123456
Each test user name below maps to a specific execution status. See Item lifecycle for the full description of item and execution statuses.
1- Basic flows#
Note
The basic flow also works for Business connectors.
| Execution status | User name | Description |
|---|---|---|
SUCCESS | user-ok | Successful connection. |
ALREADY_LOGGED_IN | user-logged | The user already has an opened login session (needs to manually log out). |
ACCOUNT_LOCKED | user-locked | User account is locked, needs manual action to be unlocked. |
UNEXPECTED_ERROR | user-error | Connector had a random error. |
SITE_NOT_AVAILABLE | user-unavailable | Provider site was not available. |
ACCOUNT_NEEDS_ACTION | user-account-need-actions | Provider is requesting some manual action from the user (ie. accept new terms of use). |
ACCOUNT_NEEDS_ACTION + providerMessage | user-account-need-actions-provider-message | Provider is requesting some manual action from the user, including instructions to address it in the item error providerMessage field. |
CONNECTION_ERROR | user-connection-error | There was an internal connection error with the provider (ie. Proxy issue). |
INVALID_CREDENTIALS | anything else | The user/password credentials were invalid. |
PARTIAL_SUCCESS | user-ok-account-error | Error recovering account product. |
SUCCESS with warnings | user-ok-account-warning | Warning in account product. |
ACCOUNT_CREDENTIALS_RESET | user-account-credentials-reset | The user needs to update some of their credentials in the institution. |
USER_NOT_SUPPORTED | user-not-supported | The user is not allowed to perform login in the institution through Pluggy. |
SUCCESS with two checking accounts data | user-ok-two-checking-accounts | Success, but returns an example of two checking accounts. |
Enlarge result data#
In cases in which it is necessary to test large amounts of transactions in the result, you can use the user-ok-perf or user-ok-perf-XXx username to recreate this situation. XX represents the multiplier for the number of transactions to be retrieved. For example, if you choose 1000 as XX, the resulting username would be user-ok-perf-1000x, in order to multiply the result by this number.
The limit of this multiplier is 5000, so if you use a larger number, the multiplier will be just 5000.
Basic Flow | Authorization Pending status (Caixa flow)#
This is a special case that emulates the Caixa flow. It consists of three possible execution statuses to be returned.
When a user connects for the first time, the expected execution returned will be to confirm the user device shown (i.e. "1234-5678").
So, the first execution (after the user confirms the device on his side) will return USER_AUTHORIZATION_PENDING and a message that informs the time that the user must wait until authorization is granted from Caixa.
Once this step is completed, there are two possible scenarios:
- If the user updates the item within the time to be awaited, the execution result will be
USER_AUTHORIZATION_NOT_GRANTEDand a message to remind the time to be awaited until the authorization is granted from Caixa (in the Sandbox case, the time is 2 minutes). - If the user updates the item after the wait is over, the data of the account will be retrieved successfully and the execution report will be
SUCCESS.
See the table below for more details:
| Execution status | User name | Description |
|---|---|---|
USER_AUTHORIZATION_PENDING | user-ok-auth-pending | This will report a USER_AUTHORIZATION_PENDING status, and a message to wait for 2 minutes until the institution grants authorization. Then, you can update the item to retrieve the data after those 2 minutes, or get a not-yet-granted authorization message (please read the next rows). |
USER_AUTHORIZATION_NOT_GRANTED | re-use credentials (update) | If the item is updated before the institution grants authorization, the status reported will be USER_AUTHORIZATION_NOT_GRANTED and you will be newly asked to wait for the 2 minutes after the first execution. |
SUCCESS | re-use credentials (update) | If the item is updated once the institution authorization is completed, then the data should be retrieved and the status report will be SUCCESS. |
3- MFA 1-step#
| Scenario | User name | MFA | Description |
|---|---|---|---|
| Login Ok | user-ok | 123456 | Successful connection. |
INVALID_CREDENTIALS_MFA | user-ok | ≠ 123456 | The MFA parameter provided was incorrect. |
4- MFA 2-step#
| Scenario | User name | MFA | Description |
|---|---|---|---|
| Login Ok | user-ok | 123456 | Successful connection. |
INVALID_CREDENTIALS_MFA | user-ok | ≠ 123456 | The MFA parameter provided was incorrect. |
| Login Ok (MFA with QR image) | user-ok-img | 123456 | Successful connection. |
INVALID_CREDENTIALS_MFA (MFA with QR image) | user-ok-img | ≠ 123456 | The MFA parameter provided was incorrect. |
| Login Ok (MFA with options to select) | user-ok-select | any | Successful connection. |
| Login OK (with phone selection before MFA) | user-ok-phone | 123456 | Successful connection. |
INVALID_CREDENTIALS_MFA (with phone selection before MFA) | user-ok-phone | ≠ 123456 | The MFA parameter provided was incorrect. |
| Login Ok (with company selection after MFA) | user-ok-multi-company | 123456 | Successful connection. |
INVALID_CREDENTIALS_MFA | user-ok-multi-company | ≠ 123456 | The MFA parameter provided was incorrect. |
UNEXPECTED_ERROR | user-ok-mfa-error | 123456 | Connector had a random error. |
ACCOUNT_LOCKED | user-ok-mfa-locked | 123456 | User account is locked, needs manual action to be unlocked. |
SITE_NOT_AVAILABLE | user-ok-mfa-unavailable | 123456 | Provider site was not available. |
CONNECTION_ERROR | user-ok-mfa-connection-error | 123456 | There was an internal connection error with the provider (ie. Proxy issue). |
ALREADY_LOGGED_IN | user-ok-mfa-logged | 123456 | The user already has an opened login session (needs to manually log out). |
ACCOUNT_NEEDS_ACTION | user-ok-mfa-account-need-actions | 123456 | Provider is requesting some manual action from the user (ie. accept new terms of use). |
5- Joint Accounts (Bradesco Conta Conjunta flow)#
This is a special case that emulates the Bradesco Conta Conjunta flow.
Below you will find two examples:
- Testing in the Pluggy Connect widget
- Testing via Postman
1- Testing in the Pluggy Connect widget#
When using the Pluggy Connect widget, the user will be presented to choose first from either a "Single account" or a "Joint account".
- If the user selects "Single account", they will be asked for bank credentials and MFA in the same step as the credentials.
- If the user selects "Joint account", they will be asked only for bank credentials. Then, they will be asked which account they want to connect, and after that, the MFA will be required. If the MFA is correct, the account will connect successfully.
2- Testing via Postman#
- When testing "single account", the request is the same as sandbox MFA 1-step. The bank credentials and MFA are sent together.
- When testing "joint account", you have to include an MFA 1-step parameter, with the mock value:
000000.
Note that this is the same as the Connect widget flow. When the user selects the "joint account" flow, the UI is not asking to complete the MFA parameter.
6- QR Login flow#
This is a case that originally simulates a flow similar to Inter QR. No credentials are necessary. Once started, the item will enter a WAITING_USER_ACTION status, and return a QR code for the user to scan.
This flow will simulate a rapidly changing QR code for 10 seconds and then simulate the user reading the QR and advancing the state to a normal login flow.
7- Open Finance flow#
To connect using our sandbox connection (see Creating an Open Finance item), you will be required to send a CPF:
| Scenario | CPF |
|---|---|
| Basic flow | 761.092.776-73 |
| Multiple authorization flow - approved | 238.242.640-30 |
| Multiple authorization flow - rejected | 051.177.670-55 |
| Basic flow - with slow authentication | 002.502.737-99 |
| Basic flow - force error getting OF resources | 163.511.711-99 |
This will redirect you to the mock bank login page. Please use the following credentials:
- User:
ralph.bragg@gmail.com - Password:
P@ssword01
How does the multiple authorization (múltipla alçada) flow work?#
This flow simulates a scenario where, in order to retrieve account data, the item must be approved by another person (typically another company associate). To test this scenario, follow these steps:
- Create a sandbox item using one of the CPFs listed in the table above. The item will not return accounts immediately. Instead, the
statusDetailfield will indicate that the accounts require authorization. - Update that item. Depending on the CPF you provided, the accounts may or may not be returned.