search

API Endpoints

You can find these endpoints in src/aggregators/plaid/plaid.controller.ts

hashtag
Get token link.

POST {{url}}/aggregators/token-link

This endpoint generates a public_token that has a time-to-live of 30 minutes.

hashtag
Headers

Name
Type
Description

Authorization*

String

Bearer token

{
    "statusCode": 201,
    "data": {
        "link_token": "link-sandbox-0ed4a93e-ba5f-42ca-be0f-7ce8f04cd42d"
    }
}

hashtag
Generate access token and processor token.

POST {{url}}/aggregators/banking-connection

In this endpoint, send a public_token to generate an access_token so you can get linked account information in Plaid.

hashtag
Headers

Name
Type
Description

Authorization*

String

Bearer token

hashtag
Request Body

Name
Type
Description

public_token*

String

third_party_connection

boolean

This parameter is a flag to know if you want to directly connect your account to your BaaS

hashtag
Get my accounts.

GET {{url}}/aggregators/my-accounts

This endpoint returns all accounts registered by the user.

hashtag
Headers

Name
Type
Description

Authorization*

String

Bearer token

circle-exclamation

For the my-accounts endpoints, the baasAccountId and baasStatus fields are taken from the BaaS the account is connected to. If these fields have a null value, it means that the account has not been connected to any BaaS. But, if there is a baasAccountId, we can take the baas_status as a reference to know if the connection to the BaaS was successful.

hashtag
Connect account to BaaS.

POST {{url}}/aggregators/banking-account-connection

This endpoint connects the selected account to the BaaS.

hashtag
Headers

Name
Type
Description

Authorization*

String

Bearer token

hashtag
Request Body

Name
Type
Description

account_id*

String

hashtag
Remove Plaid connection.

DELETE {{url}}/aggregators/unlink-banking-connection

This endpoint removes the access token generated to make queries in Plaid.

hashtag
Headers

Name
Type
Description

Authorization*

String

Bearer token

hashtag
Remove specific account.

DELETE {{URL}}/aggregators/my-accounts/:id

This endpoint removes the processor token generated to make queries in Plaid.

hashtag
Path Parameters

Name
Type
Description

id*

Account ID

hashtag
Headers

Name
Type
Description

Authorization*

String

Bearer token

PreviousVerification of Environment VariablesNextResources

Last updated