Skip to main content
PUT
/
amlyze-ws-rest
/
account-balance
Update account balance
curl --request PUT \
  --url 'https://{{baseUrl}}/amlyze-ws-rest/account-balance' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "communicationNumber": "COM217",
  "requester": "financial_institution",
  "balanceType": "STATEMENT_BALANCE",
  "accountExtId": "ORG20231117550",
  "businessUnit": "sandbox",
  "balanceAt": "2023-09-05T08:07:34.605Z",
  "value": 11111111111,
  "equivalentValue": 33333
}
'
{
  "resultType": "REQUEST_ACCEPTED"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Account balance to register

accountExtId
string
required

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

balanceAt
string<date-time>
required

Balance datetime.

communicationNumber
string
required

Unique number of communication. It is used for risk assessment callback.

requester
string
required

Name of the system requesting web service.

Maximum string length: 100
value
number
required

Balance value.

balanceType
string

Type of account balance.

businessUnit
string

Mandatory field for clients utilizing a multi-organizational solution. 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.

equivalentValue
number

Equivalent balance value.

Response

OK

resultType
enum<string>
Available options:
REQUEST_ACCEPTED