Banks

The Bank APIs are used to retrieve information about the Banking network associated with your company codes and regions. The objects represent your Banks, Bank groups and Bank accounts.

1. Banks

This is an object representing your Banks. You can use it to retrieve properties about your bank name, bank identifier code, account number, location, and changes made.

Collections

curl --request GET \
     --url 'https://example.com/rest/api/bam/banks?page_number=1&page_size=50' \
     --header 'accept: application/json'

{
  "pageNumber": 1,
  "numberOfPages": 5,
  "pageSize": 50,
  "totalNumberOfElements": 240,
  "content": [
    {
      "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
      "businessId": "string",
      "name": "string",
      "bic": "string",
      "code": "string",
      "address": "Lange Str. 12",
      "zipCode": "string",
      "city": "string",
      "country": "BG",
      "changeTime": "2023-02-08T09:14:23.260Z"
    }
  ]
}

Items
After you have retrieved the list of available Banks, with a corresponding bankId, you can retrieve an item by appending the bankId in the URI.

Filters
You can apply filters in the request, to query based on businessId, name, bic, and bankCode. Custom fields and user groups associated with a bank object can also be retrieved.

2. Bank groups

This object is similar to the Banks object. Bank groups represent Banks that are grouped together by a property called name. You can retrieve properties about your bank name, bank identifier code, account number, location, and any changes that were made.

curl --request GET \
     --url 'https://example.com/rest/api/bam/bank-groups?page_number=1&page_size=50' \
     --header 'accept: application/json'

{
  "pageNumber": 1,
  "numberOfPages": 5,
  "pageSize": 50,
  "totalNumberOfElements": 240,
  "content": [
    {
      "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
      "name": "string",
      "businessId": "string",
      "address": "string",
      "postCode": "string",
      "city": "string",
      "country": "string",
      "language": "string",
      "changeTime": "2019-08-24T14:15:22Z",
      "banks": [
        {
          "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
          "businessId": "string",
          "name": "string",
          "bic": "string",
          "code": "string",
          "city": "string",
          "country": "BG",
          "changeTime": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ]
}

The object can also be retrieved as an item by appending the bankGroupId in the URI after it is retrieved from the bam/bank-groups endpoint. Filters can be applied in the request, to query based on name and businessId.

3. Bank accounts

This object represents your bank account(s) linked to a particular legal entity and/or Bank. You can retrieve properties about the account type, status, and more. You can make CRUD operations on a Bank account resource(s).

Adding bank account to TIS
You must include these three required parameters currency, bankId, and legalEntityId to add a bank account to your TIS account. There are 12 optional parameters.

curl --request POST \
     --url 'https://example.com/rest/api/bam/bank-accounts/' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
     "iban": null,
     "accountNumber": null,
     "subAccountNumber": null,
     "generalLedgerNumber": null,
     "mt940Identifier": null,
     "longDescription": null,
     "shortDescription": null,
     "changeable": true,
     "virtualAccount": false,
     "chargesAccountId": null
}
'

{
  "entityId": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
  "timestamp": "2019-08-24T14:15:22Z",
  "status": "PLACEHOLDER STATUS"
}

Retrieving a bank account
After a bank account is added to your TIS account, you can invoke the bam/bank-accounts API to retrieve, update and/or delete it by appending the bankAccountId in the URI.

curl --request GET \
     --url 'https://example.com/rest/api/bam/bank-accounts/bankAccountId' \
     --header 'accept: application/json'

{
  "pageNumber": 1,
  "numberOfPages": 5,
  "pageSize": 50,
  "totalNumberOfElements": 240,
  "content": [
    {
      "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
      "businessId": "string",
      "iban": "string",
      "accountNumber": "string",
      "currency": "AED",
      "accountType": "CHECKING",
      "subAccountNumber": "string",
      "generalLedgerNumber": "string",
      "mt940Identifier": "string",
      "longDescription": "string",
      "shortDescription": "string",
      "changeable": true,
      "virtualAccount": true,
      "status": "INACTIVE",
      "changeTime": "2023-02-08T09:14:23.260Z",
      "createTime": "2023-02-08T09:14:23.260Z",
      "bank": {
        "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
        "businessId": "string",
        "name": "string",
        "bic": "string",
        "code": "string",
        "city": "string",
        "country": "BG",
        "changeTime": "2023-02-08T09:14:23.260Z"
      },
      "chargesAccount": {
        "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
        "accountNumber": "string",
        "iban": "string",
        "currency": "BGN"
      },
      "legalEntity": {
        "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
        "businessId": "string",
        "name": "string",
        "country": "BG",
        "changeTime": "2023-02-08T09:14:23.260Z"
      },
      "customFields": [
        {
          "name": "string",
          "groupName": "string",
          "type": "BOOLEAN, CURRENCY_AMOUNT, DATE, EMAIL, FORMATED_TEXT, NUMERIC, TEXT, SELECTION_LIST",
          "required": true,
          "value": {
            "date": "2022-12-23",
            "checked": true,
            "amount": 43.67,
            "text": "Text value",
            "formattedText": "Formatted text value",
            "email": "[email protected]",
            "selectionListValue": "Selection list value",
            "currency": "AED"
          }
        }
      ]
    }
  ]
}

Collections
You can also retrieve a list of bank accounts by invoking the bam/bank-accounts endpoint. Optional filters can be applied based on several properties:

status
businessId
iban
accountNumber
bankBic
bankCode
legalEntityName.

Custom fields and user groups associated with a bank account object can be retrieved.