API Endpoints
Successful Operation.
Failed because the authentication token was not sent or it has already expired.
POST /aggregators/token-link HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 201,
"data": {
"linkToken": "myUrl"
}
}
true
Successful Operation.
{"statusCode":201}
Failed because the authentication token was not sent or it has already expired.
An error occurred while sending the request to the external service.
An error occurred while processing the information.
POST /aggregators/banking-connection HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"thirdPartyConnection": true
}
{
"statusCode": 201
}
MyAccountId
Successful Operation.
{"statusCode":201}
Failed because the authentication token was not sent or it has already expired.
An error occurred while sending the request to the external service.
An error occurred while processing the information.
POST /aggregators/banking-account-connection HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 27
{
"accountId": "MyAccountId"
}
{
"statusCode": 201
}
Successful Operation.
Failed because the authentication token was not sent or it has already expired.
An error occurred while sending the request to the external service.
An error occurred while processing the information.
GET /aggregators/my-accounts HTTP/1.1
Host:
Authorization: Bearer JWT
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
}
]
}
}
Successful Operation.
{"statusCode":200}
Successful Operation.
Failed because the authentication token was not sent or it has already expired.
An error occurred while processing the information.
DELETE /aggregators/my-accounts/{accountId} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}
Successful Operation.
{"statusCode":200}
Failed because the authentication token was not sent or it has already expired.
An error occurred while sending the request to the external service.
An error occurred while processing the information.
DELETE /aggregators/unlink-banking-connection HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}
Last updated
Was this helpful?