API Endpoints

PreviousEnv Configuration NextAuth0

Last updated 2 years ago

Was this helpful?

post

/aggregators/token-link

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/aggregators/token-link' \
  --header 'Authorization: Bearer JWT'

201

401

{
  "statusCode": 201,
  "data": {
    "linkToken": "myUrl"
  }
}

Successful Operation.

post

/aggregators/banking-connection

Authorizations

Body

thirdPartyConnectionboolean

Example: true

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/aggregators/banking-connection' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"thirdPartyConnection":true}'

201

401

404

422

{
  "statusCode": 201
}

Successful Operation.

post

/aggregators/banking-account-connection

Authorizations

Body

accountIdstringrequired

Example: MyAccountId

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/aggregators/banking-account-connection' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"accountId":"MyAccountId"}'

201

401

404

422

{
  "statusCode": 201
}

Successful Operation.

get

/aggregators/my-accounts

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/aggregators/my-accounts' \
  --header 'Authorization: Bearer JWT'

200

401

404

422

{
  "statusCode": 200,
  "data": {
    "accounts": [
      {
        "baasAccountId": "myId",
        "baasStatus": "active",
        "accountId": "myId",
        "availableBalance": "100",
        "currency": "USD",
        "lastFourDigits": "0023",
        "name": "Savings Account",
        "type": "depository",
        "subType": "savings",
        "category": "connected",
        "deletedAt": null
      }
    ]
  }
}

Successful Operation.

delete

/aggregators/my-accounts/{accountId}

Authorizations

Path parameters

accountIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/aggregators/my-accounts/{accountId}' \
  --header 'Authorization: Bearer JWT'

200

201

401

422

{
  "statusCode": 200
}

Successful Operation.

delete

/aggregators/unlink-banking-connection

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/aggregators/unlink-banking-connection' \
  --header 'Authorization: Bearer JWT'

200

401

404

422

{
  "statusCode": 200
}

Successful Operation.