HTTP Method: PUT Path: {{baseUrl}}/amlyze-ws-rest/account-balance ContentType: application/json Authorization: Bearer Token

API requests example

Fields

communicationNumber
string(256)
required
Unique number of communication. It is used for risk assessment callback.Example: Test_ComNr_002mHzZZ
requester
string(100)
required
Name of the system requesting web service.Example: Amlyze
balanceType
string(255) from classifier list
required
Type of balance type.Example: DAILY_BALANCE
accountExtId
string(255)
required
External account identification number used to track activity regarding the specific account.Example: ACC_001
businessUnit
string(255) 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

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