Financial institutions

A financial institution serves as an umbrella object for bank accounts that use the same sign-in process to connect to bank feeds.

List financial institutions

get/objects/cash-management/financial-institution

Returns up to 100 object references from the collection with a key, ID, and link for each financial institution. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionCash Management, Sage Cloud Services
User typeBusiness user with admin permissions
PermissionsList, View Financial Institutions
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "FinInst1",
      • "href": "/objects/cash-management/financial-institution/1"
      },
    • {
      • "key": "2",
      • "id": "FinInst2",
      • "href": "/objects/cash-management/financial-institution/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a financial institution
post/objects/cash-management/financial-institution
Creates a new financial institution.



Permissions and other requirements



SubscriptionCash Management, Sage Cloud Services


User typeBusiness user with admin permissions


PermissionsAdd Financial Institution







SecurityOAuth2 
Request 
Request Body schema: application/json
id
required
string
Unique identifier for the financial institution.


 
 Example:  "USA_FinInst"
name
string
Name of the financial institution.


 
 Example:  "USA financial institution"
Array of objects
Services associated with the financial institution.


 
 Array 
name
string
 
 Example:  "MAL"
object
 
Array of objects
Checking accounts associated with the financial institution.


 
 Array 
key
string
 
 Example:  "2"
object
 
requestedStartDate
string <date> 
 
 Example:  "2021-01-23"
Array of objects
Savings accounts associated with the financial institution.


 
 Array 
key
string
 
 Example:  "2"
object
 
requestedStartDate
string <date> 
 
 Example:  "2021-01-23"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "FinInst-BOA",
  • "name": "FinOn4ss5e",
  • "addOnServices": [
    • {
      • "name": "MAL",
      • "serviceContract": {
        }
      }
    ],
  • "checkingAccounts": [
    • {
      • "key": "72",
      • "externalBankAccount": {
        },
      • "requestedStartDate": "2021-01-23"
      },
    • {
      • "key": "69",
      • "externalBankAccount": {
        },
      • "requestedStartDate": "2021-01-23"
      }
    ],
  • "savingsAccounts": [
    • {
      • "key": "33",
      • "externalBankAccount": {
        },
      • "requestedStartDate": "2021-01-23"
      },
    • {
      • "key": "30",
      • "externalBankAccount": {
        },
      • "requestedStartDate": "2021-01-23"
      }
    ],
  • "creditCards": [
    • {
      • "key": "60",
      • "externalBankAccount": {
        },
      • "requestedStartDate": "2021-01-23"
      },
    • {
      • "key": "7",
      • "externalBankAccount": {
        },
      • "requestedStartDate": "2021-01-23"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "103",
    • "href": "/objects/cash-management/financial-institution/103"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a financial institution
get/objects/cash-management/financial-institution/{key}
Returns detailed information for a specified financial institution.



Permissions and other requirements



SubscriptionCash Management, Sage Cloud Services


User typeBusiness user with admin permissions


PermissionsList, View Financial Institutions







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the financial institution.


 
 Example:  109
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "FinInst1",
    • "name": "FinOn4ddss5e",
    • "totalAccounts": 7,
    • "checkingAccounts": [
      • {
        },
      • {
        },
      • {
        }
      ],
    • "savingsAccounts": [
      • {
        },
      • {
        }
      ],
    • "creditCards": [
      • {
        },
      • {
        }
      ],
    • "addOnServices": [
      • {
        }
      ],
    • "href": "/objects/cash-management/financial-institution/96"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a financial institution
patch/objects/cash-management/financial-institution/{key}
Updates an existing financial institution by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionCash Management, Sage Cloud Services


User typeBusiness user with admin permissions


PermissionsMap accounts, List, View, Add, Edit Financial Institution







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the financial institution.


 
 Example:  109
Request Body schema: application/json
id
required
string
Unique identifier for the financial institution.


 
 Example:  "USA_FinInst"
name
string
Name of the financial institution.


 
 Example:  "USA financial institution"
Array of objects
Services associated with the financial institution.


 
 Array 
name
string
 
 Example:  "MAL"
object
 
Array of objects
Checking accounts associated with the financial institution.


 
 Array 
key
string
 
 Example:  "2"
object
 
requestedStartDate
string <date> 
 
 Example:  "2021-01-23"
Array of objects
Savings accounts associated with the financial institution.


 
 Array 
key
string
 
 Example:  "2"
object
 
requestedStartDate
string <date> 
 
 Example:  "2021-01-23"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "id": "FinInst-BOA",
  • "checkingAccounts": [
    • {
      • "key": "99",
      • "externalBankAccount": {
        },
      • "requestedStartDate": "2021-01-23"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "96",
    • "href": "/objects/cash-management/financial-institution/96"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a financial institution
delete/objects/cash-management/financial-institution/{key}
Deletes a financial institution.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the financial institution.


 
 Example:  109
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query financial institutions
post/services/core/query
Use the query service to find financial institutions that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples