API Endpoints
post
Authorizations
Responses
201
Successful Operation.
application/json
401
Failed because the authentication token was not sent or it has already expired.
application/json
post
POST /aggregators/token-link HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 201,
"data": {
"linkToken": "myUrl"
}
}
post
Authorizations
Body
thirdPartyConnectionbooleanOptionalExample:
true
Responses
201
Successful Operation.
application/json
ResponseanyExample:
{"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
POST /aggregators/banking-connection HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"thirdPartyConnection": true
}
{
"statusCode": 201
}
post
Authorizations
Body
accountIdstringRequiredExample:
MyAccountId
Responses
201
Successful Operation.
application/json
ResponseanyExample:
{"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
POST /aggregators/banking-account-connection HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 27
{
"accountId": "MyAccountId"
}
{
"statusCode": 201
}
get
Authorizations
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
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
}
]
}
}
delete
Authorizations
Path parameters
accountIdstringRequired
Responses
200
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":200}
201
Successful Operation.
application/json
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
DELETE /aggregators/my-accounts/{accountId} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}
delete
Authorizations
Responses
200
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":200}
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
DELETE /aggregators/unlink-banking-connection HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}
Last updated
Was this helpful?