Banking Products v0.4.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This API manages the set of banking products that a financial institution offers to its customers. Each bank account is associated with a product.

Examples of products are a personal savings account product or a business checking account product. Each product also has a product type (for example, DDA for a checking or demand deposit account) and a subtype which is a more specific type, such as 'Interest Checking'.

Each account is attached to the product instance that was effective and active when account was created. Product types may also have subtypes, although subtypes may not have deeper subtypes. When the terms and conditions of a product changes, this constititutes a new revision of the product. Business rules (which are not part of this service) dictate whether all accounts which are attached to the product remain attached to the previous revision of the product or are attached to the newer revision or when and how this occurs. Similarly, business rules and other services may provide notification to users of changes in terms of use, etc. Products and product types each have a name, a description a label, and a state.

The state may be one of the following:

• pending In creation, not yet used or available for use. Only pending items may be deleted.
• active Active and in use or available for use
• inactive Not available for use (deactivated)
• removed Removed and archived. Removed items are not eligible to be activated. When an account is removed, it's name is changed so that the name may be used for new products or product types.

After creating a product type or product subtype, which by default leaves the resource in the `pending` state, the caller should also activate it via the `apiture:activate` link in the response. Pending resources which have not been activated may be deleted after an expiration period.

Allowed state transitions are:

• pending -> active
• pending -> inactive
• active -> inactive
• inactive -> active
• active -> removed
• inactive -> removed

A product or product type may only be deleted if its `state` is `pending`. A product or type may only change to `inactive` if it is not currently in use by active accounts or active products. Products and product types include links which convey the allowed POST operations, such as `apiture:activate`, `apiture:deactivate`, or `apiture:remove`.

In addition, a product has `newAccountAvailability` which indicates if that product is available for opening new accounts. **TODO** The `newAccountAvailability` in the product resource is currently mutable but it will become immutable and derived only. The value is derived from the existence of the product in the `unlockedProducts` collection.

This resource is a copy of the banking product resources in the bank core. In some cases, the Apiture platform does not have programmatic access to that core, so when when a financial institution updates the banking products in the core, they must *also* use this API to update the Apiture copy.

Download OpenAPI Definition (YAML)

Base URLs:

• /products

Terms of service

Email: Apiture Web: Apiture

API

Endpoints which describe this API.

getApi

Code samples

# You can also use wget
curl -X GET /products/ \
  -H 'Accept: application/hal+json'

GET /products/ HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/products/',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/products/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/products/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/products/', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/products/", data)
    req.Header = headers

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

Top-level resources and operations in this API

GET /

Return links to the top-level resources and operations in this API. This API returns the following links:

• apiture:product : links to the collection of products
• apiture:productTypes : links to the collection of product types

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

OK

{
  "id": "products",
  "name": "Banking Products",
  "apiVersion": "0.1.0",
  "_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
  "_links": {
    "apiture:products": {
      "href": "/products/products"
    },
    "apiture:productTypes": {
      "href": "/products/productTypes"
    }
  }
}

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

Responses

getApiDoc

Code samples

# You can also use wget
curl -X GET /products/apiDoc \
  -H 'Accept: application/json'

GET /products/apiDoc HTTP/1.1

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: '/products/apiDoc',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('/products/apiDoc',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/products/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/products/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/apiDoc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/products/apiDoc", data)
    req.Header = headers

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

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{}

Responses

Response Schema

Product

Banking Products

getProducts

Code samples

# You can also use wget
curl -X GET /products/products \
  -H 'Accept: application/hal+json'

GET /products/products HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/products/products',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/products/products',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/products/products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/products/products', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/products");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/products/products", data)
    req.Header = headers

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

Return a collection of products

GET /products

Return a paginated sortable filterable searchable collection of products. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/products/products/v0.3.0/profile.json",
  "start": 0,
  "limit": 10,
  "count": 42,
  "name": "products",
  "_links": {
    "self": {
      "href": "/products?start=0&limit=10"
    },
    "first": {
      "href": "/products?start=10&limit=10"
    },
    "next": {
      "href": "/products?start=10&limit=10"
    },
    "collection": {
      "href": "/products"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
        "name": "Premiere Checking",
        "label": "Premiere Checking",
        "description": "A premiere demand deposit checking account for business use.",
        "state": "active",
        "newAccountAvailability": "available",
        "category": "DDA",
        "revision": "2019-01-31T13:31:40.656Z",
        "rate": {
          "value": "1.40",
          "type": "apr"
        },
        "_links": {
          "apiture:productType": {
            "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
          },
          "apiture:productSubtype": {
            "href": "/products/productTypes/b2134f56-3645-490d-a788-79e974635ae8"
          },
          "self": {
            "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
          }
        }
      }
    ]
  }
}

Responses

createProduct

Code samples

# You can also use wget
curl -X POST /products/products \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json'

POST /products/products HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/products/products',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://api.apiture.com/schemas/products/product/v0.3.0/profile.json",
  "name": "Business Checking",
  "label": "Business Checking",
  "description": "A demand deposit checking account for business use.",
  "category": "DDA",
  "rate": {
    "value": "1.40",
    "type": "apr"
  },
  "_links": {
    "apiture:productSubtype": {
      "href": "/products/productTypes/b2134f56-3645-490d-a788-79e974635ae8"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

fetch('/products/products',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json'
}

result = RestClient.post '/products/products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json'
}

r = requests.post('/products/products', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/products");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/products/products", data)
    req.Header = headers

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

Create a new product

POST /products

Create a new product from the given name, label, description, and product subtype. The request must contain links to an existing product subtype. The name must be unique and the state may not be removed.

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/products/product/v0.3.0/profile.json",
  "name": "Business Checking",
  "label": "Business Checking",
  "description": "A demand deposit checking account for business use.",
  "category": "DDA",
  "rate": {
    "value": "1.40",
    "type": "apr"
  },
  "_links": {
    "apiture:productSubtype": {
      "href": "/products/productTypes/b2134f56-3645-490d-a788-79e974635ae8"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

201 Response

{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:productType": {
      "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
    },
    "apiture:productSubtype": {
      "href": "/products/productTypes/b2134f56-3645-490d-a788-79e974635ae8"
    },
    "apiture:deactivate": {
      "href": "/disabledProducts?product=a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:remove": {
      "href": "/removedProducts?product=a6459cdf-543e-46df-887b-ac5378ee9acd"
    }
  },
  "_embedded": {
    "productType": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    },
    "productSubtype": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0,
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Premiere Checking",
  "label": "Premiere Checking",
  "description": "A premiere demand deposit checking account for business use.",
  "state": "active",
  "type": "Demand Deposit",
  "subtype": "Demand Deposit with Interest",
  "newAccountAvailability": "available"
}

Responses

Response Headers

getProduct

Code samples

# You can also use wget
curl -X GET /products/products/{productId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string'

GET /products/products/{productId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

$.ajax({
  url: '/products/products/{productId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

fetch('/products/products/{productId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string'
}

result = RestClient.get '/products/products/{productId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string'
}

r = requests.get('/products/products/{productId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/products/{productId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/products/products/{productId}", data)
    req.Header = headers

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

Fetch a representation of this product

GET /products/{productId}

Return a HAL representation of this product resource.

This resource also maintains immutable revisions; see the getProductRevisions and getProductRevision operations. The Content-Location response header, if present, identifies the equivalent revision.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:productType": {
      "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
    },
    "apiture:productSubtype": {
      "href": "/products/productTypes/b2134f56-3645-490d-a788-79e974635ae8"
    },
    "apiture:deactivate": {
      "href": "/disabledProducts?product=a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:remove": {
      "href": "/removedProducts?product=a6459cdf-543e-46df-887b-ac5378ee9acd"
    }
  },
  "_embedded": {
    "productType": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    },
    "productSubtype": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0,
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Premiere Checking",
  "label": "Premiere Checking",
  "description": "A premiere demand deposit checking account for business use.",
  "state": "active",
  "type": "Demand Deposit",
  "subtype": "Demand Deposit with Interest",
  "newAccountAvailability": "available"
}

Responses

Response Headers

updateProduct

Code samples

# You can also use wget
curl -X PUT /products/products/{productId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

PUT /products/products/{productId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/products/products/{productId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "string",
  "_profile": "https://api.apiture.com/schemas/products/product/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:productType": {
      "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
    },
    "apiture:productSubtype": {
      "href": "/products/productTypes/fa4f2335-3306-4721-b74c-8ec0c77823e9"
    }
  },
  "name": "Premiere Checking",
  "label": "Premiere Checking",
  "description": "A premiere demand deposit checking account for business use.",
  "state": "active",
  "type": "Demand Deposit",
  "subtype": "Demand Deposit with Interest",
  "newAccountAvailability": "available",
  "revision": "2018-04-25T07:56:46.375Z",
  "_embedded": {
    "productType": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      },
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0
    },
    "productSubtype": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      },
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0
    }
  },
  "institutionName": "string",
  "coreType": "string",
  "onlineBankingEnabled": false,
  "target": "personal",
  "currency": "USD",
  "constraints": {
    "transactionTypes": [
      "debit"
    ],
    "minimumBalance": "500.00",
    "minimumFundingAmount": "500.00",
    "maximumFundingAmount": "2500.00",
    "minimumTransferAmount": "25.00",
    "maximumTransferAmount": "10000.00"
  },
  "term": "string",
  "automaticallyRenew": true,
  "debitCardIssuedAt": "2019-01-31T13:31:43.725Z",
  "fees": [
    {
      "type": "service",
      "period": "P1M",
      "description": "string",
      "structure": "unknown",
      "amount": "1.00"
    }
  ],
  "attributes": {}
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/products/products/{productId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.put '/products/products/{productId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.put('/products/products/{productId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/products/{productId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/products/products/{productId}", data)
    req.Header = headers

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

Update this product

PUT /products/{productId}

Perform a complete replacement of this product. This creates a new product revision. The new name, if any, must not be in use by another product (whether active or inactive). Changes to the state follow the rules described in this API's description.

To change the state of a product, use the apiture:activate, apiture:deactivate, or apiture:remove links on the resource to /activeProducts, /inactiveProducts, /removedProducts.

The product code may not be changed if the current state is not pending.

Body parameter

{
  "_id": "string",
  "_profile": "https://api.apiture.com/schemas/products/product/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:productType": {
      "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
    },
    "apiture:productSubtype": {
      "href": "/products/productTypes/fa4f2335-3306-4721-b74c-8ec0c77823e9"
    }
  },
  "name": "Premiere Checking",
  "label": "Premiere Checking",
  "description": "A premiere demand deposit checking account for business use.",
  "state": "active",
  "type": "Demand Deposit",
  "subtype": "Demand Deposit with Interest",
  "newAccountAvailability": "available",
  "revision": "2018-04-25T07:56:46.375Z",
  "_embedded": {
    "productType": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      },
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0
    },
    "productSubtype": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      },
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0
    }
  },
  "institutionName": "string",
  "coreType": "string",
  "onlineBankingEnabled": false,
  "target": "personal",
  "currency": "USD",
  "constraints": {
    "transactionTypes": [
      "debit"
    ],
    "minimumBalance": "500.00",
    "minimumFundingAmount": "500.00",
    "maximumFundingAmount": "2500.00",
    "minimumTransferAmount": "25.00",
    "maximumTransferAmount": "10000.00"
  },
  "term": "string",
  "automaticallyRenew": true,
  "debitCardIssuedAt": "2019-01-31T13:31:43.725Z",
  "fees": [
    {
      "type": "service",
      "period": "P1M",
      "description": "string",
      "structure": "unknown",
      "amount": "1.00"
    }
  ],
  "attributes": {}
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:productType": {
      "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
    },
    "apiture:productSubtype": {
      "href": "/products/productTypes/b2134f56-3645-490d-a788-79e974635ae8"
    },
    "apiture:deactivate": {
      "href": "/disabledProducts?product=a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:remove": {
      "href": "/removedProducts?product=a6459cdf-543e-46df-887b-ac5378ee9acd"
    }
  },
  "_embedded": {
    "productType": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    },
    "productSubtype": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0,
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Premiere Checking",
  "label": "Premiere Checking",
  "description": "A premiere demand deposit checking account for business use.",
  "state": "active",
  "type": "Demand Deposit",
  "subtype": "Demand Deposit with Interest",
  "newAccountAvailability": "available"
}

