Mambu API v2

https://docs.mambu.com/api/pages/api-v2/
Admin
Mambu API v2 is a comprehensive REST API that enables developers to integrate with Mambu's cloud...
Tokens:22,260
Snippets:219
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### HTTP Request Example

Source: https://docs.mambu.com/api/pages/api-v2/requests

A basic HTTP request example demonstrating the structure of a GET request to a Mambu API resource.

```APIDOC
## HTTP Request Example

### Description
This example shows a raw HTTP GET request to a Mambu API endpoint. It specifies the host, the `Accept` header for API versioning, and the resource URI.

### Method
GET

### Endpoint
`https://TENANT_NAME.mambu.com/api/Insert-Resource-URI-here`

### Headers
- `Host`: `TENANT_NAME.mambu.com`
- `Accept`: `application/vnd.mambu.v2+json`
```

--------------------------------

### Basic Authentication with Go

Source: https://docs.mambu.com/api/pages/api-v2/authentication

Example of making a GET request using Basic Authentication with Go. Requires API access permissions and HTTPS.

```go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://TENANT_NAME.mambu.com/api/users"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Basic U29tZVVzZXI6T3BlblNlc2FtZQ==")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
```

--------------------------------

### Retrieve List of APIs using Go HTTP Client

Source: https://docs.mambu.com/api/pages/api-v2/oas-v2-discovery

A Go example demonstrating how to make an HTTP GET request to retrieve the list of APIs, including setting the Authorization header.

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"Basic <credentials>"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://TENANT_NAME.mambu.com/api/swagger/resources", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

--------------------------------

### Basic Authentication with Java (OkHttp)

Source: https://docs.mambu.com/api/pages/api-v2/authentication

Example of making a GET request using Basic Authentication with Java and OkHttp. Ensure the user has API access permissions and use HTTPS.

```java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://TENANT_NAME.mambu.com/api/users")
  .method("GET", null)
  .addHeader("Authorization", "Basic U29tZVVzZXI6T3BlblNlc2FtZQ==")
  .build();
Response response = client.newCall(request).execute();
```

--------------------------------

### Retrieve List of APIs using HTTP Request

Source: https://docs.mambu.com/api/pages/api-v2/oas-v2-discovery

An example of an HTTP GET request to the /api/swagger/resources endpoint, including necessary headers.

```http
GET https://TENANT_NAME.mambu.com/api/swagger/resources HTTP/1.1
Host: TENANT_NAME.mambu.com
Authorization: Basic <credentials>
```

--------------------------------

### Basic Authentication with Python

Source: https://docs.mambu.com/api/pages/api-v2/authentication

Example of making a GET request using Basic Authentication with Python's requests library. Requires API access permissions and HTTPS.

```python
import requests

url = "https://TENANT_NAME.mambu.com/api/users"

