Developer Center

Data Dictionary and API Standards

Last Updated: Jul 02, 2018 11:58AM CEST

Data Structures & Enums

To dig deeply into all the possible data types, structure and meaning of enumerated values which can be returned, we suggest reviewing our V5 Data DictionaryV6 Data Dictionary or V7 Data Dictionary document which fully describes all publicly accessible objects, their relationships and their fields

Dates

For date values Mambu uses the ISO 8601 standard. Date values are returned in the "yyyy-MM-dd'T'HH:mm:ssZ" format, for example: "2011-09-26T00:00:00+0000". For data parameters without a time code the short version of the ISO 8601 standard: "yyyy-MM-dd" is used, for example "2011-09-26".

Please notice that Mambu stores date/time values without any timezone offset. The dates captured automatically by Mambu are stored in UTC date and time and the ones specified (or that can be specified) by the user are stored in the organization date and time. For further information, please consult our Data Dictionary files. If the short version of the ISO8601 standard is used, e.g. for birth dates, the timezone is assumed UTC and not the organisation's time zone. If the short version of the ISO8601 standard is used, e.g. for birth dates, the timezone is assumed UTC and not the organisation's time zone.

Numbers

All numeric values are trimmed for trailing zeroes. Mambu stores decimals in high-precision but a value such as "50.010000000" will be returned as simply "50.01" in the JSON response for brevity.

Identifiers

Resources in Mambu such as Clients & Products often may have two identifiers: IDs and encodedKeys. IDs are short codes based on a format either on a value defined explicitly (for products for example) or on a format for the organisation (for clients, accounts, etc). encodedKeys are the Primary UUID keys in the datastore and are unchangeable after the object has been created<

The APIs uses both ids and keys as the resource identifier.

Null Values

Null values are stripped from the responses. If a key is not found, it's value is null.

Pagination

List items are returned in the Mambu APIs with a default pagination limit of 50 and a max of 1000. Pagination can be specified using the "offset" and "limit" parameters for GET and POST requests as URL encoded parameters, which, when used returns a list. For example an offset of 5 and limit of 10 would retrieve items 6-15 in the list. The end of the list is reached when the request has less results than the limit or when an empty result array is returned.
// GET 5 savings accounts starting with the 24th resulted entry
GET /api/savings?branchId=2&limit=5&offset=24

// POST Search for the first 40 closed savings accounts
POST {
"filterConstraints":[
	  {
	     "filterSelection":"ACCOUNT_STATE",
	     "filterElement":"EQUALS",
	     "value":"CLOSED"
	  }
	]
} /api/savings/search?limit=40&offset=0
 

Rates

All rates (index, interest) are expressed as full numbers, not percentages. For example, an index rate of 10.50% is passed in JSON as 10.5. Example:
{
   "indexRate":{
      "rate":"10.5"
   }
}
support@mambu.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete