• 1. e-bak API Documentation
  • 1.1. Overview
  • 1.2. Environments
  • 1.3. Response Codes & Error Handling
    • 1.3.1. Standard HTTP Response Codes
  • 1.4. Error Response Structure
  • 1.5. Authentication & Authorization
    • 1.5.1. User Authentication
    • 1.5.2. Obtaining an Access Token
    • 1.5.3. Using the Token
    • 1.5.4. Token Expiration and Renewal
  • 1.6. API Endpoints
    • 1.6.1. Ping
    • 1.6.2. Login
    • 1.6.3. Common models
    • 1.6.4. Debt Retrieval by Estate
    • 1.6.5. Debt Retrieval by Owner Unique Identifier
    • 1.6.6. Debt Commission Calculation
    • 1.6.7. Debt Payment
    • 1.6.8. Search Cities
    • 1.6.9. Search Condominium Association
    • 1.6.10. Search Buildings
    • 1.6.11. Search Districts
    • 1.6.12. Search Estates
  • 1.7. Contributing
  • 1.8. Issues and Support
  • 1.9. Stay Updated

1. e-bak API Documentation

1.1. Overview

The e‑bak API provides secure, programmatic access to condominium‑fee debt retrieval and payment services. Use these REST endpoints to:

• Query outstanding debts for a given estate or owner.
• Calculate commissions.
• Repay debts in bulk or individually.
• Discover reference data (cities, buildings, districts, estates).

Integrate these capabilities to streamline end‑user payments and accounting workflows.

Language Support: Requests should include an Accept-Language header with a supported ISO language code. Valid options include:

• en-US for English (US)
• hy-AM for Armenian (default if none specified or invalid)
• ru-RU for Russian

1.2. Environments

Environment	Base URL	Swagger	Scalar UI
Test	https://qabe-ca.pandatech.it	{Base URL}/swagger/integration	{Base URL}/scalar/integration
Prod	https://be.e-bak.am	Not exposed	Not exposed

Switch to Production only after your integration passes all tests.

1.3. Response Codes & Error Handling

1.3.1. Standard HTTP Response Codes

Code	Description
200	Request succeeded.
202	Request accepted (e.g. order enqueued).
400	Invalid request parameters or duplicate requests.
401	Authentication failed.
403	Insufficient permissions.
404	Resource not found.
500	Server encountered an unexpected error.

1.4. Error Response Structure

All errors are returned in a standard JSON format to help with troubleshooting:

{
  "RequestId": "Unique request ID",
  "TraceId": "Unique trace ID",
  "Instance": "Contextual API information",
  "StatusCode": 400,
  "Type": "Short error descriptor (e.g. BadRequestException)",
  "Errors": {
    "field": "Error message"
  },
  "Message": "General error description"
}

Key points:

• Use the RequestId and TraceId when contacting support.
• The Errors property gives field-specific details.
• The Instance field offers additional context for the operation.

1.5. Authentication & Authorization

Valid user credentials and an access token are required to interact with most endpoints.

1.5.1. User Authentication

Obtain and securely store user credentials. You must have a valid user account to request a token.

1.5.2. Obtaining an Access Token

Make a POST request to /api/v1/integration/login with your credentials. A successful response includes an accessToken and an expirationDate.

1.5.3. Using the Token

Include the token in the Authorization header for subsequent requests. Tokens refresh automatically with each successful API call, so active usage extends token validity.

1.5.4. Token Expiration and Renewal

If you receive a 401 Unauthorized error, your token may have expired. Re-authenticate via /api/v1/integration/login to obtain a new token before retrying your request.

1.6. API Endpoints

1.6.1. Ping

• Endpoint: GET /above-board/ping
• Description: Checks connectivity
• Response: "pong"

1.6.2. Login

• Endpoint: POST /api/v1/integration/login
• Description: Authenticates a user and returns an access token.
• Request:

  {
    "login": "[email protected]",
    "password": "Qwerty123!"
  }
  

• Response:

  {
    "accessToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "expirationDate": "2023-12-21T08:34:20.996Z"
  }
  

1.6.3. Common models

Estate Type Enum

