Bankaccount Data API (2.0)

Download OpenAPI specification:Download

Sebastian Kaczmarski: sebastian.kaczmarski@cdq.ch URL: https://www.cdq.ch/team

This API provides services to validate and to confirm bank account data, and to manage payment fraud cases

Bank Account Storages Management

Clear Bank Account Storage

Remove all bank accounts data from given storage.

SecurityapiKey

Request

path Parameters

storageId

required

string^[a-fA-F0-9]{24}$

Id of the bank account storage.

Example: 652697d8eb91545eb14e64e6

Responses

200

Cleared

400

Bad Request

post/bankaccountstorages/{storageId}/clear

Request samples

curl
Python
Java
Node.js

Response samples

{"id": "string",
"timestamp": "string",
"message": "string",
"error": "string",
"path": "string",
"status": 0
}

Create Bank Account Storage

SecurityapiKey

Request

Request Body schema: application/json
required

dataTransformationId	string (DataTransformationId) The ID of an existing data transformation, which will be used to transform raw records into bank accounts.
name	string (BankAccountStorageName) <= 50 characters Name of the bank account storage

Responses

200

Created

400

Bad Request

post/bankaccountstorages

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"name": "string",
"dataTransformationId": "string"
}

Response samples

{"id": "72d6900fce6b326088f5d9d91049e3e6",
"name": "string",
"workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"organizationId": "cdq_monitor",
"createdBy": "76248934691294444",
"createdAt": "2024-04-19T10:05:37Z",
"modifiedAt": "2024-04-19T10:05:37Z",
"modifiedBy": "76248934691294444",
"dataTransformationId": "string",
"sharingToWhitelist": true
}

Delete Bank Account Storage

SecurityapiKey

Request

path Parameters

storageId

required

string^[a-fA-F0-9]{24}$

Id of the bank account storage.

Example: 652697d8eb91545eb14e64e6

Responses

200

Deleted

delete/bankaccountstorages/{storageId}

Request samples

curl
Python
Java
Node.js

Poll upsert bank accounts statusWSDL

SecurityapiKey

Request

path Parameters

taskId

required

string^[a-fA-F0-9]{24}$

id of the task

Example: 652697d8eb91545eb14e64e6

Responses

200

400

Bad Request

get/v2/bankaccounts/tasks/{taskId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"status": "STARTED"
}

Read Bank Account Storage

SecurityapiKey

Request

path Parameters

storageId

required

string^[a-fA-F0-9]{24}$

Id of the bank account storage.

Example: 652697d8eb91545eb14e64e6

Responses

200

Found

400

Bad Request

get/bankaccountstorages/{storageId}

Request samples

curl
Python
Java
Node.js

Response samples

{"id": "72d6900fce6b326088f5d9d91049e3e6",
"name": "string",
"workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"organizationId": "cdq_monitor",
"createdBy": "76248934691294444",
"createdAt": "2024-04-19T10:05:37Z",
"modifiedAt": "2024-04-19T10:05:37Z",
"modifiedBy": "76248934691294444",
"dataTransformationId": "string",
"sharingToWhitelist": true
}

Read bank accountsWSDL

SecurityapiKey

Request

path Parameters

storageId

required

string^[a-fA-F0-9]{24}$

Id of the bank account storage.

Example: 652697d8eb91545eb14e64e6

query Parameters

limit	integer <int32> [ 1 .. 100 ] Default: 100 Number of results that should be fetched. Maximum 100 results can be returned in one page.
startAfter	string^[a-fA-F0-9]{24}$ Id of the first bank account. Example: startAfter=652697d8eb91545eb14e64e6

Responses

200

400

Bad Request

get/bankaccountstorages/{storageId}/bankaccounts

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"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": {"url": "https://meta.cdq.com/Bank_account/bank/name/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",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"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",
"url": "https://meta.cdq.com/Address/type",
"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-04-19T10:05:37Z",
"lastPaymentDate": "2024-04-19T10:05:37Z",
"numberOfPayments": "1"
}
}
],
"nextStartAfter": "5712566172571652"
}

Update Bank Account Storage

SecurityapiKey

Request

path Parameters

storageId

required

string^[a-fA-F0-9]{24}$

Id of the bank account storage.

Example: 652697d8eb91545eb14e64e6

Request Body schema: application/json
required

dataTransformationId	string (DataTransformationId) The ID of an existing data transformation, which will be used to transform raw records into bank accounts.
name	string (BankAccountStorageName) <= 50 characters Name of the bank account storage
sharingToWhitelist	boolean (SharingToWhitelist) Flag that indicates whether data from bank account storage is shared to whitelist. Example: true

Responses

200

Updated

400

Bad Request

put/bankaccountstorages/{storageId}

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"name": "string",
"dataTransformationId": "string",
"sharingToWhitelist": true
}

Response samples

{"id": "72d6900fce6b326088f5d9d91049e3e6",
"name": "string",
"workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"organizationId": "cdq_monitor",
"createdBy": "76248934691294444",
"createdAt": "2024-04-19T10:05:37Z",
"modifiedAt": "2024-04-19T10:05:37Z",
"modifiedBy": "76248934691294444",
"dataTransformationId": "string",
"sharingToWhitelist": true
}

Upsert Bank AccountsWSDL

Upsert bank accounts into a bank account storage in batches. Maximum of 1000 bank accounts are allowed per batch.

SecurityapiKey

Request

path Parameters

storageId

required

string^[a-fA-F0-9]{24}$

Id of the bank account storage.

Example: 652697d8eb91545eb14e64e6

Request Body schema: application/json
required

BusinessPartnersUpsertRequest

required

Array of objects (BankAccountV2) [ 1 .. 1000 ] items

Batch of bank accounts

Responses

200

400

Bad Request

put/bankaccountstorages/{storageId}/bankaccounts

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"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": {"url": "https://meta.cdq.com/Bank_account/bank/name/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",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"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",
"url": "https://meta.cdq.com/Address/type",
"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-04-19T10:05:37Z",
"lastPaymentDate": "2024-04-19T10:05:37Z",
"numberOfPayments": "1"
}
}
]
}

Response samples

application/json

{"taskId": "string"
}

Upsert Raw Bank AccountsWSDL

Upsert bank accounts into a bank account storage in batches. Maximum of 1000 bank accounts are allowed per batch.

SecurityapiKey

Request

path Parameters

storageId

required

string^[a-fA-F0-9]{24}$

Id of the bank account storage.

Example: 652697d8eb91545eb14e64e6

Request Body schema: application/json
required

BusinessPartnersUpsertRequest

required

Array of objects (RawBankAccountData) [ 1 .. 1000 ] items

Batch of bank accounts

Responses

200

400

Bad Request

put/bankaccountstorages/{storageId}/bankaccounts/rawdata

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"bankAccounts": [{"rawData": { }
}
]
}

Response samples

application/json

{"taskId": "string"
}

Bankaccount Data API (2.0)

Bank Account Storages Management

Clear Bank Account Storage

path Parameters

Create Bank Account Storage

Request Body schema: application/jsonrequired

Delete Bank Account Storage

path Parameters

Poll upsert bank accounts statusWSDL

path Parameters

Read Bank Account Storage

path Parameters

Read bank accountsWSDL

path Parameters

query Parameters

Update Bank Account Storage

path Parameters

Request Body schema: application/jsonrequired

Upsert Bank AccountsWSDL

path Parameters

Request Body schema: application/jsonrequired

Upsert Raw Bank AccountsWSDL

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required