Partners

Partners are part of the TIS Beneficiary address book and can be managed as global and local partners. This object represents legal entity and banking information about your partners.

Collections

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

{
  "page_number": 1,
  "numberOfPages": 5,
  "page_size": 50,
  "totalNumberOfElements": 240,
  "content": [
    {
      "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
      "businessId": "string",
      "name": "string",
      "branchCode": "string",
      "address": "Lange Str. 12",
      "zipCode": "string",
      "city": "string",
      "country": "US",
      "state": "string",
      "language": "AR_LB",
      "organizationId": "string",
      "privateId": "string",
      "taxId": "string",
      "active": true,
      "changeTime": "2019-08-24T14:15:22Z",
      "bankAccounts": [
        {
          "bank": {
            "name": "string",
            "bic": "string",
            "code": "string",
            "city": "string",
            "country": "BG"
          },
          "businessId": "string",
          "currency": "BGN",
          "iban": "string",
          "accountNumber": "string",
          "alternativeAccountHolder": "string",
          "shortDescription": "string",
          "changeTime": "2019-08-24T14:15:22Z",
          "correspondentBankAccounts": [
            {
              "bank": {
                "name": "string",
                "bic": "string",
                "code": "string",
                "city": "string",
                "country": "BG"
              },
              "currency": "BGN",
              "iban": "string",
              "accountNumber": "string",
              "alternativeAccountHolder": "string",
              "shortDescription": "string",
              "changeTime": "2019-08-24T14:15:22Z"
            }
          ]
        }
      ],
      "legalEntityRelations": [
        {
          "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
          "businessId": "string",
          "name": "string",
          "country": "BG",
          "changeTime": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ]
}

Items
After you have retrieved a list of available Partners with a corresponding partner "id", you can retrieve an item by appending the "id" in the partners URI bam/partners/{partnerId}.

Filters
Can be applied in the request to query based on:

status
businessId
partnerName
partnerCountry
bankAccountCountry
bankAccountIban
bankAccountNumber
bankAccountBic
bankAccountBankCode

Custom fields and user groups associated with a partners object can also be retrieved.