public enum EstateTypes
{
   Apartment = 0, //Բնակարան
   CommercialArea = 1, //Կոմերցիոն տարածք
   ParkingArea = 2, //Կայանման տարածք
   Basement = 3, //Նկուղ
   House = 4, //Տուն
   Other = 5, //Այլ
   Elevator = 6, //Վերելակ
   SolarStation = 7 //Արևային կայան
}

Check Commission Enum

public enum CheckCommission
{
   Yes = 1,
   No = 2
}

1.6.4. Debt Retrieval by Estate

• Endpoint: GET /api/v4/integration/debts/{estateId}
• Description: Retrieves all outstanding debts for a given estate.
• Note:
• Response:

  {
    "partnerId": 8,
    "partnerName": "Անուն Ազգանուն",
    "estateId": 1000270,
    "estateType": 5,
    "estateAddress": "Գյուլբենկյան 33, 1",
    "primaryEstateOwnerFullName": "Անուն Ազգանուն",
    "checkCommission": 1,
    "balance": -4900,
    "debts": [
      {
        "debtId": 75,
        "balance": -4900,
        "date": "2024-04-01T00:00:00Z"
      }
    ]
  }
  

  primaryEstateOwnerFullName may be null if not available

1.6.5. Debt Retrieval by Owner Unique Identifier

• Endpoint: GET /api/v4/integration/debts/owner/{uniqueDocumentId}
• Description: Retrieves all outstanding debts associated with an owner identified by SSN or Tax Code.
• Response:

  {
    "estates": [
      {
        "partnerId": 8,
        "partnerName": "Անուն Ազգանուն",
        "estateId": 1000270,
        "estateType": 3,
        "estateAddress": "Գյուլբենկյան 1, 1",
        "primaryEstateOwnerFullName": "Անուն Ազգանուն",
        "checkCommission": 1,
        "balance": -5000,
        "debts": [
          {
            "debtId": 1,
            "balance": -4900,
            "date": "2024-04-01T00:00:00Z"
          },
          {
            "debtId": 20,
            "balance": -100,
            "date": "2024-04-01T00:00:00Z"
          }
        ]
      },
      {
        "partnerId": 8,
        "partnerName": "Անուն Ազգանուն",
        "estateId": 1000271,
        "estateType": 0,
        "estateAddress": "Գյուլբենկյան 2, 1",
        "primaryEstateOwnerFullName": "Անուն Ազգանուն",
        "checkCommission": 1,
        "balance": -15000,
        "debts": [
          {
            "debtId": 7,
            "balance": -8000,
            "date": "2024-04-01T00:00:00Z"
          },
          {
            "debtId": 5,
            "balance": -7000,
            "date": "2024-04-01T00:00:00Z"
          }
        ]
      },
      {
        "partnerId": 8,
        "partnerName": "Անուն Ազգանուն",
        "estateId": 1000272,
        "estateType": 4,
        "estateAddress": "Գյուլբենկյան 2, 1",
        "primaryEstateOwnerFullName": "Անուն Ազգանուն",
        "checkCommission": 2,
        "balance": 0,
        "debts": []
      }
    ]
  }
  

  primaryEstateOwnerFullName may be null if not available

1.6.6. Debt Commission Calculation

• Endpoint: POST /api/v2/integration/debts/commission
• Description: Calculates commissions for the specified debts.
• Request:

  [
    {
      "estateId": 1000182,
      "amount": 1000,
      "debtId": null
    }
  ]
  

• Response:

  {
    "commission": 10
  }
  

1.6.7. Debt Payment

• Path: POST /api/v2/integration/debts/payments

• Description: Repays debts (FIFO unless debtId specified). The call is idempotent when accompanied by a unique outerPaymentId.

• Request

  {
    "debtPaymentRequestModels": [
      {
        "estateId": 1654896,
        "amount": 452.25,
        "debtId": 24
      }
    ],
    "outerPaymentId": "9c98610b‑1cd3‑4f12‑83e2‑2a0b86ff4c2e",
    "commission": 10
  }
  

• Response (200 OK)

  {
    "transactions": [
      {
        "estateId": 1654896,
        "debtId": 42,
        "amount": 452.25,
        "transactionId": 443,
        "date": "2023-10-18T11:21:43.757Z",
        "bank": "Ameriabank",
        "bankAccount": "1500016548794561"
      }
    ],
    "outerPaymentId": "9c98610b‑1cd3‑4f12‑83e2‑2a0b86ff4c2e",
    "commission": 10
  }
  

