API Endpoints

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

201

Successful Operation.

application/json

statusCodenumberRequiredExample: 201

401

Failed because the authentication token was not sent or it has already expired.

application/json

post

/aggregators/token-link

HTTPcURLJavaScriptPython

POST /aggregators/token-link HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

thirdPartyConnectionbooleanOptionalExample: true

Responses

201

Successful Operation.

application/json

anyOptionalExample: {"statusCode":201}

401

Failed because the authentication token was not sent or it has already expired.

application/json

404

An error occurred while sending the request to the external service.

application/json

422

An error occurred while processing the information.

application/json

post

/aggregators/banking-connection

HTTPcURLJavaScriptPython

POST /aggregators/banking-connection HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "thirdPartyConnection": true
}

{
  "statusCode": 201
}

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

accountIdstringRequiredExample: MyAccountId

Responses

201

Successful Operation.

application/json

anyOptionalExample: {"statusCode":201}

401

Failed because the authentication token was not sent or it has already expired.

application/json

404

An error occurred while sending the request to the external service.

application/json

422

An error occurred while processing the information.

application/json

post

/aggregators/banking-account-connection

HTTPcURLJavaScriptPython

POST /aggregators/banking-account-connection HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "accountId": "MyAccountId"
}

{
  "statusCode": 201
}

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Operation.

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

404

An error occurred while sending the request to the external service.

application/json

422

An error occurred while processing the information.

application/json

get

/aggregators/my-accounts

HTTPcURLJavaScriptPython

GET /aggregators/my-accounts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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
      }
    ]
  }
}

delete

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstringRequired

Responses

200

Successful Operation.

application/json

201

Successful Operation.

application/json

anyOptionalExample: {"statusCode":201}

401

Failed because the authentication token was not sent or it has already expired.

application/json

422

An error occurred while processing the information.

application/json

delete

/aggregators/my-accounts/{accountId}

HTTPcURLJavaScriptPython

DELETE /aggregators/my-accounts/{accountId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 200
}

delete

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Operation.

application/json

401

Failed because the authentication token was not sent or it has already expired.

application/json

404

An error occurred while sending the request to the external service.

application/json

422

An error occurred while processing the information.

application/json

delete

/aggregators/unlink-banking-connection

HTTPcURLJavaScriptPython

DELETE /aggregators/unlink-banking-connection HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 200
}