payload={}
headers = {
  'Authorization': 'Basic U29tZVVzZXI6T3BlblNlc2FtZQ=='
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
```

--------------------------------

### HTTP Request for Pagination

Source: https://docs.mambu.com/api/pages/api-v2/pagination

An example of an HTTP GET request with pagination parameters for the Mambu API. This shows the raw HTTP request structure.

```http
GET https://TENANT_NAME.mambu.com/api/Insert-Resource-URI-here?offset=10&limit=10&paginationDetails=ON HTTP/1.1
Host: TENANT_NAME.mambu.com

Accept: application/vnd.mambu.v2+json
```

--------------------------------

### Basic Authentication with Ruby

Source: https://docs.mambu.com/api/pages/api-v2/authentication

Example of making a GET request using Basic Authentication with Ruby's Net::HTTP library. Ensure the user has API access permissions and use HTTPS.

```ruby
require "uri"
require "net/http"

url = URI("https://TENANT_NAME.mambu.com/api/users")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Basic U29tZVVzZXI6T3BlblNlc2FtZQ=="

response = https.request(request)
puts response.read_body
```

--------------------------------

### GET Request with detailsLevel=FULL using HTTP

Source: https://docs.mambu.com/api/pages/api-v2/details-level

This snippet shows how to make a GET request with detailsLevel=FULL using raw HTTP. Replace `TENANT_NAME.mambu.com` and `{Insert Resource URI here}` with your specific details.

```http
GET https://TENANT_NAME.mambu.com/api/Insert-Resource-URI-here?detailsLevel=FULL HTTP/1.1
Host: TENANT_NAME.mambu.com

Accept: application/vnd.mambu.v2+json
```

--------------------------------

### Ruby REST Client with Pagination

Source: https://docs.mambu.com/api/pages/api-v2/pagination

Example of making a paginated Mambu API request using the Ruby 'rest-client' gem. Ensure you have the gem installed.

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/vnd.mambu.v2+json'
}

result = RestClient.{HTTP Verb} 'https://TENANT_NAME.mambu.com/api/{Insert resource URI here}?offset=10&limit=10&paginationDetails=ON',
  params: {
  },
 headers: headers
  
p JSON.parse(result)
```

--------------------------------

### Basic Authentication using cURL

Source: https://docs.mambu.com/api/pages/api-v2/authentication

Example of making a GET request to the /users endpoint using Basic Authentication with cURL. Ensure all requests use HTTPS.

```shell
curl --location --request GET 'https://TENANT_NAME.mambu.com/api/users' \
--header 'Authorization: Basic U29tZVVzZXI6T3BlblNlc2FtZQ=='
```

--------------------------------

### Making API Requests with wget

Source: https://docs.mambu.com/api/pages/api-v2/requests

An example of how to make an HTTP request using wget, specifying the host and accept header.

```http
GET https://TENANT_NAME.mambu.com/api/Insert-Resource-URI-here HTTP/1.1
Host: TENANT_NAME.mambu.com

Accept: application/vnd.mambu.v2+json
```

--------------------------------

### Basic Authentication with JavaScript (jQuery)

Source: https://docs.mambu.com/api/pages/api-v2/authentication

Example of making a GET request using Basic Authentication with JavaScript and jQuery. Requires a user account with API access permissions and HTTPS.

```javascript
var settings = {
  "url": "https://TENANT_NAME.mambu.com/api/users",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Basic U29tZVVzZXI6T3BlblNlc2FtZQ=="
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
```

--------------------------------

### GET Request with detailsLevel=FULL using Go

Source: https://docs.mambu.com/api/pages/api-v2/details-level

This Go snippet demonstrates making a GET request to the Mambu API with detailsLevel=FULL. It sets the Accept header and prepares for client execution. Replace `{HTTP Verb}` and `{Insert resource URI here}`.

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {
  
    headers := map[string][]string{
        "Accept": []string{"application/vnd.mambu.v2+json"},
  
    }
  
    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("{HTTP Verb}", "https://TENANT_NAME.mambu.com/api/{Insert resource URI here}?detailsLevel=FULL", data)
    req.Header = headers
  
    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

--------------------------------

### GET Request with Pagination

Source: https://docs.mambu.com/api/pages/api-v2/pagination

Demonstrates how to make a GET request to a Mambu API resource with pagination parameters. The `offset` parameter specifies the starting point, `limit` controls the number of items returned, and `paginationDetails=ON` can be used to include pagination details in the response headers.

```APIDOC
## GET /api/{Insert resource URI here}

### Description
Retrieves a list of resources with specified pagination controls.

### Method
GET

### Endpoint
`https://TENANT_NAME.mambu.com/api/{Insert resource URI here}?offset={offset}&limit={limit}&paginationDetails=ON`

### Query Parameters
- **offset** (integer) - Optional - The number of records to skip from the beginning.
- **limit** (integer) - Optional - The maximum number of records to return.
- **paginationDetails** (string) - Optional - Set to `ON` to include pagination details in the response headers.

### Request Example
```http
GET https://TENANT_NAME.mambu.com/api/some/resource?offset=10&limit=10&paginationDetails=ON
Accept: application/vnd.mambu.v2+json
```

### Response
#### Success Response (200)
Includes the requested resources. Response headers may contain pagination details if `paginationDetails=ON` was used.

- **items-limit** (integer) - The limit applied to the response.
- **items-offset** (integer) - The offset applied to the response.
- **items-total** (integer) - The total number of items available for the request.

#### Response Example
```json
{
  "example": "response body"
}
```

#### Response Headers Example
```http
content-type: application/vnd.mambu.v2+json
date: Mon, 03 Sep 2018 10:56:15 GMT
items-limit: 10
items-offset: 10
items-total: 35
```
```

--------------------------------

### Example API Resource List Response

Source: https://docs.mambu.com/api/pages/api-v2/oas-v2-discovery

This is an example JSON response from the /api/swagger/resources endpoint, showing the structure and key fields like 'jsonPath' which is used to build resource paths.

```json
{
    "items": [
        {
            "jsonPath": "json/clients_v2_swagger.json",
            "label": "Clients",
            "hashValue": "Clients",
            "index": 0
        },
        {
            "jsonPath": "json/clients_documents_v2_swagger.json",
            "label": "Client Documents",
            "hashValue": "Client_Documents",
            "index": 1
        },
        {
            "jsonPath": "json/branches_v2_swagger.json",
            "label": "Branches",
            "hashValue": "Branches",
            "index": 2
        },
        {
            "jsonPath": "json/centres_v2_swagger.json",
            "label": "Centres",
            "hashValue": "Centres",
            "index": 3
        },
        ...
        {
            "jsonPath": "json/configuration_iddocumenttemplates.yaml_v2_swagger.json",
            "label": "Identification Document Templates Configuration",
            "hashValue": "Identification_Document_Templates_Configuration",
            "index": 64
        },
        {
            "jsonPath": "json/configuration_loanrisklevels.yaml_v2_swagger.json",
            "label": "Loan Risk Levels Configuration",
            "hashValue": "Loan_Risk_Levels_Configuration",
            "index": 65
        },
        {
            "jsonPath": "json/currencies_v2_swagger.json",
            "label": "Currencies",
            "index": 66
        }
    ]
}
```

--------------------------------

### Example API v2 Response Structure

Source: https://docs.mambu.com/api/pages/api-v2/versioning

This is an example of the JSON structure returned when requesting API v2 resources.

```json
{
    "swagger": "2.0",
    "info": {
        "version": "v2",
        "title": "clients"
    },
    "host": "localhost:8889",
    "basePath": "/api",
    "tags": [
        {
            "name": "Clients",
            "description": "Allows you to retrieve, create, update, or delete clients. Clients may have associated information such as their address, identification documents, or custom field values."
        }
    ],
    "schemes": [
        "http",
        "https"
    ],
    "paths": {
    ...
    },
    "securityDefinitions": {
        "basic": {
            "description": "",
            "type": "basic"
        }
    },
    "definitions": {
    ...
    }
}
```

--------------------------------

### Java HTTPURLConnection with Pagination

Source: https://docs.mambu.com/api/pages/api-v2/pagination

Illustrates how to perform a paginated Mambu API request using Java's HttpURLConnection. This example shows basic setup and response handling.

```java
URL obj = new URL("https://TENANT_NAME.mambu.com/api/{Insert resource URI here}?offset=10&limit=10&paginationDetails=ON");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestProperty ("Accept", "application/vnd.mambu.v2+json");
con.setRequestMethod("{HTTP Verb}");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```

--------------------------------

### Go API Request

Source: https://docs.mambu.com/api/pages/api-v2/requests

Example of making an API request using Go's net/http package, setting headers and preparing the request.

```APIDOC
## Go API Request

### Description
This Go code snippet demonstrates how to construct an HTTP request using the `net/http` package. It includes setting the `Accept` header and placeholders for the HTTP verb and resource URI. The example shows the basic setup for sending a request.

### Method
`client.Do(req)` with `req.Method = "{HTTP Verb}"`

### Endpoint
`https://TENANT_NAME.mambu.com/api/{Insert resource URI here}`

### Headers
- `Accept`: `application/vnd.mambu.v2+json`

### Request Example
```go
package main

import (
       "bytes",
       "net/http",
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.mambu.v2+json"},

    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("{HTTP Verb}", "https://TENANT_NAME.mambu.com/api/{Insert resource URI here}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```
```

--------------------------------

### Using wget for Pagination

Source: https://docs.mambu.com/api/pages/api-v2/pagination

Demonstrates how to use wget to make a paginated GET request to the Mambu API. Ensure to replace placeholders with your tenant name and resource URI.

```shell
curl -X GET https://TENANT_NAME.mambu.com/api/{Insert resource URI here}?offset=10&limit=10&paginationDetails=ON \
  -H 'Accept: application/vnd.mambu.v2+json'
```

--------------------------------

### GET Request with detailsLevel=FULL using Python

Source: https://docs.mambu.com/api/pages/api-v2/details-level

This Python snippet uses the `requests` library to make a GET request to the Mambu API with detailsLevel=FULL. It sets the Accept header and prints the JSON response. Replace `{HTTP Verb}` and `{Insert resource URI here}`.

```python
import requests
headers = {
  'Accept': 'application/vnd.mambu.v2+json'
}

r = requests.{HTTP Verb}('https://TENANT_NAME.mambu.com/api/{Insert resource URI here}?detailsLevel=FULL', params={
  
}, headers = headers)
  
print r.json()
```

--------------------------------

### GET Request with detailsLevel=FULL using Java

Source: https://docs.mambu.com/api/pages/api-v2/details-level

This Java snippet shows how to make a GET request to the Mambu API with detailsLevel=FULL using `HttpURLConnection`. It sets the Accept header and reads the response. Replace `{HTTP Verb}` and `{Insert resource URI here}`.

```java
URL obj = new URL("https://TENANT_NAME.mambu.com/api/{Insert resource URI here}?detailsLevel=FULL");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestProperty ("Accept", "application/vnd.mambu.v2+json");
con.setRequestMethod("{HTTP Verb}");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```

--------------------------------

### GET Request with detailsLevel=FULL using Ruby

Source: https://docs.mambu.com/api/pages/api-v2/details-level

This Ruby snippet demonstrates how to make a GET request to the Mambu API with detailsLevel=FULL using the `rest-client` gem. It includes the Accept header and parses the JSON response. Replace `{HTTP Verb}` and `{Insert resource URI here}`.

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/vnd.mambu.v2+json'
}

result = RestClient.{HTTP Verb} 'https://TENANT_NAME.mambu.com/api/{Insert resource URI here}?detailsLevel=FULL',
  params: {
  }, headers: headers
  
p JSON.parse(result)
```

--------------------------------

### Search Loans by Loan Name

Source: https://docs.mambu.com/api/pages/api-v2/searching-for-records

Example of searching for loans from a particular product type and sorting them by approval date.

```APIDOC
## POST /loans:search

### Description
Searches for loans based on specified criteria and sorts the results.

### Method
POST

### Endpoint
/loans:search

### Request Body
- **filterCriteria** (array) - Required - An array of objects specifying the filtering conditions.
  - **field** (string) - Required - The field to filter on.
  - **operator** (string) - Required - The operator to use for filtering (e.g., EQUALS_CASE_SENSITIVE).
  - **value** (string) - Required - The value to filter by.
- **sortingCriteria** (object) - Optional - An object specifying the sorting conditions.
  - **field** (string) - Required - The field to sort by (e.g., approvedDate).
  - **order** (string) - Required - The order of sorting (e.g., DESC).

### Request Example
```json
{
  "filterCriteria": [
    {
      "field": "loanName",
      "operator": "EQUALS_CASE_SENSITIVE",
      "value": "Agriculture Loan"
    }
  ],
  "sortingCriteria": {
    "field": "approvedDate",
    "order": "DESC"
  }
}
```

### Response
#### Success Response (200)
- **field** (string) - Description of the field returned in the search results.
- **operator** (string) - Description of the operator used in the search.
- **value** (string) - Description of the value used in the search.

#### Response Example
(Response structure depends on the specific loan details returned)
```

--------------------------------

### Retrieve OAS JSON using Python

Source: https://docs.mambu.com/api/pages/api-v2/retrieving-v2-oas-files

This Python example uses the 'requests' library to make a GET request for the OAS JSON file. It includes the Authorization header for basic authentication and prints the JSON response.

```python
import requests
headers = {
  'Authorization': 'Basic <credentials>'
}

r = requests.get('https://TENANT_NAME.mambu.com/api/swagger/completejson/{OAS-file}', params={
  
}, headers = headers)

print r.json()
```

--------------------------------

### GET Request with detailsLevel=FULL using cURL

Source: https://docs.mambu.com/api/pages/api-v2/details-level

Use this snippet to make a GET request to the Mambu API with the detailsLevel set to FULL using cURL. Ensure you replace `{Insert resource URI here}` with the actual resource URI.

```shell
curl -X GET https://TENANT_NAME.mambu.com/api/{Insert resource URI here}?detailsLevel=FULL \
  -H 'Accept: application/vnd.mambu.v2+json'
```

--------------------------------

### Basic Authentication Example

Source: https://docs.mambu.com/api/pages/api-v2/authentication

This section demonstrates how to authenticate API requests using Basic authentication. It shows how to construct the Authorization header with a base64-encoded username and password.

```APIDOC
## Basic Authentication

### Description
Authenticates API requests using Mambu UI login credentials for a user account with **API** access permissions.

### Method
GET

### Endpoint
`https://TENANT_NAME.mambu.com/api/users`

### Parameters
#### Request Headers
- **Authorization** (string) - Required - `Basic {base64-encoded-username:password}`

### Request Example
```shell
curl --location --request GET 'https://TENANT_NAME.mambu.com/api/users' \
--header 'Authorization: Basic U29tZVVzZXI6T3BlblNlc2FtZQ=='
```

### Response
#### Success Response (200)
Returns a list of users.

### Note
All requests must use HTTPS to ensure the username and password cannot be intercepted.
```

--------------------------------

### Idempotent POST Request using Go

Source: https://docs.mambu.com/api/pages/api-v2/idempotency

This Go example shows how to construct and send an idempotent POST request using the standard 'net/http' package. The 'Idempotency-Key' header is set within the request headers.

```go
package main
  
import (
       "bytes"
       "net/http"
)
  
func main() {
  
    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/vnd.mambu.v2+json"},
        "Idempotency-Key": []string{"01234567-9abc-def0-1234-56789abcdef0"},
  
    }
  
    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://TENANT_NAME.mambu.com/api/deposits/{depositAccountId}/transactions", data)
    req.Header = headers
  
    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

--------------------------------

### Retrieve OAS JSON using HTTP Request

Source: https://docs.mambu.com/api/pages/api-v2/retrieving-v2-oas-files

An example of an HTTP GET request to retrieve the OAS JSON file. It includes the necessary Host header and Authorization header for basic authentication.

```http
GET https://TENANT_NAME.mambu.com/api/swagger/completejson/{OAS-file} HTTP/1.1  
Host: TENANT_NAME.mambu.com  

Authorization: Basic <credentials>
```

--------------------------------

### GET Request with detailsLevel=FULL using JavaScript (jQuery)

Source: https://docs.mambu.com/api/pages/api-v2/details-level

This JavaScript snippet uses jQuery to make a GET request to the Mambu API with detailsLevel=FULL. It includes the necessary Accept header and logs the data to the console. Replace `{HTTP Verb}` and `{Insert resource URI here}`.

```javascript
var headers = {
  'Accept':'application/vnd.mambu.v2+json'
  
};
  
$.ajax({
  url: 'https://TENANT_NAME.mambu.com/api/{Insert resource URI here}?detailsLevel=FULL',
  method: '{HTTP Verb}',
  
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})
```

--------------------------------

### Retrieve List of APIs using Python Requests

Source: https://docs.mambu.com/api/pages/api-v2/oas-v2-discovery

Example of fetching the API list using Python's requests library, demonstrating how to include the Authorization header.

```python
import requests
headers = {
  'Authorization': 'Basic <credentials>'
}

r = requests.get('https://TENANT_NAME.mambu.com/api/swagger/resources', params={
  
}, headers = headers)

print r.json()
```

--------------------------------

### Go HTTP Client with Pagination

Source: https://docs.mambu.com/api/pages/api-v2/pagination

Example of making a paginated Mambu API request using Go's standard net/http package. This snippet focuses on setting up the request and headers.

```go
package main

import (
       "bytes",
       "net/http",
)

func main() {
  
    headers := map[string][]string{
        "Accept": []string{"application/vnd.mambu.v2+json"},
  
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("{HTTP Verb}", "https://TENANT_NAME.mambu.com/api/{Insert resource URI here}?offset=10&limit=10&paginationDetails=ON", data)
    req.Header = headers
  
    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

--------------------------------

### Retrieve API Swagger with Go

Source: https://docs.mambu.com/api/pages/api-v2/versioning

Use Go's net/http package to construct and execute a GET request for the API Swagger JSON.

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "apikey": []string{"APIKEY"}
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://TENANT_NAME.mambu.com/api/swagger/completejson/{OAS-file}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

--------------------------------

### Idempotent POST Request using HTTP/1.1

Source: https://docs.mambu.com/api/pages/api-v2/idempotency

This example shows the raw HTTP/1.1 request format for an idempotent POST request, including all necessary headers.

```http
POST https://TENANT_NAME.mambu.com/api/deposits/{depositAccountId}/transactions HTTP/1.1
Host: TENANT_NAME.mambu.com
Content-Type: application/json
Accept: application/vnd.mambu.v2+json
Idempotency-Key: 01234567-9abc-def0-1234-56789abcdef0
```

--------------------------------

### Example v2 OAS JSON Response Structure

Source: https://docs.mambu.com/api/pages/api-v2/retrieving-v2-oas-files

This is an example of the JSON response structure you can expect when retrieving a v2 OAS file. It includes details about the swagger version, API info, host, base path, tags, schemes, paths, security definitions, and data models.

```json
{

    "swagger": "2.0",

    "info": {

        "version": "v2",

        "title": "clients"

    },

    "host": "localhost:8889",

    "basePath": "/api",

    "tags": [

        {

            "name": "Clients",

            "description": "Allows you to retrieve, create, update, or delete clients. Clients may have associated information such as their address, identification documents, or custom field values."

        }

    ],

    "schemes": [

        "http",

        "https"

    ],

    "paths": {

    ...

    },

    "securityDefinitions": {

        "basic": {

            "description": "",

            "type": "basic"

        }

    },

    "definitions": {

    ...

    }

}
```

--------------------------------

### Java API Request

Source: https://docs.mambu.com/api/pages/api-v2/requests

Example of making an API request using Java's HttpURLConnection, setting request properties and reading the response.

```APIDOC
## Java API Request

### Description
This Java example uses `HttpURLConnection` to make an API request. It shows how to set the `Accept` header, specify the HTTP method, and read the response from the input stream.

### Method
`con.setRequestMethod("{HTTP Verb}")`

### Endpoint
`https://TENANT_NAME.mambu.com/api/{Insert resource URI here}`

### Headers
- `Accept`: `application/vnd.mambu.v2+json`

### Request Example
```java
URL obj = new URL("https://TENANT_NAME.mambu.com/api/{Insert resource URI here}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestProperty("Accept", "application/vnd.mambu.v2+json");
con.setRequestMethod("{HTTP Verb}");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```
```

--------------------------------

### Making API Requests with Java

Source: https://docs.mambu.com/api/pages/api-v2/requests

An example of making an API request using Java's HttpURLConnection. This code sets the 'Accept' header and reads the response.

```java
URL obj = new URL("https://TENANT_NAME.mambu.com/api/{Insert resource URI here}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestProperty (“Accept”, “application/vnd.mambu.v2+json”);
con.setRequestMethod("{HTTP Verb}");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```

--------------------------------

### Idempotent POST Request using Python

Source: https://docs.mambu.com/api/pages/api-v2/idempotency

This Python example uses the 'requests' library to perform an idempotent POST request. The 'Idempotency-Key' header is essential for this functionality.

```python
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/vnd.mambu.v2+json',
  'Idempotency-Key': '01234567-9abc-def0-1234-56789abcdef0'
}
  
r = requests.post('https://TENANT_NAME.mambu.com/api/deposits/{depositAccountId}/transactions', params={
  
}, headers = headers)
  
print r.json()
```

--------------------------------

### Ruby API Request

Source: https://docs.mambu.com/api/pages/api-v2/requests

Example of making an API request using Ruby's RestClient library, including setting headers and parsing the JSON response.

```APIDOC
## Ruby API Request

### Description
This Ruby code snippet shows how to make an API request using the `rest-client` gem. It includes setting the `Accept` header and placeholders for the HTTP verb and resource URI. The response is parsed as JSON.

### Method
`RestClient.{HTTP Verb}`

### Endpoint
`https://TENANT_NAME.mambu.com/api/{Insert resource URI here}`

### Parameters
#### Query Parameters
- `{}` - Required/Optional - Description

### Headers
- `Accept`: `application/vnd.mambu.v2+json`

### Request Example
```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/vnd.mambu.v2+json'
}

result = RestClient.{HTTP Verb} 'https://TENANT_NAME.mambu.com/api/{Insert resource URI here}',
  params: {
  },
  headers: headers

p JSON.parse(result)
```
```

--------------------------------

### Standard Custom Field Set Example

Source: https://docs.mambu.com/api/pages/api-v2/using-custom-fields

Shows a standard custom field set with ID '_loanPerformanceScore' containing nested custom field definitions and their values.

```json
{
  "id": "ABC001",
  "loanName": "Mortgage Loan",
  "loanState": "PARTIAL_APPLICATION",
  ...
  "_loanPerformanceScore": {
    "amountScore": "10",
    "timeScore": "5"
  }
}
```

--------------------------------

### Starts With Operator

Source: https://docs.mambu.com/api/pages/api-v2/filter-operators

Use the STARTS_WITH operator to filter for values that begin with a specified string. This operator is case-sensitive by default.

```json
{
  "field": "id",
  "operator": "STARTS_WITH",
  "value":"eban"
}
```

--------------------------------

### Retrieve API Swagger with Python

Source: https://docs.mambu.com/api/pages/api-v2/versioning

Use the requests library in Python to make a GET request for the API Swagger JSON.

```python
import requests
headers = {
  'apikey': 'APIKEY'
}

r = requests.get('https://TENANT_NAME.mambu.com/api/swagger/completejson/{OAS-file}', params={

}, headers = headers)

print r.json()
```

--------------------------------

### Starts With Case Sensitive Operator

Source: https://docs.mambu.com/api/pages/api-v2/filter-operators

Use the STARTS_WITH operator for case-sensitive filtering of values that begin with a specified string.

```json
{
  "field": "id",
  "operator": "STARTS_WITH",
  "value":"EBAN"
}
```

--------------------------------

### Python API Request

Source: https://docs.mambu.com/api/pages/api-v2/requests

Example of making an API request using Python's requests library, including setting headers and printing the JSON response.

```APIDOC
## Python API Request

### Description
This Python example uses the `requests` library to make an API call. It demonstrates setting the `Accept` header and includes placeholders for the HTTP verb and resource URI. The response is printed as JSON.

### Method
`requests.{HTTP Verb}`

### Endpoint
`https://TENANT_NAME.mambu.com/api/{Insert resource URI here}`

### Parameters
#### Query Parameters
- `{}` - Required/Optional - Description

### Headers
- `Accept`: `application/vnd.mambu.v2+json`

### Request Example
```python
import requests

headers = {
  'Accept': 'application/vnd.mambu.v2+json'
}

r = requests.{HTTP Verb}('https://TENANT_NAME.mambu.com/api/{Insert resource URI here}', params={
  
}, headers = headers)

print r.json()
```
```

--------------------------------

### Standard Custom Field Set Example

Source: https://docs.mambu.com/api/pages/api-v2/using-custom-fields

Illustrates the structure of a standard custom field set in a JSON object. Each custom field definition has a single value.

```json
{
  "_customFieldSet": {
    "customFieldDefinitionId1": "value",
    "customFieldDefinitionId2": "value",
    "customFieldDefinitionId3": "value"
  }
}
```

--------------------------------

### Making API Requests with Ruby

Source: https://docs.mambu.com/api/pages/api-v2/requests

Use the RestClient gem in Ruby to interact with the Mambu API. This example shows how to set headers and parse the JSON response.

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/vnd.mambu.v2+json'
}

result = RestClient.{HTTP Verb} 'https://TENANT_NAME.mambu.com/api/{Insert resource URI here}',
  params: {
  },
headers: headers

p JSON.parse(result)
```

--------------------------------

### Retrieve List of APIs using cURL

Source: https://docs.mambu.com/api/pages/api-v2/oas-v2-discovery

Use cURL to make a GET request to the /api/swagger/resources endpoint to retrieve a list of all available APIs.

```shell
curl -X GET https://TENANT_NAME.mambu.com/api/swagger/resources \
  -u 'username:password'
```

--------------------------------

### Retrieve API Swagger with Java

Source: https://docs.mambu.com/api/pages/api-v2/versioning

Use Java's HttpURLConnection to make a GET request for the API Swagger JSON.

```java
URL obj = new URL("https://TENANT_NAME.mambu.com/api/swagger/completejson/{OAS-file}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestProperty("apikey", "APIKEY");
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```

--------------------------------

### Retrieve API Swagger with HTTP Request

Source: https://docs.mambu.com/api/pages/api-v2/versioning

Manually construct an HTTP GET request to retrieve the API Swagger JSON.

```http
GET https://TENANT_NAME.mambu.com/api/swagger/completejson/{OAS-file} HTTP/1.1 
Host: TENANT_NAME.mambu.com

apikey: APIKEY
```

--------------------------------

### Retrieve API Swagger with Ruby

Source: https://docs.mambu.com/api/pages/api-v2/versioning

Use the RestClient gem in Ruby to perform a GET request for the API Swagger JSON.

```ruby
require 'rest-client'
require 'json'

headers = {
  'apikey' => 'APIKEY'
}

result = RestClient.get 'https://TENANT_NAME.mambu.com/api/swagger/completejson/{OAS-file}',
  params: {
  }, headers: headers

p JSON.parse(result)
```

--------------------------------

### Grouped Custom Field Set Example

Source: https://docs.mambu.com/api/pages/api-v2/using-custom-fields

Demonstrates a grouped custom field set with ID '_assets', containing an array of custom field values grouped by an index.

```json
{
  "encodedKey": "8a19aad43801888d017801f0dd841c1d",
  "id": "190955358",
  "state": "ACTIVE",
  "creationDate": "2021-03-05T11:31:05+01:00",
  "lastModifiedDate": "2022-08-08T12:42:35+02:00",
  "activationDate": "2021-11-18T10:19:13+01:00",
  "approvedDate": "2021-03-05T11:31:05+01:00",
  "firstName": "John ",
  "lastName": "Smith ",
  ...
  "_assets": [
    {
      "_index": "0",
      "asset_value": "965000",
      "asset_type": "land",
      "asset_age": "10"
    },
    {
      "_index": "1",
      "asset_value": "25,000",
      "asset_type": "car",
      "asset_age": "2"
    }
  ]
}
```

--------------------------------

### JavaScript (jQuery) API Request

Source: https://docs.mambu.com/api/pages/api-v2/requests

Example of making an API request using jQuery's AJAX method, including setting headers and handling the response.

```APIDOC
## JavaScript (jQuery) API Request

### Description
This example demonstrates how to perform an API request using jQuery's `$.ajax` function. It shows how to set the `Accept` header and specifies placeholders for the HTTP verb and resource URI.

### Method
`{HTTP Verb}`

### Endpoint
`https://TENANT_NAME.mambu.com/api/{Insert resource URI here}`

### Headers
- `Accept`: `application/vnd.mambu.v2+json`

### Request Example
```javascript
var headers = {
'Accept':'application/vnd.mambu.v2+json'
};

$.ajax({
url: 'https://TENANT_NAME.mambu.com/api/{Insert resource URI here}',
method: '{HTTP Verb}',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
```
```

--------------------------------

### Basic Authentication HTTP Request

Source: https://docs.mambu.com/api/pages/api-v2/authentication

Example of an HTTP request using Basic Authentication, including the Host and Authorization headers. All requests must use HTTPS.

```http
GET /api/users HTTP/1.1
Host: TENANT_NAME.mambu.com
Authorization: Basic U29tZVVzZXI6T3BlblNlc2FtZQ==
```

--------------------------------

### Loan Accounts Search

Source: https://docs.mambu.com/api/pages/api-v2/cursor-based-search-pagination

Initiates a cursor-based search for loan accounts. Use `cursor=_` and `limit=1` to start, and the `Items-Next-Cursor` header will provide the next cursor value.

```APIDOC
## GET /loans:search

### Description
Performs a cursor-based search for loan accounts, returning a subset of data based on the provided cursor and limit.

### Method
GET

### Endpoint
/loans:search

### Query Parameters
- **limit** (integer) - Required - The maximum number of items to return in the current request.
- **cursor** (string) - Required - The cursor to start the search from. Use `_` to start from the beginning.

### Response
#### Success Response (200)
- **Items-Next-Cursor** (string) - The cursor to use for the next search request. An empty string indicates the end of the data set.

### Request Example
```
GET /loans:search?limit=1&cursor=_ HTTP/1.1
Host: api.mambu.com
Accept: application/json

```

### Response Example
```json
{
  "Items-Next-Cursor": "someCursorValue"
}
```
```

--------------------------------

### Search Active and Overdrawn Current Accounts

Source: https://docs.mambu.com/api/pages/api-v2/searching-for-records

Example of searching for active and overdrawn current accounts from two different branches, sorted by overdraft balance.

```APIDOC
## POST /deposits:search

### Description
Searches for deposit accounts based on specified criteria, including account state, type, overdraft amount, and branch, and sorts the results by overdraft balance.

### Method
POST

### Endpoint
/deposits:search

### Request Body
- **filterCriteria** (array) - Required - An array of objects specifying the filtering conditions.
  - **field** (string) - Required - The field to filter on (e.g., accountState, accountType, balances.overdraftAmount, assignedBranchKey).
  - **operator** (string) - Required - The operator to use for filtering (e.g., EQUALS_CASE_SENSITIVE, MORE_THAN, in).
  - **value** (string or number) - Required - The value to filter by.
  - **values** (array) - Required when operator is 'in' - An array of values to filter by.
- **sortingCriteria** (object) - Optional - An object specifying the sorting conditions.
  - **field** (string) - Required - The field to sort by (e.g., balances.overdraftAmount).
  - **order** (string) - Required - The order of sorting (e.g., DESC).

### Request Example
```json
{
  "filterCriteria": [
    {
        "field": "accountState",
        "operator": "EQUALS_CASE_SENSITIVE",
        "value": "ACTIVE"
    },
    {
      "field": "accountType",
      "operator": "EQUALS_CASE_SENSITIVE",
      "value": "CURRENT_ACCOUNT"
    },
    {
        "field": "balances.overdraftAmount",
        "operator": "MORE_THAN",
        "value": 0
    },
    {
        "field": "assignedBranchKey",
        "operator": "in",
        "values": [
            "8a193c26722b51b701722d779e7122de",
            "8a193c26722b51b701722d779e7122df"
        ]
    }
  ],
  "sortingCriteria": {
    "field": "balances.overdraftAmount",
    "order": "DESC"
  }
}
```

### Response
#### Success Response (200)
- **field** (string) - Description of the field returned in the search results.
- **operator** (string) - Description of the operator used in the search.
- **value** (string or number) - Description of the value used in the search.
- **values** (array) - Description of the values used in the search.

#### Response Example
(Response structure depends on the specific deposit account details returned)
```

--------------------------------

### Retrieve OAS JSON using Java

Source: https://docs.mambu.com/api/pages/api-v2/retrieving-v2-oas-files

A Java example demonstrating how to retrieve the OAS JSON file using HttpURLConnection. It sets the Authorization header and reads the response from the input stream.

```java
URL obj = new URL("https://TENANT_NAME.mambu.com/api/swagger/completejson/{OAS-file}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestProperty("Authorization", "Basic <credentials>");
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```

--------------------------------

### Deposit Accounts Search

Source: https://docs.mambu.com/api/pages/api-v2/cursor-based-search-pagination

Initiates a cursor-based search for deposit accounts. Use `cursor=_` and `limit=1` to start, and the `Items-Next-Cursor` header will provide the next cursor value.

```APIDOC
## GET /deposits:search

### Description
Performs a cursor-based search for deposit accounts, returning a subset of data based on the provided cursor and limit.

### Method
GET

### Endpoint
/deposits:search

### Query Parameters
- **limit** (integer) - Required - The maximum number of items to return in the current request.
- **cursor** (string) - Required - The cursor to start the search from. Use `_` to start from the beginning.

### Response
#### Success Response (200)
- **Items-Next-Cursor** (string) - The cursor to use for the next search request. An empty string indicates the end of the data set.

### Request Example
```
GET /deposits:search?limit=1&cursor=_ HTTP/1.1
Host: api.mambu.com
Accept: application/json

```

### Response Example
```json
{
  "Items-Next-Cursor": "someCursorValue"
}
```
```

--------------------------------

### Retrieve OAS JSON using Go

Source: https://docs.mambu.com/api/pages/api-v2/retrieving-v2-oas-files

This Go snippet shows how to make an HTTP GET request to retrieve the OAS JSON file. It sets the Authorization header and uses a basic client to execute the request. Note that the error handling and response body processing are omitted for brevity.

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"Basic <credentials>"}
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://TENANT_NAME.mambu.com/api/swagger/completejson/{OAS-file}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

--------------------------------

### Grouped Custom Field Set Example

Source: https://docs.mambu.com/api/pages/api-v2/using-custom-fields

Shows the structure of a grouped custom field set in a JSON object. It contains an array of objects, where each object represents a group with an index and associated custom field values.

```json
{
  "_customFieldSet": [
          {
              "_index": "0",
              "customFieldDefinitionId1": "value",
              "customFieldDefinitionId2": "value",
              "customFieldDefinitionId3": "value"
          },
          {
              "_index": "1",
              "customFieldDefinitionId1": "value",
              "customFieldDefinitionId2": "value",
              "customFieldDefinitionId3": "value"
          }
      ]
}
```

--------------------------------

### Loan Transactions Search

Source: https://docs.mambu.com/api/pages/api-v2/cursor-based-search-pagination

Initiates a cursor-based search for loan transactions. Use `cursor=_` and `limit=3` to start, and the `Items-Next-Cursor` header will provide the next cursor value.

```APIDOC
## GET /loans/transactions:search

### Description
Performs a cursor-based search for loan transactions, returning a subset of data based on the provided cursor and limit.

### Method
GET

### Endpoint
/loans/transactions:search

### Query Parameters
- **limit** (integer) - Required - The maximum number of items to return in the current request.
- **cursor** (string) - Required - The cursor to start the search from. Use `_` to start from the beginning.

### Response
#### Success Response (200)
- **Items-Next-Cursor** (string) - The cursor to use for the next search request. An empty string indicates the end of the data set.

### Request Example
```
GET /loans/transactions:search?limit=3&cursor=_ HTTP/1.1
Host: api.mambu.com
Accept: application/json

```

### Response Example
```json
{
  "Items-Next-Cursor": "someCursorValue"
}
```
```
Tokens:
Raw