Check the status of a task that is inserting or updating bank accounts in the system.
OK
Bad Request
{- "status": "FINISHED"
}
Display the details of a specific bank account storage identified by its storage ID.
Found
Bad Request
{- "id": "72d6900fce6b326088f5d9d91049e3e6",
- "name": "Custom Bank Account Name",
- "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
- "organizationId": "cdq_monitor",
- "createdBy": "76248934691294444",
- "createdAt": "2024-09-06T20:43:28Z",
- "modifiedAt": "2024-09-06T20:43:28Z",
- "modifiedBy": "76248934691294444",
- "dataTransformationId": "72d6900fce6b326088f5d9d91049e3e6",
- "sharingToWhitelist": "true"
}
Read bank accounts from a bank account storage in batches.
OK
Bad Request
{- "startAfter": "5712566172571652",
- "limit": "100",
- "total": "67",
- "values": [
- {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "nationalBankAccountIdentifier": "619278412000",
- "payees": [
- {
- "externalId": "The ID managed in the customer's SAP systems.",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "dataSourceId": "648824a691d8d2503d65103e"
}
], - "bank": {
- "cdqId": "CDQID-1234567890",
- "name": [
- {
- "shortName": "SNB",
- "type": {
- "name": "Bank name acronym",
- "technicalKey": "BANK_NAME_TYPE_ACRONYM"
}, - "value": "Swiss National Bank",
- "version": {
- "charset": {
- "name": null,
- "technicalKey": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
}
], - "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankIdentifier": "00781",
- "address": {
- "version": {
- "characterSet": {
- "name": "International",
- "technicalKey": "INTERNATIONAL"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}, - "identifyingName": {
- "value": "John Doe"
}, - "externalId": "1",
- "metadata": {
- "primaryProvenance": {
- "name": "VIES",
- "technicalKey": "VIES",
- "cdqId": "VIES:PL8660001429"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}, - "careOf": {
- "value": "CDQ GmbH c/o Product Department"
}, - "contexts": [
- {
- "value": "Production hall 7, Storage field 8."
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": "Sankt Gallen",
- "shortName": "SG",
- "fipsCode": "SZ15",
- "isoCode": "CH-SG",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
], - "postCodes": [
- "9000"
], - "localities": [
- {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "St. Gallen",
- "value": "Sankt Gallen",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "thoroughfares": [
- {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "Lukasstr. 4",
- "number": "4",
- "value": "Lukasstraße 4",
- "name": "Lukasstraße",
- "direction": "221-bis Baker Street, North",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "premises": [
- {
- "value": "Lukasstraße 4",
- "shortName": "Lukasstr. 4",
- "number": "4",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
], - "postalDeliveryPoints": [
- {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "St Gallen, Postfach 460",
- "number": "460",
- "value": "Postfach",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "openingHours": [
- {
- "openingHour": "09:00 AM",
- "closingHour": "05:00 PM",
- "weekday": "Monday"
}
], - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "types": [
- {
- "name": "Legal Address",
- "technicalKey": "LEGAL_ADDRESS"
}
], - "formattedAddress": {
- "country": "Switzerland",
- "administrativeArea": "Sankt Gallen",
- "region": "Sankt Gallen",
- "regionCode": "9004",
- "locality": "Sankt Gallen",
- "district": "City center",
- "postalCode": "9000",
- "thoroughfare": "Lukassstrasse",
- "premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
- "interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
- "mailbox": "Postfach 460",
- "postOfficeBox": "Postfach 460"
}
}
}, - "vendorPaymentSummary": {
- "firstPaymentDate": "2024-09-06T20:43:28Z",
- "lastPaymentDate": "2024-09-06T20:43:28Z",
- "numberOfPayments": "1"
}
}
], - "nextStartAfter": "5712566172571652"
}
Modify the details of an existing bank account storage identified by its storage ID.
Updated
Bad Request
{- "name": "Custom Bank Account Name",
- "dataTransformationId": "72d6900fce6b326088f5d9d91049e3e6",
- "sharingToWhitelist": "true"
}
{- "id": "72d6900fce6b326088f5d9d91049e3e6",
- "name": "Custom Bank Account Name",
- "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
- "organizationId": "cdq_monitor",
- "createdBy": "76248934691294444",
- "createdAt": "2024-09-06T20:43:28Z",
- "modifiedAt": "2024-09-06T20:43:28Z",
- "modifiedBy": "76248934691294444",
- "dataTransformationId": "72d6900fce6b326088f5d9d91049e3e6",
- "sharingToWhitelist": "true"
}
Upsert bank accounts into a bank account storage in batches. Maximum of 1000 bank accounts are allowed per batch.
OK
Bad Request
{- "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "nationalBankAccountIdentifier": "619278412000",
- "payees": [
- {
- "externalId": "The ID managed in the customer's SAP systems.",
- "storageId": "72d6900fce6b326088f5d9d91049e3e6",
- "dataSourceId": "648824a691d8d2503d65103e"
}
], - "bank": {
- "cdqId": "CDQID-1234567890",
- "name": [
- {
- "shortName": "SNB",
- "type": {
- "name": "Bank name acronym",
- "technicalKey": "BANK_NAME_TYPE_ACRONYM"
}, - "value": "Swiss National Bank",
- "version": {
- "charset": {
- "name": null,
- "technicalKey": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
}
], - "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankIdentifier": "00781",
- "address": {
- "version": {
- "characterSet": {
- "name": "International",
- "technicalKey": "INTERNATIONAL"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}, - "identifyingName": {
- "value": "John Doe"
}, - "externalId": "1",
- "metadata": {
- "primaryProvenance": {
- "name": "VIES",
- "technicalKey": "VIES",
- "cdqId": "VIES:PL8660001429"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}, - "careOf": {
- "value": "CDQ GmbH c/o Product Department"
}, - "contexts": [
- {
- "value": "Production hall 7, Storage field 8."
}
], - "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": "Sankt Gallen",
- "shortName": "SG",
- "fipsCode": "SZ15",
- "isoCode": "CH-SG",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
], - "postCodes": [
- "9000"
], - "localities": [
- {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "St. Gallen",
- "value": "Sankt Gallen",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "thoroughfares": [
- {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "Lukasstr. 4",
- "number": "4",
- "value": "Lukasstraße 4",
- "name": "Lukasstraße",
- "direction": "221-bis Baker Street, North",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "premises": [
- {
- "value": "Lukasstraße 4",
- "shortName": "Lukasstr. 4",
- "number": "4",
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "language": {
- "name": null,
- "technicalKey": null
}
}
], - "postalDeliveryPoints": [
- {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "St Gallen, Postfach 460",
- "number": "460",
- "value": "Postfach",
- "language": {
- "name": null,
- "technicalKey": null
}
}
], - "openingHours": [
- {
- "openingHour": "09:00 AM",
- "closingHour": "05:00 PM",
- "weekday": "Monday"
}
], - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "types": [
- {
- "name": "Legal Address",
- "technicalKey": "LEGAL_ADDRESS"
}
], - "formattedAddress": {
- "country": "Switzerland",
- "administrativeArea": "Sankt Gallen",
- "region": "Sankt Gallen",
- "regionCode": "9004",
- "locality": "Sankt Gallen",
- "district": "City center",
- "postalCode": "9000",
- "thoroughfare": "Lukassstrasse",
- "premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
- "interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
- "mailbox": "Postfach 460",
- "postOfficeBox": "Postfach 460"
}
}
}, - "vendorPaymentSummary": {
- "firstPaymentDate": "2024-09-06T20:43:28Z",
- "lastPaymentDate": "2024-09-06T20:43:28Z",
- "numberOfPayments": "1"
}
}
]
}
{- "taskId": "dc172630-5791-11ee-8c99-0242ac120002"
}
Upsert bank accounts into a bank account storage in batches. Maximum of 1000 bank accounts are allowed per batch.
OK
Bad Request
{- "bankAccounts": [
- {
- "rawData": { }
}
]
}
{- "taskId": "dc172630-5791-11ee-8c99-0242ac120002"
}