Responses

Response Headers

patchProduct

Code samples

# You can also use wget
curl -X PATCH /products/products/{productId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

PATCH /products/products/{productId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/products/products/{productId}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "string",
  "_profile": "https://api.apiture.com/schemas/products/product/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:productType": {
      "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
    },
    "apiture:productSubtype": {
      "href": "/products/productTypes/fa4f2335-3306-4721-b74c-8ec0c77823e9"
    }
  },
  "name": "Premiere Checking",
  "label": "Premiere Checking",
  "description": "A premiere demand deposit checking account for business use.",
  "state": "active",
  "type": "Demand Deposit",
  "subtype": "Demand Deposit with Interest",
  "newAccountAvailability": "available",
  "revision": "2018-04-25T07:56:46.375Z",
  "_embedded": {
    "productType": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      },
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0
    },
    "productSubtype": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      },
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0
    }
  },
  "institutionName": "string",
  "coreType": "string",
  "onlineBankingEnabled": false,
  "target": "personal",
  "currency": "USD",
  "constraints": {
    "transactionTypes": [
      "debit"
    ],
    "minimumBalance": "500.00",
    "minimumFundingAmount": "500.00",
    "maximumFundingAmount": "2500.00",
    "minimumTransferAmount": "25.00",
    "maximumTransferAmount": "10000.00"
  },
  "term": "string",
  "automaticallyRenew": true,
  "debitCardIssuedAt": "2019-01-31T13:31:43.727Z",
  "fees": [
    {
      "type": "service",
      "period": "P1M",
      "description": "string",
      "structure": "unknown",
      "amount": "1.00"
    }
  ],
  "attributes": {}
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/products/products/{productId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.patch '/products/products/{productId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.patch('/products/products/{productId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/products/{productId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/products/products/{productId}", data)
    req.Header = headers

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

Update this product

PATCH /products/{productId}

Perform a partial update of this product. This creates a new product revision. Fields which are omitted are not updated. The new name, if any, must not be in use by another product (whether active or inactive). Changes to the state follow the rules described in this API's description.

To change the state of a product, use the apiture:activate, apiture:deactivate, or apiture:remove links on the resource to /activeProducts, /inactiveProducts, /removedProducts.

The product code may not be changed if the current state is not pending.

Body parameter

{
  "_id": "string",
  "_profile": "https://api.apiture.com/schemas/products/product/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:productType": {
      "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
    },
    "apiture:productSubtype": {
      "href": "/products/productTypes/fa4f2335-3306-4721-b74c-8ec0c77823e9"
    }
  },
  "name": "Premiere Checking",
  "label": "Premiere Checking",
  "description": "A premiere demand deposit checking account for business use.",
  "state": "active",
  "type": "Demand Deposit",
  "subtype": "Demand Deposit with Interest",
  "newAccountAvailability": "available",
  "revision": "2018-04-25T07:56:46.375Z",
  "_embedded": {
    "productType": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      },
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0
    },
    "productSubtype": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      },
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0
    }
  },
  "institutionName": "string",
  "coreType": "string",
  "onlineBankingEnabled": false,
  "target": "personal",
  "currency": "USD",
  "constraints": {
    "transactionTypes": [
      "debit"
    ],
    "minimumBalance": "500.00",
    "minimumFundingAmount": "500.00",
    "maximumFundingAmount": "2500.00",
    "minimumTransferAmount": "25.00",
    "maximumTransferAmount": "10000.00"
  },
  "term": "string",
  "automaticallyRenew": true,
  "debitCardIssuedAt": "2019-01-31T13:31:43.727Z",
  "fees": [
    {
      "type": "service",
      "period": "P1M",
      "description": "string",
      "structure": "unknown",
      "amount": "1.00"
    }
  ],
  "attributes": {}
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:productType": {
      "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
    },
    "apiture:productSubtype": {
      "href": "/products/productTypes/b2134f56-3645-490d-a788-79e974635ae8"
    },
    "apiture:deactivate": {
      "href": "/disabledProducts?product=a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:remove": {
      "href": "/removedProducts?product=a6459cdf-543e-46df-887b-ac5378ee9acd"
    }
  },
  "_embedded": {
    "productType": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    },
    "productSubtype": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0,
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Premiere Checking",
  "label": "Premiere Checking",
  "description": "A premiere demand deposit checking account for business use.",
  "state": "active",
  "type": "Demand Deposit",
  "subtype": "Demand Deposit with Interest",
  "newAccountAvailability": "available"
}

