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 
Response samples 
{
  • "id": "string",
  • "timestamp": "string",
  • "message": "string",
  • "error": "string",
  • "path": "string",
  • "status": 0
}
Create Bank Account Storage
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 
application/json
{
  • "name": "string",
  • "dataTransformationId": "string"
}
Response samples 
{
  • "id": "72d6900fce6b326088f5d9d91049e3e6",
  • "name": "string",
  • "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "organizationId": "cdq_monitor",
  • "createdBy": "76248934691294444",
  • "createdAt": "2020-08-31T16:47+00:00",
  • "modifiedAt": "2020-08-31T16:47+00:00",
  • "modifiedBy": "76248934691294444",
  • "dataTransformationId": "string"
}
Delete Bank Account Storage
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 
Poll upsert bank accounts status WSDL 
SecurityapiKey 
Request 
path Parameters
taskId
required
string^[a-fA-F0-9]{24}$
id of the task


 
 Example:  652697d8eb91545eb14e64e6
Responses 
200
OK


400
Bad Request


get/v2/bankaccounts/tasks/{taskId}
Request samples 
Response samples 
application/json
{
  • "status": "STARTED"
}
Read Bank Account Storage
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 
Response samples 
{
  • "id": "72d6900fce6b326088f5d9d91049e3e6",
  • "name": "string",
  • "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "organizationId": "cdq_monitor",
  • "createdBy": "76248934691294444",
  • "createdAt": "2020-08-31T16:47+00:00",
  • "modifiedAt": "2020-08-31T16:47+00:00",
  • "modifiedBy": "76248934691294444",
  • "dataTransformationId": "string"
}
Read bank accounts WSDL 
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
OK


400
Bad Request


get/bankaccountstorages/{storageId}/bankaccounts
Request samples 
Response samples 
application/json
{
  • "startAfter": "5712566172571652",
  • "limit": "100",
  • "total": "67",
  • "values": [
    ],
  • "nextStartAfter": "5712566172571652"
}
Update Bank Account Storage
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


 
Responses 
200
Updated


400
Bad Request


put/bankaccountstorages/{storageId}
Request samples 
application/json
{
  • "name": "string",
  • "dataTransformationId": "string"
}
Response samples 
{
  • "id": "72d6900fce6b326088f5d9d91049e3e6",
  • "name": "string",
  • "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "organizationId": "cdq_monitor",
  • "createdBy": "76248934691294444",
  • "createdAt": "2020-08-31T16:47+00:00",
  • "modifiedAt": "2020-08-31T16:47+00:00",
  • "modifiedBy": "76248934691294444",
  • "dataTransformationId": "string"
}
Upsert Bank Accounts WSDL 
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
OK


400
Bad Request


put/bankaccountstorages/{storageId}/bankaccounts
Request samples 
application/json
{
  • "bankAccounts": [
    ]
}
Response samples 
application/json
{
  • "taskId": "string"
}
Upsert Raw Bank Accounts WSDL 
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
OK


400
Bad Request


put/bankaccountstorages/{storageId}/bankaccounts/rawdata
Request samples 
application/json
{
  • "bankAccounts": [
    ]
}
Response samples 
application/json
{
  • "taskId": "string"
}