Account balance registration

Will be soon.

HTTP Method: POST

Path: {{baseUrl}}/amlyze-ws-rest/account-balance

ContentType: application/json

Authorization: Bearer Token

API requests example

{
  "communicationNumber": "COM216a",
  "requester": "financial_institution",
  "balanceType": "DAILY_BALANCE",
  "accountExtId": "any_account_ext_id_1232",
  "businessUnit": "BU_1",
  "balanceAt": "2023-09-05T08:07:34.605Z",
  "value": 11111111111.00,
  "equivalentValue": 33333.00
}

Fields

Additional fields will be added.

communicationNumber

string

required

Unique number of communication. It is used for risk assessment callback. This field can store up to 256 characters.

Example: Test_ComNr_002mHzZZ

requester

string

required

Name of the system requesting web service.

Example: Amlyze

balanceType

string from classifier list

required

Type of balance type.

Example: DAILY_BALANCE

accountExtId

string

required

External account identification number used to track activity regarding the specific account.

Example: ACC_001

businessUnit

string from classifier list

❗Mandatory field for clients utilizing a multi-organizational solution. Omit this parameter unless instructed about it.

It serves to specify the unique identifier for the business unit. Business units are logical groupings of users and data. Each business unit can have its own set of users, permissions, and data access rules.

Example: BUSINESS_UNIT_NAME

balanceAt

Timestamp RFC 3339 (ISO 8601)

Balance datetime.

Example: 2024-05-26T16:49:50.237

value

BigDecimal

Balance value.

Example: 100000.5665

equivalentValue

BigDecimal

Equivalent balance value.

Example: 33333.5665

List of possible responses

lines
200 OK
{
  "resultType": "REQUEST_ACCEPTED"
}

400 Bad Request
{
  "resultType": "REQUEST_REJECTED",
  "errorCode": "O001",
  "errorDescription": "extId is mandatory"
}

404 Not Found
{
  "timestamp": "2024-05-26T16:49:50.237+00:00",
  "status": 404,
  "error": "Not Found",
  "path": "/amlyze-ws-rest/account-balance" //--> mistake inside the endpoint
}

500 Internal Server Error
{
  "resultType": "REQUEST_REJECTED",
  "status": 500,
  "error": "Internal Server Error"
}

List of possible errors

This section lists the possible errors that can occur when making a bad account request to the API. A bad request is a request that somehow does not follow the API specifications.

Error Description
extId is mandatory
code is mandatory

API Documentation

​API requests example

​Fields

​List of possible responses

​List of possible errors

API requests example

Fields

List of possible responses

List of possible errors