This API provides services to validate and to confirm bank account data, and to manage payment fraud cases
Bankaccount Data API (2)
Overview
URL
Sebastian Kaczmarski
Languages
Servers
Mock server
https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/
Production SOAP
https://api.corporate-data-league.ch/bankaccount-data/soap/v2/
Production
https://api.corporate-data-league.ch/bankaccount-data/
Database Cleanup
Endpoints for cleaning up and resetting databases in test environments.
WARNING: These endpoints should ONLY be used in test/development environments. They permanently delete data and should never be exposed in production.
Use these endpoints to:
- Clear test data between test runs
- Reset database state for integration tests
- Clean up test fixtures
Operations
Bank Account Storages Management
Gather endpoints that provide functionalities for managing bank account storages. These functionalities include creating a new storage for bank account data, reading the details of a specific bank account storage identified by its storage ID, modifying the details of an existing bank account storage, deleting an existing bank account storage, and removing all bank account data from a specific storage.
Operations
Bank Account Verification
Gather endpoints that provide functionalities for verifying bank account data. These functionalities include confirming the reliability of given bank account data by CDL Trust Scores provided by other companies for the given bank account, curating the given bank account, and uploading bank accounts for batch confirmation.
Operations
Bank Accounts
Gather endpoints that provide functionalities for managing bank accounts. These functionalities include reading bank account data, upserting bank account data, deleting bank account data, creating a new data source, reading all data sources, reading a data source by ID, and deleting a data source by ID.
Operations
Bodyapplication/jsonrequired
Identifies a previously uploaded CSV file with bank accounts to import. If the data transformation definition ID is provided, it will override the one defined in the storage and use it in the job.
-> Url received in response from request to /files/upload endpoint. It is a file name of file uploaded to the storage with bank account data.
Example: "bankaccountdata.csv"
Feature(s) to be used during the import job:
CLEAR_STORAGE- Removes all existing data in the storage before the file is imported.
| Items Enum Value | Description |
|---|---|
| CLEAR_STORAGE | Removes all existing data in the storage before the file is imported. |
| MERGE_PAYMENTS | Consolidate transactions into bank accounts. |
Example: ["CLEAR_STORAGE"]
- Mock server
https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/bankaccountstorages/{storageId}/import
- Production SOAP
https://api.corporate-data-league.ch/bankaccount-data/soap/v2/public/bankaccountstorages/{storageId}/import
- Production
https://api.corporate-data-league.ch/bankaccount-data/public/bankaccountstorages/{storageId}/import
curl -i -X POST \
https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/bankaccountstorages/652697d8eb91545eb14e64e6/import \
-H 'Content-Type: application/json' \
-d '{
"url": "bankaccountdata.csv",
"featuresOn": [
"CLEAR_STORAGE"
],
"dataTransformationDefinitionId": "72d6900fce6b326088f5d9d91049e3e6"
}'Bank account import job started
Unique identifier of the Bank Account Storage. Workspace could have only one Bank Account Storage.
Example: "72d6900fce6b326088f5d9d91049e3e6"
Date of modification (ISO 8601-compliant).
Example: "2020-08-31T16:47+00:00"
Additional information to explain the status.
Example: "The job failed because storage is empty."
Response
application/json
{ "id": "72d6900fce6b326088f5d9d91049e3e6", "createdBy": "76248934691294444", "createdAt": "2020-08-31T16:47+00:00", "modifiedAt": "2020-08-31T16:47+00:00", "progress": "77", "status": "RUNNING", "statusMessage": "The job failed because storage is empty.", "parameters": { "url": "bankaccountdata.csv", "featuresOn": [ … ], "dataTransformationDefinitionId": "72d6900fce6b326088f5d9d91049e3e6" } }
- Mock server
https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/bankaccountstorages/{storageId}/import/{id}
- Production SOAP
https://api.corporate-data-league.ch/bankaccount-data/soap/v2/public/bankaccountstorages/{storageId}/import/{id}
- Production
https://api.corporate-data-league.ch/bankaccount-data/public/bankaccountstorages/{storageId}/import/{id}
curl -i -X GET \
https://idp.cdq.com/_mock/apis/bankaccount-data-api/api-v2/public/bankaccountstorages/652697d8eb91545eb14e64e6/import/35f23c03-1c22-45fe-9484-3ffe769325deBank account import job results
Unique identifier of the Bank Account Storage. Workspace could have only one Bank Account Storage.
Example: "72d6900fce6b326088f5d9d91049e3e6"
Date of modification (ISO 8601-compliant).
Example: "2020-08-31T16:47+00:00"
Additional information to explain the status.
Example: "The job failed because storage is empty."
Response
application/json
{ "id": "72d6900fce6b326088f5d9d91049e3e6", "createdBy": "76248934691294444", "createdAt": "2020-08-31T16:47+00:00", "modifiedAt": "2020-08-31T16:47+00:00", "progress": "77", "status": "RUNNING", "statusMessage": "The job failed because storage is empty.", "parameters": { "url": "bankaccountdata.csv", "featuresOn": [ … ], "dataTransformationDefinitionId": "72d6900fce6b326088f5d9d91049e3e6" } }
Fraud Case Management
Gather endpoints that provide functionalities for managing fraud cases. These functionalities include creating a new fraud case, reading the details of a specific fraud case identified by its case ID, modifying the details of an existing fraud case, deleting an existing fraud case, and removing all fraud case data from a specific storage.
Operations
System Banks
Gather endpoints that provide functionalities for managing system banks. These functionalities include reading system banks, upserting system bank data, deleting system bank data, creating a new data source, reading all data sources, reading a data source by ID, and deleting a data source by ID.