Bankaccount Data API (1)

Download OpenAPI specification:Download

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

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.

List Bank AccountsWSDL

List bank accounts from a bank account storage in batches.

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.

Example: limit=100
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"
}
Read Bank Account Storage
Display the details of a specific bank account storage identified by its storage ID.


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": "Custom Bank Account Name",
  • "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "organizationId": "cdq_monitor",
  • "createdBy": "76248934691294444",
  • "createdAt": "2024-12-21T01:35:24Z",
  • "modifiedAt": "2024-12-21T01:35:24Z",
  • "modifiedBy": "76248934691294444",
  • "dataTransformationId": "72d6900fce6b326088f5d9d91049e3e6",
  • "sharingToWhitelist": "true"
}
Update Bank Account Storage
Modify the details of an existing bank account storage identified by its storage ID.


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.


 
 Example:  "72d6900fce6b326088f5d9d91049e3e6"
name
string (BankAccountStorageName)   <= 50 characters 
Name of the bank account storage.


 
 Example:  "Custom Bank Account Name"
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 
application/json
{
  • "name": "Custom Bank Account Name",
  • "dataTransformationId": "72d6900fce6b326088f5d9d91049e3e6",
  • "sharingToWhitelist": "true"
}
Response samples 
{
  • "id": "72d6900fce6b326088f5d9d91049e3e6",
  • "name": "Custom Bank Account Name",
  • "workspaceId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "organizationId": "cdq_monitor",
  • "createdBy": "76248934691294444",
  • "createdAt": "2024-12-21T01:35:24Z",
  • "modifiedAt": "2024-12-21T01:35:24Z",
  • "modifiedBy": "76248934691294444",
  • "dataTransformationId": "72d6900fce6b326088f5d9d91049e3e6",
  • "sharingToWhitelist": "true"
}
Upsert Bank Accounts
Upsert bank accounts into 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": "dc172630-5791-11ee-8c99-0242ac120002"
}
Upsert Raw Bank Accounts
Upsert bank accounts into 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": "dc172630-5791-11ee-8c99-0242ac120002"
}