• Response Duplicate request (400 Bad Request)

  {
    "RequestId": "Unique request ID",
    "TraceId": "Unique trace ID",
    "Instance": "Contextual API information",
    "StatusCode": 400,
    "Type": "BadRequestException",
    "Errors": null,
    "Message": "transaction_already_processed"
  }
  

  Handle this response as a success.
  It confirms the original payment was processed; do not retry with a different outerPaymentId or charge the user again.

Bank Enum Values:

public enum Bank
{
   AcbaBank = 0,
   AraratBank = 1,
   Ameriabank = 2,
   AmioBank = 3,
   IDBank = 4,
   Ardshinbank = 5,
   Armswissbank = 6,
   Artsakhbank = 7,
   BiblosBankArmenia = 8,
   Evocabank = 10,
   Inecobank = 11,
   ConverseBank = 12,
   Armeconombank = 13,
   MellatBank = 14,
   Unibank = 15,
   VTBArmeniaBank = 16,
   FastBank = 17
}

1.6.8. Search Cities

• Endpoint: GET /api/v2/integration/search/cities
• Description: Retrieves all cities that have buildings.
• Request: https://qabe-ca.pandatech.it/api/v2/integration/search/cities
• Response:

  {
    "values": [
      {
        "id": 1,
        "name": "Երևան"
      },
      {
        "id": 2,
        "name": "Աբովյան"
      },
      {
        "id": 3,
        "name": "Ագարակ"
      },
      {
        "id": 4,
        "name": "Ալավերդի"
      }
    ]
  }
  

1.6.9. Search Condominium Association

• Endpoint: GET /api/v3/integration/search/condominium-associations?cityId={cityId}&Page={page}&PageSize={pageSize}
• Description: Retrieves condominium associations filtered by city, with pagination.
• Request: https://qabe-ca.pandatech.it/api/v3/integration/search/condominium-associations?cityId=1&Page=1&PageSize=4
• Response:

  {
    "values": [
      {
        "id": 1,
        "name": "A LLC"
      },
      {
        "id": 2,
        "name": "B LLC"
      },
      {
        "id": 3,
        "name": "C LLC"
      }
    ],
    "totalCount": 78
  }
  

1.6.10. Search Buildings

• Endpoint: GET /api/v2/integration/search/buildings...
• Description: Retrieves buildings based on one of the following filters: PartnerId, CityId, or DistrictId. At least one of these parameters is required. Also supports pagination.
• Request Examples:
  1. https://qabe-ca.pandatech.it/api/v2/integration/search/buildings?PartnerId=1&Page=1&PageSize=1
  2. https://qabe-ca.pandatech.it/api/v2/integration/search/buildings?CityId=1&Page=1&PageSize=1
  3. https://qabe-ca.pandatech.it/api/v2/integration/search/buildings?DistrictId=1&Page=1&PageSize=1
• Response:

  {
    "values": [
      {
        "id": 3,
        "address": "Tumanyan 27"
      }
    ],
    "totalCount": 746
  }
  

1.6.11. Search Districts

• Endpoint: GET /api/v1/integration/search/districts?CityId={cityId}
• Description: Retrieves all districts within city.
• Request: Retrieves districts in a given city.
• Response:

  {
    "values": [
      {
        "id": 13548785,
        "name": "Arabkir"
      }
    ]
  }
  

1.6.12. Search Estates

• Endpoint: GET /api/v2/integration/search/estates
• Description: Retrieves estates within a specific building, including estate types and pagination.
• Request: https://qabe-ca.pandatech.it/api/v2/integration/search/estates?BuildingId=1&Page=1&PageSize=1
• Response:

  {
    "values": [
      {
        "type": 0,
        "id": 13548785,
        "address": "21/2"
      }
    ],
    "totalCount": 150
  }
  

1.7. Contributing

We welcome contributions and improvements to this documentation. Submit a pull request or open an issue for suggestions.

1.8. Issues and Support

For issues or support inquiries, use the repository's “Issues” section. Our team will respond to help resolve your problem.

1.9. Stay Updated

We regularly update this documentation. Check the repository for the latest changes, new features, and improvements.

---

Thank you for using PandaTech's APIs! We hope this documentation helps you in your development journey.