Back | Public Strata API/bankTransactions
Update operation (PUT):
https://strata-<<REGION>>.urbanise.com/integrations/api/bankTransactionsThe <<REGION>> is determined by the location of the application you want to send the request to.
Regions include: AU (Australia & Asia), MENA (Middle East & Caribbean) & SA (South Africa)
Example: https://strata-au.urbanise.com
Request must consist of array of objects (1 object per property). The property is identified by the 'branchID'/'accountNo' pair.
In Australia, this would be the BSB for example. Numbers only, no special or alpha characters.
Bank account number. Numbers only, no special or alpha characters.
Array of transactions - []Each transaction object content should be as follows: (see Example Request below too)Date of the transaction. Format must be 'yyyy-MM-DD' (e.g. '2019-11-25').
If date format doesn't match, you will receive 400 Bad Request response without any details.
Reference/description for the transactions.
Reference/description for the transactions.
(!) N.B. Length restriction applies to these 2 fields (reference1 + reference2). Their total combined length must be 199 chars max!
The type of transaction, valid options are "DR" (for debit) and "CR" (for credits/deposits).
Amount of the transaction. Numeric format only. Positive values only. (eg: $1.00 = "1.00" - must contain 2 decimal places)
The following must be passed in the request header.
Content-Type : application/jsonAuthorization: Bearer <<token>>Note the authorization token must be obtained from Urbanise.
Below is an example of a request.
URL:https://strata-au.urbanise.com/integrations/api/bankTransactionsHeaders:Content-Type: application/jsonAuthorization: Bearer cf290305-c688-44c6-b248-a3352b19c51A[ { "branchID": "56556", "accountNo": "123456789", "transactions": [ { "date": "2018-07-17", "reference1": "Bank Interest", "reference2": "additional ref", "transType": "CR", "amount": "2.50" }, { "date": "2018-12-19", "reference1": "Energy Australia", "reference2": "", "transType": "DR", "amount": "500.02" } ] }, { "branchID": "984033", "accountNo": "987654321", "transactions": [ { "date": "2018-06-01", "reference1": "Levy Payment", "reference2": "ref 2", "transType": "CR", "amount": "152.50" }, { "date": "2018-07-10", "reference1": "Management Fees", "transType": "DR", "amount": "1500.00" } ] }]You can use the following JSON schema to roughly validate your request.
(! combined length of 'reference1' and 'reference2' fields is not part of the schema validation below !)
{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "/", "type": "array", "items": { "type": "object", "required": [ "branchID", "accountNo", "transactions" ], "properties": { "branchID": { "type": "string", "pattern": "^\\d+$" }, "accountNo": { "type": "string", "pattern": "^\\d+$" }, "transactions": { "type": "array", "items": { "type": "object", "required": [ "date", "reference1", "transType", "amount" ], "properties": { "date": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "reference1": { "type": "string", "pattern": "^(.*)$" }, "reference2": { "type": "string", "pattern": "^(.*)$" }, "transType": { "type": "string", "enum": [ "CR", "DR" ] }, "amount": { "type": "string", "pattern": "^[0-9]{1,}.[0-9]{2}$" } } } } } }}this can be done by using a tool like https://jsonschemalint.com/#/version/draft-07/markup/json or else per your discretion.