Responses

Response Headers

deleteProduct

Code samples

# You can also use wget
curl -X DELETE /products/products/{productId} \
  -H 'Accept: application/hal+json'

DELETE /products/products/{productId} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/products/products/{productId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/products/products/{productId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.delete '/products/products/{productId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.delete('/products/products/{productId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/products/{productId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/products/products/{productId}", data)
    req.Header = headers

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

Delete this product resource

DELETE /products/{productId}

Delete this product resource and any resources that are owned by it. A product may only be deleted if its state is pending.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

400 Response

{
  "_profile": "https://api.apiture.com/schemas/error/v1.0.0/.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/error/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2019-01-31T13:31:40.656Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

getProductRevisions

Code samples

# You can also use wget
curl -X GET /products/products/{productId}/revisions \
  -H 'Accept: application/hal+json'

GET /products/products/{productId}/revisions HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/products/products/{productId}/revisions',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/products/products/{productId}/revisions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/products/products/{productId}/revisions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/products/products/{productId}/revisions', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/products/{productId}/revisions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/products/products/{productId}/revisions", data)
    req.Header = headers

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

Return a collection of product revisions

GET /products/{productId}/revisions

Return a paginated sortable filterable searchable collection of product revisions. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/products/products/v0.3.0/profile.json",
  "start": 0,
  "limit": 10,
  "count": 42,
  "name": "products",
  "_links": {
    "self": {
      "href": "/products?start=0&limit=10"
    },
    "first": {
      "href": "/products?start=10&limit=10"
    },
    "next": {
      "href": "/products?start=10&limit=10"
    },
    "collection": {
      "href": "/products"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
        "name": "Premiere Checking",
        "label": "Premiere Checking",
        "description": "A premiere demand deposit checking account for business use.",
        "state": "active",
        "newAccountAvailability": "available",
        "category": "DDA",
        "revision": "2019-01-31T13:31:40.656Z",
        "rate": {
          "value": "1.40",
          "type": "apr"
        },
        "_links": {
          "apiture:productType": {
            "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
          },
          "apiture:productSubtype": {
            "href": "/products/productTypes/b2134f56-3645-490d-a788-79e974635ae8"
          },
          "self": {
            "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
          }
        }
      }
    ]
  }
}

Responses

getProductRevision

Code samples

# You can also use wget
curl -X GET /products/products/{productId}/revisions/{revisionId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string'

GET /products/products/{productId}/revisions/{revisionId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

$.ajax({
  url: '/products/products/{productId}/revisions/{revisionId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

fetch('/products/products/{productId}/revisions/{revisionId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string'
}

result = RestClient.get '/products/products/{productId}/revisions/{revisionId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string'
}

r = requests.get('/products/products/{productId}/revisions/{revisionId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/products/{productId}/revisions/{revisionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/products/products/{productId}/revisions/{revisionId}", data)
    req.Header = headers

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

Fetch a representation of an immutable revision of this product

GET /products/{productId}/revisions/{revisionId}

Return an immutable HAL representation of this revision of this product resource. The revision may also have prev and next links to previous and/or next revisions, if they exist.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:productType": {
      "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
    },
    "apiture:productSubtype": {
      "href": "/products/productTypes/b2134f56-3645-490d-a788-79e974635ae8"
    },
    "apiture:deactivate": {
      "href": "/disabledProducts?product=a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:remove": {
      "href": "/removedProducts?product=a6459cdf-543e-46df-887b-ac5378ee9acd"
    }
  },
  "_embedded": {
    "productType": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    },
    "productSubtype": {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit with Interest",
      "label": "Demand Deposit with Interest",
      "description": "A demand deposit checking account with interest.",
      "state": "active",
      "subtype": true,
      "subtypeCount": 0,
      "_links": {
        "self": {
          "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
        },
        "apiture:parent": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Premiere Checking",
  "label": "Premiere Checking",
  "description": "A premiere demand deposit checking account for business use.",
  "state": "active",
  "type": "Demand Deposit",
  "subtype": "Demand Deposit with Interest",
  "newAccountAvailability": "available"
}

Responses

Response Headers

unlockProduct

Code samples

# You can also use wget
curl -X POST /products/unlockedProducts?product=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

POST /products/unlockedProducts?product=string HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/products/unlockedProducts',
  method: 'post',
  data: '?product=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/products/unlockedProducts?product=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.post '/products/unlockedProducts',
  params: {
  'product' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.post('/products/unlockedProducts', params={
  'product': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/products/unlockedProducts?product=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/products/unlockedProducts", data)
    req.Header = headers

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

Marks an active product as eligible for new account opening

POST /unlockedProducts

Marks an active product as eligible for new account opening.

This POST operation is invoked from the apiture:unlock link on a product.

This changes the newAccountAvailability to available.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    },
    "apiture:parent": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    },
    "apiture:deactivate": {
      "title": "Deactivate this product type",
      "href": "/products/inactiveProductTypes?productType=eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    }
  },
  "_embedded": {
    "parent": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        },
        "apiture:deactivate": {
          "href": "/disabledProductTypes?productType=4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Demand Deposit with interest",
  "label": "Demand Deposit with Interest",
  "description": "A demand deposit checking account with interest.",
  "state": "active",
  "subtype": true,
  "subtypeCount": 0
}

Responses

lockProduct

Code samples

# You can also use wget
curl -X POST /products/lockedProducts?product=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

POST /products/lockedProducts?product=string HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/products/lockedProducts',
  method: 'post',
  data: '?product=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/products/lockedProducts?product=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.post '/products/lockedProducts',
  params: {
  'product' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.post('/products/lockedProducts', params={
  'product': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/products/lockedProducts?product=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/products/lockedProducts", data)
    req.Header = headers

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

Marks an active product as ineligible for new account opening

POST /lockedProducts

Marks an active product as ineligible for new account opening. Users may not open new accounts with this product, thus the product is "locked".

This POST operation is invoked from the apiture:lock link on a product.

This changes the newAccountAvailability to notAvailable.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    },
    "apiture:parent": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    },
    "apiture:deactivate": {
      "title": "Deactivate this product type",
      "href": "/products/inactiveProductTypes?productType=eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    }
  },
  "_embedded": {
    "parent": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        },
        "apiture:deactivate": {
          "href": "/disabledProductTypes?productType=4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Demand Deposit with interest",
  "label": "Demand Deposit with Interest",
  "description": "A demand deposit checking account with interest.",
  "state": "active",
  "subtype": true,
  "subtypeCount": 0
}

Responses

activateProduct

Code samples

# You can also use wget
curl -X POST /products/activeProducts?product=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

POST /products/activeProducts?product=string HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/products/activeProducts',
  method: 'post',
  data: '?product=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/products/activeProducts?product=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.post '/products/activeProducts',
  params: {
  'product' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.post('/products/activeProducts', params={
  'product': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/products/activeProducts?product=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/products/activeProducts", data)
    req.Header = headers

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

Activate a product

POST /activeProducts

Activate a product that is eligible to be activated. Only product types which are pending or inactive may be activated.

This POST operation is invoked from the apiture:activate link on a product.

This changes the state to active.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    },
    "apiture:parent": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    },
    "apiture:deactivate": {
      "title": "Deactivate this product type",
      "href": "/products/inactiveProductTypes?productType=eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    }
  },
  "_embedded": {
    "parent": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        },
        "apiture:deactivate": {
          "href": "/disabledProductTypes?productType=4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Demand Deposit with interest",
  "label": "Demand Deposit with Interest",
  "description": "A demand deposit checking account with interest.",
  "state": "active",
  "subtype": true,
  "subtypeCount": 0
}

Responses

deactivateProduct

Code samples

# You can also use wget
curl -X POST /products/inactiveProducts?product=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

POST /products/inactiveProducts?product=string HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/products/inactiveProducts',
  method: 'post',
  data: '?product=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/products/inactiveProducts?product=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.post '/products/inactiveProducts',
  params: {
  'product' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.post('/products/inactiveProducts', params={
  'product': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/products/inactiveProducts?product=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/products/inactiveProducts", data)
    req.Header = headers

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

Deactivate a product

POST /inactiveProducts

Deactivate a product that is eligible to be deactivated.

Only products which are pending or active and which are not in use by any pending, active or inactive accounts types may be deactivated.

This POST operation is invoked from the apiture:deactivate link on a product when it is eligible to be deactivated.

This changes the state to inactive.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    },
    "apiture:parent": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    },
    "apiture:deactivate": {
      "title": "Deactivate this product type",
      "href": "/products/inactiveProductTypes?productType=eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    }
  },
  "_embedded": {
    "parent": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        },
        "apiture:deactivate": {
          "href": "/disabledProductTypes?productType=4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Demand Deposit with interest",
  "label": "Demand Deposit with Interest",
  "description": "A demand deposit checking account with interest.",
  "state": "active",
  "subtype": true,
  "subtypeCount": 0
}

Responses

removeProduct

Code samples

# You can also use wget
curl -X POST /products/removedProducts?product=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

POST /products/removedProducts?product=string HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/products/removedProducts',
  method: 'post',
  data: '?product=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/products/removedProducts?product=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.post '/products/removedProducts',
  params: {
  'product' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.post('/products/removedProducts', params={
  'product': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("/products/removedProducts?product=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/products/removedProducts", data)
    req.Header = headers

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

Remove a product

POST /removedProducts

Remove a product that is eligible to be removed.

Only products which are active or inactive and which are not used by any non-closed accounts may be removed.

This POST operation is invoked from the apiture:remove link on a product when it is eligible to be removed.

This changes the state to removed.

Removing a product will append the timestamp with the format "(Removed yyyy-mm-ddTHH:MM:SSZ)" to the name, so that the previous name may be used for other products.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    },
    "apiture:parent": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    },
    "apiture:deactivate": {
      "title": "Deactivate this product type",
      "href": "/products/inactiveProductTypes?productType=eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    }
  },
  "_embedded": {
    "parent": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        },
        "apiture:deactivate": {
          "href": "/disabledProductTypes?productType=4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Demand Deposit with interest",
  "label": "Demand Deposit with Interest",
  "description": "A demand deposit checking account with interest.",
  "state": "active",
  "subtype": true,
  "subtypeCount": 0
}

Responses

Product Type

Banking Product Types

getProductTypes

Code samples

# You can also use wget
curl -X GET /products/productTypes \
  -H 'Accept: application/hal+json'

GET /products/productTypes HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/products/productTypes',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/products/productTypes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/products/productTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/products/productTypes', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/productTypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/products/productTypes", data)
    req.Header = headers

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

Return a collection of product types

GET /productTypes

Return a paginated sortable filterable searchable collection of product types. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/products/productsTypes/v0.3.0/profile.json",
  "start": 0,
  "limit": 10,
  "count": 127,
  "name": "productTypes",
  "_links": {
    "self": {
      "href": "/products?start=0&limit=10"
    },
    "first": {
      "href": "/products?start=0&limit=10"
    },
    "next": {
      "href": "/products?start=10&limit=10"
    },
    "collection": {
      "href": "/products"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
        "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
        "name": "Demand Deposit",
        "label": "Demand Deposit",
        "description": "A demand deposit checking account.",
        "state": "active",
        "subtype": false,
        "subtypeCount": 1,
        "_links": {
          "self": {
            "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
          }
        }
      },
      {
        "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
        "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
        "name": "Demand Deposit with Interest",
        "label": "Demand Deposit with Interest",
        "description": "A demand deposit checking account with interest.",
        "state": "active",
        "subtype": true,
        "subtypeCount": 0,
        "_links": {
          "self": {
            "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
          },
          "apiture:parent": {
            "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
          }
        }
      }
    ]
  }
}

Responses

createProductType

Code samples

# You can also use wget
curl -X POST /products/productTypes \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json'

POST /products/productTypes HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/products/productTypes',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "name": "Demand Deposit with Interest",
  "label": "Demand Deposit with Interest",
  "description": "A demand deposit checking account, a subtype of the base Demand Deposit account.",
  "_links": {
    "apiture:parent": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

fetch('/products/productTypes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json'
}

result = RestClient.post '/products/productTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json'
}

r = requests.post('/products/productTypes', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/productTypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/products/productTypes", data)
    req.Header = headers

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

Create a new product type

POST /productTypes

Create a new product type or subtype. The request may include a parent type in order to create a subtype. The parent type may not be a subtype. The name must be unique and the state may not be removed.

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "name": "Demand Deposit with Interest",
  "label": "Demand Deposit with Interest",
  "description": "A demand deposit checking account, a subtype of the base Demand Deposit account.",
  "_links": {
    "apiture:parent": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

201 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    },
    "apiture:parent": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    },
    "apiture:deactivate": {
      "title": "Deactivate this product type",
      "href": "/products/inactiveProductTypes?productType=eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    }
  },
  "_embedded": {
    "parent": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        },
        "apiture:deactivate": {
          "href": "/disabledProductTypes?productType=4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Demand Deposit with interest",
  "label": "Demand Deposit with Interest",
  "description": "A demand deposit checking account with interest.",
  "state": "active",
  "subtype": true,
  "subtypeCount": 0
}

Responses

Response Headers

getProductType

Code samples

# You can also use wget
curl -X GET /products/productTypes/{productTypeId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string'

GET /products/productTypes/{productTypeId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

$.ajax({
  url: '/products/productTypes/{productTypeId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

fetch('/products/productTypes/{productTypeId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string'
}

result = RestClient.get '/products/productTypes/{productTypeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string'
}

r = requests.get('/products/productTypes/{productTypeId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/productTypes/{productTypeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/products/productTypes/{productTypeId}", data)
    req.Header = headers

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

Fetch a representation of this product type.

GET /productTypes/{productTypeId}

Return a HAL representation of this product type resource. See the description of the productType model schema for the links that may be found in a product type representation.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    },
    "apiture:parent": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    },
    "apiture:deactivate": {
      "title": "Deactivate this product type",
      "href": "/products/inactiveProductTypes?productType=eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    }
  },
  "_embedded": {
    "parent": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        },
        "apiture:deactivate": {
          "href": "/disabledProductTypes?productType=4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Demand Deposit with interest",
  "label": "Demand Deposit with Interest",
  "description": "A demand deposit checking account with interest.",
  "state": "active",
  "subtype": true,
  "subtypeCount": 0
}

Responses

Response Headers

updateProductType

Code samples

# You can also use wget
curl -X PUT /products/productTypes/{productTypeId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

PUT /products/productTypes/{productTypeId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/products/productTypes/{productTypeId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "name": "Demand Deposit",
  "label": "Demand Deposit",
  "subtype": false,
  "description": "A demand deposit checking account.",
  "_links": {
    "self": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/products/productTypes/{productTypeId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.put '/products/productTypes/{productTypeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.put('/products/productTypes/{productTypeId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/productTypes/{productTypeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/products/productTypes/{productTypeId}", data)
    req.Header = headers

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

Update this product type

PUT /productTypes/{productTypeId}

Perform a complete replacement of this product type. Changes to the state follow the rules described in this API's description.

To change the state of a product type, use the apiture:activate, apiture:deactivate, or apiture:remove links on the resource to POST the product type URI to one of the paths, /activeProductTypes, /inactiveProductTypes, /removedProductTypes.

Body parameter

{
  "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "name": "Demand Deposit",
  "label": "Demand Deposit",
  "subtype": false,
  "description": "A demand deposit checking account.",
  "_links": {
    "self": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    },
    "apiture:parent": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    },
    "apiture:deactivate": {
      "title": "Deactivate this product type",
      "href": "/products/inactiveProductTypes?productType=eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    }
  },
  "_embedded": {
    "parent": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        },
        "apiture:deactivate": {
          "href": "/disabledProductTypes?productType=4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Demand Deposit with interest",
  "label": "Demand Deposit with Interest",
  "description": "A demand deposit checking account with interest.",
  "state": "active",
  "subtype": true,
  "subtypeCount": 0
}

Responses

Response Headers

patchProductType

Code samples

# You can also use wget
curl -X PATCH /products/productTypes/{productTypeId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

PATCH /products/productTypes/{productTypeId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/products/productTypes/{productTypeId}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "name": "Demand Deposit",
  "label": "Demand Deposit",
  "subtype": false,
  "description": "A demand deposit checking account.",
  "_links": {
    "self": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/products/productTypes/{productTypeId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.patch '/products/productTypes/{productTypeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.patch('/products/productTypes/{productTypeId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/products/productTypes/{productTypeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
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());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/products/productTypes/{productTypeId}", data)
    req.Header = headers

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

Update this product type

PATCH /productTypes/{productTypeId}

Perform a partial update of this product type. Fields which are omitted are not updated. Changes to the state follow the rules described in this API's description.

To change the state of a product type, use the apiture:activate, apiture:deactivate, or apiture:remove links on the resource to /activeProductTypes, /inactiveProductTypes, /removedProductTypes.

Body parameter

{
  "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "name": "Demand Deposit",
  "label": "Demand Deposit",
  "subtype": false,
  "description": "A demand deposit checking account.",
  "_links": {
    "self": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
  "_links": {
    "self": {
      "href": "/products/productTypes/eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    },
    "apiture:parent": {
      "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
    },
    "apiture:deactivate": {
      "title": "Deactivate this product type",
      "href": "/products/inactiveProductTypes?productType=eccb54ed-0f0a-443b-9f2e-32d5b8f4371c"
    }
  },
  "_embedded": {
    "parent": {
      "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
      "_profile": "https://api.apiture.com/schemas/products/productType/v0.3.0/profile.json",
      "name": "Demand Deposit",
      "label": "Demand Deposit",
      "description": "A demand deposit checking account.",
      "state": "active",
      "subtype": false,
      "subtypeCount": 1,
      "_links": {
        "self": {
          "href": "/products/productTypes/4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        },
        "apiture:deactivate": {
          "href": "/disabledProductTypes?productType=4ea6fe4e-405c-4d71-93e3-ad637b5cab2d"
        }
      }
    }
  },
  "name": "Demand Deposit with interest",
  "label": "Demand Deposit with Interest",
  "description": "A demand deposit checking account with interest.",
  "state": "active",
  "subtype": true,
  "subtypeCount": 0
}

Responses

Response Headers

deleteProductType