System Bank Data Sources

Gather endpoints that provide functionalities for managing system bank data sources. These functionalities include creating a new data source, reading all data sources, reading a data source by ID, and deleting a data source by ID.

Create Data Source

Create a new data source for the system bank data.

SecurityapiKey
Request
Request Body schema: application/json
dataTransformationId
string (DataTransformationId)

The ID of an existing data transformation, which will be used to transform raw records into bank accounts.

Example: "72d6900fce6b326088f5d9d91049e3e6"
name
string (BusinessPartnerStorageDataSourceName)

Name of a data source of a storage.

Example: "Internal customers"
type
string (AccessType)

Type of access to the data source.

Enum: Description
PRIVATE

Private access.

ORGANIZATION

Organization access.

Example: "PRIVATE"
Responses
200

OK

post/system/banks/datasources
Request samples
application/json
{
  • "name": "Internal customers",
  • "type": "PRIVATE",
  • "dataTransformationId": "72d6900fce6b326088f5d9d91049e3e6"
}
Response samples
application/json
{
  • "name": "Internal customers",
  • "dataTransformationId": "72d6900fce6b326088f5d9d91049e3e6",
  • "id": "648824a691d8d2503d65103e",
  • "createdAt": "2024-11-22T13:19:58Z",
  • "modifiedAt": "2024-11-22T13:19:58Z"
}

Delete Data Source

Delete a data source for bank data by ID.

SecurityapiKey
Request
path Parameters
id
required
string (BusinessPartnerStorageDataSourceId)

Data Source ID.

Example: 648824a691d8d2503d65103e
Responses
200

OK

delete/system/banks/datasources/{id}
Request samples 
Response samples 
application/json
{
  • "id": "CH1234567890123456789"
}
List Data Sources
List all data sources for the system bank data.


SecurityapiKey 
Request 
query Parameters
limit
integer <int32>   [ 1 .. 100 ] 
 Default:  50
Number of results that should be fetched. Maximum 100 results can be returned in one page.


 
 Example:  limit=50
startAfter
string
Indicator for the next page.


 
 Example:  startAfter=5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a
Responses 
200
OK


get/system/banks/datasources
Request samples 
Response samples 
application/json
{
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "limit": "100",
  • "values": [
    ]
}
Read Data Source
Read a data source for bank data by ID.


SecurityapiKey 
Request 
path Parameters
id
required
string (BusinessPartnerStorageDataSourceId) 
Data Source ID.


 
 Example:  648824a691d8d2503d65103e
Responses 
200
OK


get/system/banks/datasources/{id}
Request samples 
Response samples 
application/json
{
  • "name": "Internal customers",
  • "dataTransformationId": "72d6900fce6b326088f5d9d91049e3e6",
  • "id": "648824a691d8d2503d65103e",
  • "createdAt": "2024-11-22T13:19:58Z",
  • "modifiedAt": "2024-11-22T13:19:58Z"
}