EndPoint
HTTP Method: PUT
Path: {{baseUrl}}
/amlyze-ws-rest/batch-account-balances
ContentType: application/json
Authorization: Basic Auth
/Bearer Token
The minimalistic request example below shows the minimum required fields to successfully add an account.
API requests example
Show Mandatory fields example | ACCOUNT BALANCE import - BATCH
{
"accountBalances" : [
{
"communicationNumber" : "commNumber0" ,
"requester" : "financial_institution" ,
"balanceType" : "DAILY_BALANCE" ,
"accountExtId" : "accountExtId0" ,
"businessUnit" : "businessUnit0" ,
"balanceAt" : "2023-09-05T08:07:34.605Z" ,
"value" : 11111111111.00 ,
"equivalentValue" : 33333.00
},
{
"communicationNumber" : "commNumber1" ,
"requester" : "financial_institution" ,
"balanceType" : "DAILY_BALANCE" ,
"accountExtId" : "accountExtId1" ,
"businessUnit" : "businessUnit1" ,
"balanceAt" : "2023-09-05T08:07:34.605Z" ,
"value" : 11111111111.00
}
]
}
Fields
The data documentation can be found here.
List of possible responses
Show Mandatory fields example | ACCOUNT BALANCE import - BATCH
200 OK
{
"results" : [
{
"resultType" : "REQUEST_ACCEPTED" ,
"communicationNumber" : "commNumber0" ,
"accountExtId" : "accountExtId0" ,
"businessUnit" : "businessUnit0" ,
"timeElapsedMs" : 203
},
{
"resultType" : "REQUEST_REJECTED" ,
"communicationNumber" : "CommNumber1" ,
"accountExtId" : "accountExtId1" ,
"businessUnit" : "businessUnit1" ,
"errorCode" : "O005" ,
"errorDescription" : "CommunicationNumber already used in amlyze" ,
"timeElapsedMs" : 20
},
],
"timeElapsedMs" : 223
}
404 Not Found
{
"timestamp" : "2024-05-26T16:49:50.237+00:00" ,
"status" : 404 ,
"error" : "Not Found" ,
"path" : "/amlyze-ws-rest/batch-account-balances" //--> 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