Shell HTTP JavaScript Node.JS Ruby Python Java Go

Banking Products v0.22.1

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. Products and product types each have a name, a description a label, and a state.

The state may be one of the following:

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:

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.

This resource is a copy of the banking product resources in the bank core.

Error Types

Error responses in this API may have one of the type values described below. See Errors for more information on error responses and error types.

activateProductInvalidState

Description: Products may only be activated if they are in an inactive or pending state.
Remediation: Check the state of your Product and the applicable allowed state transitions in the Products API documentation.

activateProductSubTypeInvalidState

Description: The state of the resource may not be changed to active or inactive when the product type or subtype is still pending.
Remediation: Check the state of your product type and subtype and ensure it is not pending.

canOnlyLockUnlockActive

Description: You can only lock or unlock a product if its state is active.
Remediation: Activate the product and resubmit the operation.

cannotChangeRateType

Description: The products rate type may not be changed once created.
Remediation: Remove the product and recreate it with the desired rate type or create a new product.

cannotChangeRemovedProductTypeState

Description: The state of a removed productType may not be changed.
Remediation: Check the state of the productType and ensure it is not removed.

cannotPatchProductFields

Description: A products _id and newAccountAvailability cannot be patched.
Remediation: Remove the _id and newAccountAvailability from the request body and try again.

cannotUpdateProductTypeState

Description: The state of a productType cannot be changed using a PUT method.
Remediation: Check the API documentation for the /activeProductTypes, /inactiveProductTypes, and /removedProductTypes endpoints.

deactivateProductInvalidState

Description: Products may only be deactivated if they are in a pending or active state.
Remediation: Check the state of your Product and the applicable allowed state transitions in the Products API documentation.

deleteProductInvalidState

Description: Products may only be deleted if they are in a pending state.
Remediation: Check the state of your Product and the applicable allowed state transitions in the Products API documentation.

deleteProductTypeInvalidState

Description: A product type may not be deleted if the state is anything other than pending, or if the type is used by a pending product.
Remediation: Check the state of the productType and ensure it is not pending. Also ensure that any products using the productType are not pending.

ifMatchHeaderDoesNotMatch

Description: The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Remediation: Resubmit the operation, supplying the value of the ETag and the most recent state of the resource.

invalidAccountAvailability

Description: The product new account availability is not valid.
Remediation: Resubmit the operation and supply a valid product new account availability value.

invalidConstraintItemAmount

Description: The given fees item amount value is not valid.
Remediation: Check to make sure the fees item amount is a valid numerical value. Also make sure the value is greater than 0.

invalidConstraintMaxFundingAmount

Description: The given maximumFundingAmount value is not valid.
Remediation: Check to make sure the maximumFundingAmount is a valid numerical value. Also make sure the value is greater than minimum value and the value is greater than 0.

invalidConstraintMaxTransferAmount

Description: The given maximumTransferAmount value is not valid.
Remediation: Check to make sure the maximumTransferAmount is a valid numerical value. Also make sure the value is greater than minimum value and the value is greater than 0.

invalidConstraintMinBalance

Description: The given minimumBalance value is not valid.
Remediation: Check to make sure the minimumBalance is a valid numerical value. Also make sure the value is greater than minimum value and the value is greater than 0.

invalidConstraintMinFundingAmount

Description: The given minimumFundingAmount value is not valid.
Remediation: Check to make sure the minimumFundingAmount is a valid numerical value. Also make sure the value is greater than minimum value and the value is greater than 0.

invalidConstraintMinTransferAmount

Description: The given minimumTransferAmount value is not valid.
Remediation: Check to make sure the minimumTransferAmount is a valid numerical value. Also make sure the value is greater than minimum value and the value is greater than 0.

invalidFeesType

Description: The fee must be an array.
Remediation: Check the type of the fee field and resubmit.

invalidProductId

Description: No Products were found for the specified productId.
Remediation: Check to make sure that the supplied productId corresponds to an apiture product resource.

invalidProductLinkToSubType

Description: A link to apiture:productSubtype is missing or is invalid.
Remediation: Check to make sure the product has a valid subtype or that the subtype exists.

invalidProductState

Description: The supplied product state is invalid.
Remediation: Resubmit the operation, supplying a valid product state.

The attributes object in the error may have the following properties:

Property Type Description
validStates [string] The required states for this operation

invalidProductTypeId

Description: No product types were found for the specified productTypeId.
Remediation: Check to make sure that the supplied productType corresponds to an apiture product type resource.

invalidQueryParameterCombination

Description: Do not use mutually exclusive query parameters.
Remediation: Use one or the other, but not both.

The attributes object in the error may have the following properties:

Property Type Description
mutuallyExclusiveQueryParameters [string] undefined
Example: state,openable

invalidRateValues

Description: The rate object contains invalid values.
Remediation: Check the values of the rate object and resubmit.

invalidTransactionTypes

Description: The given transaction type is not valid.
Remediation: Resubmit the operation and supply a valid transaction type.

malformedCreateProductBody

Description: The supplied request body to create a product did not contain a description or label.
Remediation: Resubmit the request with a description and label in the body.

malformedProduct

Description: The supplied product was malformed.
Remediation: Check to make sure that the supplied product parameter corresponds to an apiture product resource.

The attributes object in the error may have the following properties:

Property Type Description
product string The URI or the ID of an existing product

malformedProductType

Description: The supplied productType was malformed.
Remediation: Check to make sure that the supplied productType corresponds to an apiture productType resource.

The attributes object in the error may have the following properties:

Property Type Description
productType string The invalid product type URI.

malformedRequestBody

Description: The supplied request body was malformed.
Remediation: Check to make sure that your request body exists and that it does not contain syntax errors.

productCodeInUse

Description: The given product code is currently in use, and cannot be reused.
Remediation: Delete the product with the specified code, or use a different code.

productNameInUse

Description: The given product name is currently in use, and cannot be reused.
Remediation: Delete the product with the specified name, or use a different name.

productStateCannotBeAltered

Description: A products state cannot be altered using the PATCH operation.
Remediation: Check the API documentation for the /activeProducts, /inactiveProducts, /removedProducts, /lockedProducts, and /unlockedProducts endpoints.

productTypeDoesNotExist

Description: The given product type does not exist.
Remediation: Verify that the product type exists for the subtype or parent type and resubmit.

removeProductInvalidState

Description: Products may only be removed if they are in an inactive or active state.
Remediation: Check the state of your Product and the applicable allowed state transitions in the Products API documentation.

removeProductTypeInvalidState

Description: A product type may not be updated if the state is removed.
Remediation: Check the state of the productType and ensure it not removed.

updateProductTypeInvalidState

Description: A product type may not be removed if the state is anything other than inactive.
Remediation: Check the state of the productType and ensure it is inactive.

Download OpenAPI Definition (YAML)

Base URLs:

Terms of service

Email: Apiture Web: Apiture

Authentication

Scope Scope Description
admin/read Read admin access to non-account, non-profile data.
admin/write Write admin access to non-account, non-profile data.
admin/delete Delete admin access to non-account, non-profile data.

Product

Banking Products

getProducts

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/products/products \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/products/products HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/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',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/products/products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/products/products', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/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

Parameter Description
start
(query)
integer(int64)
The zero-based index of the first product in this page. The default, 0, represents the first page of the collection.
limit
(query)
integer(int32)
The maximum number of product representations to return in this page.
Default: 100
sortBy
(query)
string
Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
This collection may be sorted by following properties:
state
type
name
code
category
target
label
name
(query)
string
Subset the products or product types collection to those with this name value. This is combined with an implicit and with other filters if they are used. See filtering.
type
(query)
string
Subset the products or product types collection to those with this exact type value. This is combined with an implicit and with other filters if they are used. See filtering.
code
(query)
string
Subset the products or product types collection to those whose code matches this value. Use | to separate multiple values. For example, ?type=B2001 matches only items whose type is B2001, but ?type=B2001|B3002 matches items whose type is B2001 or B3002. This is combined with an implicit and with ?state ?filter if they are used. See filtering.
category
(query)
string
Subset the products or product types collection to those whose category matches this value. Use | to separate multiple values. For example, ?category=Savings matches only items whose category is Savings, but ?category=Savings|Checking matches items whose type is Savings or Checking. This is combined with an implicit and with other filters if they are used. See filtering.
state
(query)
string
Subset the products or product types collection to those whose state matches this value. Use | to separate multiple values. For example, ?state=pending matches only items whose state is pending; ?state=removed|inactive matches items whose state is removed or inactive. This is combined with an implicit and with other filters if they are used. See filtering.
target
(query)
string
Subset the products or product types collection to those whose target matches this value (personal or business). For example, ?target=personal matches only items whose target is personal. This is combined with an implicit and with other filters if they are used. See filtering.
Enumerated values:
personal
business
ifxType
(query)
string
Subset the products collection to those whose ifxType matches this value. Use | to separate multiple values. For example, ?ifxType=SDA matches only items whose ifxType is SDA; ?ifxType=SDA|DDA matches items whose ifxType is SDA or DDA. This is combined with an implicit and with other filters if they are used. See filtering.
filter
(query)
string
Optional filter criteria. See filtering.
This collection may be filtered by following properties and functions:
• Property code using functions eq, ne, in
• Property category using functions eq, ne, in
• Property openable using functions eq, ne, not
• Property name using functions eq, ne, lt, le, gt, ge, startsWith, endsWith, contains, search
• Property label using functions eq, ne, startsWith, endsWith, contains, search
• Property state using functions eq, ne, in
• Property target using functions eq, ne
• Property type using functions eq, ne, in
• Property newAccountAvailability using functions eq, ne
• Property ifxType using functions eq, ne, in
• Property _id using functions eq, in
q
(query)
string
Optional search string. See searching.
openable
(query)
boolean
If true, filter only by products whose state is active and newAccountAvailability is available. For example, ?openable=true is equivalent to ?state=active&newAccountAvailability=available .
newAccountAvailability
(query)
string
Subset the result to only those whose newAccountAvailability property matches this value.
Enumerated values:
available
notAvailable
productType
(query)
string
Subset the result to only products that use the product type identified by this value. The value is the _id of a product type instance. (This query parameter is used to implement the apiture:products link relation on a product type resource.)

Try It

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/products/products/v2.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": "Checking",
      "rate": {
        "value": "1.40",
        "type": "apy"
      },
      "rates": {
        "apy": "1.40",
        "compoundPeriod": "P1D"
      },
      "_profile": "https://api.apiture.com/schemas/products/summaryProduct/v2.3.0/profile.json",
      "_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

StatusDescription
200 OK
OK
Schema: products
StatusDescription
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
409 Conflict

Conflict. Query parameters are in conflict. Do not use both ?orderable= and ?state= query parameters.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

createProduct

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/products/products \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/products/products HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/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/createProduct/v2.1.0/profile.json",
  "name": "Business Checking",
  "label": "Business Checking",
  "description": "A demand deposit checking account for business use.",
  "code": "B2001",
  "category": "Checking",
  "rates": {
    "apy": "1.41",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "card": {
    "provider": {
      "id": "DDA_203389"
    },
    "images": [
      {
        "height": 1024,
        "width": 833,
        "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
      }
    ],
    "activationExpiration": 30,
    "expeditedShippingAllowed": {
      "forNew": true,
      "forReplacements": true
    },
    "autoOrder": {
      "forDigitalAccountOpening": true,
      "forJointOwners": true,
      "forAuthorizedSigners": true
    }
  },
  "_links": {
    "apiture:productSubtype": {
      "href": "/products/productTypes/b2134f56-3645-490d-a788-79e974635ae8"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/products/products',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/products/products', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/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. POST to the apiture:activate link after creating a product to activate it.

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/products/createProduct/v2.1.0/profile.json",
  "name": "Business Checking",
  "label": "Business Checking",
  "description": "A demand deposit checking account for business use.",
  "code": "B2001",
  "category": "Checking",
  "rates": {
    "apy": "1.41",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "card": {
    "provider": {
      "id": "DDA_203389"
    },
    "images": [
      {
        "height": 1024,
        "width": 833,
        "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
      }
    ],
    "activationExpiration": 30,
    "expeditedShippingAllowed": {
      "forNew": true,
      "forReplacements": true
    },
    "autoOrder": {
      "forDigitalAccountOpening": true,
      "forJointOwners": true,
      "forAuthorizedSigners": true
    }
  },
  "_links": {
    "apiture:productSubtype": {
      "href": "/products/productTypes/b2134f56-3645-490d-a788-79e974635ae8"
    }
  }
}

Parameters

Parameter Description
copyOf
(query)
string(uri)
To make a copy of an existing product, pass the URI of the original product. Fields in the request body will override the values copied from the existing product. The new name must be passed in the body, since names must be unique.
body
(body)
createProduct (required)
The data necessary to create a new product.

Try It

Example responses

201 Response

{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v2.3.0/profile.json",
  "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",
  "target": "business",
  "newAccountAvailability": "available",
  "ifxType": "DDA",
  "rates": {
    "apy": "1.45",
    "nominal": "1.455",
    "apye": "1.45",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "card": {
    "provider": {
      "id": "DDA_203389"
    },
    "images": [
      {
        "height": 1024,
        "width": 833,
        "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
      }
    ],
    "activationExpiration": 30,
    "expeditedShippingAllowed": {
      "forNew": true,
      "forReplacements": true
    },
    "autoOrder": {
      "forDigitalAccountOpening": true,
      "forJointOwners": false,
      "forAuthorizedSigners": true
    }
  },
  "highlights": [
    "FDIC Insurance",
    "No Monthly Maintenance Fees",
    "Minimum Deposit of $2,500"
  ],
  "coreBanking": {
    "finxact": {
      "productGroup": "1",
      "productSegments": {
        "deptId": "350",
        "vertical": "01"
      }
    }
  },
  "paymentsEnabled": true,
  "checkOrderingEnabled": true,
  "_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/v1.0.1/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/v1.0.1/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

StatusDescription
201 Created
Created
Schema: product
StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of an active or inactive resource may not be changed to pending.
  • The state of a removed resource may not be changed.
  • The state of the resource may not be changed to active or inactive when the product type or subtype is still `pending'.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use, or the selected subtype is not a subtype of the selected product type.
  • An attempt to set a product's newAccountAvailability to true when the product state is inactive.
  • An attempt to set a product's code when the product state is not pending.
  • An attempt to set a product's code to a value that is used in another product.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
201 Location string uri
The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with scheme://host .
201 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource.

getProduct

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/products/products/{productId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/products/products/{productId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/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',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/products/products/{productId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/products/products/{productId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/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.

Parameters

Parameter Description
productId
(path)
string (required)
The unique identifier of this product. This is an opaque string.
If-None-Match
(header)
string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Try It

Example responses

200 Response

{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v2.3.0/profile.json",
  "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",
  "target": "business",
  "newAccountAvailability": "available",
  "ifxType": "DDA",
  "rates": {
    "apy": "1.45",
    "nominal": "1.455",
    "apye": "1.45",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "card": {
    "provider": {
      "id": "DDA_203389"
    },
    "images": [
      {
        "height": 1024,
        "width": 833,
        "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
      }
    ],
    "activationExpiration": 30,
    "expeditedShippingAllowed": {
      "forNew": true,
      "forReplacements": true
    },
    "autoOrder": {
      "forDigitalAccountOpening": true,
      "forJointOwners": false,
      "forAuthorizedSigners": true
    }
  },
  "highlights": [
    "FDIC Insurance",
    "No Monthly Maintenance Fees",
    "Minimum Deposit of $2,500"
  ],
  "coreBanking": {
    "finxact": {
      "productGroup": "1",
      "productSegments": {
        "deptId": "350",
        "vertical": "01"
      }
    }
  },
  "paymentsEnabled": true,
  "checkOrderingEnabled": true,
  "_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/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: product
StatusDescription
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
StatusDescription
404 Not Found

Not Found. There is no such product resource at the specified {productId} The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
412 Precondition Failed

Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this product resource.

updateProduct

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/products/products/{productId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/products/products/{productId} HTTP/1.1
Host: api.devbank.apiture.com
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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/products/{productId}',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v2.3.0/profile.json",
  "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",
  "target": "business",
  "newAccountAvailability": "available",
  "ifxType": "DDA",
  "rates": {
    "apy": "1.45",
    "nominal": "1.455",
    "apye": "1.45",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "card": {
    "provider": {
      "id": "DDA_203389"
    },
    "images": [
      {
        "height": 1024,
        "width": 833,
        "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
      }
    ],
    "activationExpiration": 30,
    "expeditedShippingAllowed": {
      "forNew": true,
      "forReplacements": true
    },
    "autoOrder": {
      "forDigitalAccountOpening": true,
      "forJointOwners": false,
      "forAuthorizedSigners": true
    }
  },
  "highlights": [
    "FDIC Insurance",
    "No Monthly Maintenance Fees",
    "Minimum Deposit of $2,500"
  ],
  "coreBanking": {
    "finxact": {
      "productGroup": "1",
      "productSegments": {
        "deptId": "350",
        "vertical": "01"
      }
    }
  },
  "paymentsEnabled": true,
  "checkOrderingEnabled": true,
  "_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/v1.0.1/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/v1.0.1/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"
        }
      }
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/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',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/products/products/{productId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/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. 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": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v2.3.0/profile.json",
  "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",
  "target": "business",
  "newAccountAvailability": "available",
  "ifxType": "DDA",
  "rates": {
    "apy": "1.45",
    "nominal": "1.455",
    "apye": "1.45",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "card": {
    "provider": {
      "id": "DDA_203389"
    },
    "images": [
      {
        "height": 1024,
        "width": 833,
        "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
      }
    ],
    "activationExpiration": 30,
    "expeditedShippingAllowed": {
      "forNew": true,
      "forReplacements": true
    },
    "autoOrder": {
      "forDigitalAccountOpening": true,
      "forJointOwners": false,
      "forAuthorizedSigners": true
    }
  },
  "highlights": [
    "FDIC Insurance",
    "No Monthly Maintenance Fees",
    "Minimum Deposit of $2,500"
  ],
  "coreBanking": {
    "finxact": {
      "productGroup": "1",
      "productSegments": {
        "deptId": "350",
        "vertical": "01"
      }
    }
  },
  "paymentsEnabled": true,
  "checkOrderingEnabled": true,
  "_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/v1.0.1/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/v1.0.1/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"
        }
      }
    }
  }
}

Parameters

Parameter Description
productId
(path)
string (required)
The unique identifier of this product. This is an opaque string.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body
(body)
product (required)

Try It

Example responses

200 Response

{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v2.3.0/profile.json",
  "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",
  "target": "business",
  "newAccountAvailability": "available",
  "ifxType": "DDA",
  "rates": {
    "apy": "1.45",
    "nominal": "1.455",
    "apye": "1.45",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "card": {
    "provider": {
      "id": "DDA_203389"
    },
    "images": [
      {
        "height": 1024,
        "width": 833,
        "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
      }
    ],
    "activationExpiration": 30,
    "expeditedShippingAllowed": {
      "forNew": true,
      "forReplacements": true
    },
    "autoOrder": {
      "forDigitalAccountOpening": true,
      "forJointOwners": false,
      "forAuthorizedSigners": true
    }
  },
  "highlights": [
    "FDIC Insurance",
    "No Monthly Maintenance Fees",
    "Minimum Deposit of $2,500"
  ],
  "coreBanking": {
    "finxact": {
      "productGroup": "1",
      "productSegments": {
        "deptId": "350",
        "vertical": "01"
      }
    }
  },
  "paymentsEnabled": true,
  "checkOrderingEnabled": true,
  "_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/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: product
StatusDescription
400 Bad Request

Bad Request. One of the request parameters to update a product was not valid. See _error for more information

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
404 Not Found

Not Found. There is no such product resource at the specified {productId} The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
412 Precondition Failed

Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this product resource.

patchProduct

Code samples

# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/products/products/{productId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.devbank.apiture.com/products/products/{productId} HTTP/1.1
Host: api.devbank.apiture.com
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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/products/{productId}',
  method: 'patch',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v2.3.0/profile.json",
  "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",
  "target": "business",
  "newAccountAvailability": "available",
  "ifxType": "DDA",
  "rates": {
    "apy": "1.45",
    "nominal": "1.455",
    "apye": "1.45",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "card": {
    "provider": {
      "id": "DDA_203389"
    },
    "images": [
      {
        "height": 1024,
        "width": 833,
        "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
      }
    ],
    "activationExpiration": 30,
    "expeditedShippingAllowed": {
      "forNew": true,
      "forReplacements": true
    },
    "autoOrder": {
      "forDigitalAccountOpening": true,
      "forJointOwners": false,
      "forAuthorizedSigners": true
    }
  },
  "highlights": [
    "FDIC Insurance",
    "No Monthly Maintenance Fees",
    "Minimum Deposit of $2,500"
  ],
  "coreBanking": {
    "finxact": {
      "productGroup": "1",
      "productSegments": {
        "deptId": "350",
        "vertical": "01"
      }
    }
  },
  "paymentsEnabled": true,
  "checkOrderingEnabled": true,
  "_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/v1.0.1/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/v1.0.1/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"
        }
      }
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.devbank.apiture.com/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',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.devbank.apiture.com/products/products/{productId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.devbank.apiture.com/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. 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": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v2.3.0/profile.json",
  "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",
  "target": "business",
  "newAccountAvailability": "available",
  "ifxType": "DDA",
  "rates": {
    "apy": "1.45",
    "nominal": "1.455",
    "apye": "1.45",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "card": {
    "provider": {
      "id": "DDA_203389"
    },
    "images": [
      {
        "height": 1024,
        "width": 833,
        "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
      }
    ],
    "activationExpiration": 30,
    "expeditedShippingAllowed": {
      "forNew": true,
      "forReplacements": true
    },
    "autoOrder": {
      "forDigitalAccountOpening": true,
      "forJointOwners": false,
      "forAuthorizedSigners": true
    }
  },
  "highlights": [
    "FDIC Insurance",
    "No Monthly Maintenance Fees",
    "Minimum Deposit of $2,500"
  ],
  "coreBanking": {
    "finxact": {
      "productGroup": "1",
      "productSegments": {
        "deptId": "350",
        "vertical": "01"
      }
    }
  },
  "paymentsEnabled": true,
  "checkOrderingEnabled": true,
  "_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/v1.0.1/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/v1.0.1/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"
        }
      }
    }
  }
}

Parameters

Parameter Description
productId
(path)
string (required)
The unique identifier of this product. This is an opaque string.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body
(body)
product (required)

Try It

Example responses

200 Response

{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v2.3.0/profile.json",
  "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",
  "target": "business",
  "newAccountAvailability": "available",
  "ifxType": "DDA",
  "rates": {
    "apy": "1.45",
    "nominal": "1.455",
    "apye": "1.45",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "card": {
    "provider": {
      "id": "DDA_203389"
    },
    "images": [
      {
        "height": 1024,
        "width": 833,
        "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
      }
    ],
    "activationExpiration": 30,
    "expeditedShippingAllowed": {
      "forNew": true,
      "forReplacements": true
    },
    "autoOrder": {
      "forDigitalAccountOpening": true,
      "forJointOwners": false,
      "forAuthorizedSigners": true
    }
  },
  "highlights": [
    "FDIC Insurance",
    "No Monthly Maintenance Fees",
    "Minimum Deposit of $2,500"
  ],
  "coreBanking": {
    "finxact": {
      "productGroup": "1",
      "productSegments": {
        "deptId": "350",
        "vertical": "01"
      }
    }
  },
  "paymentsEnabled": true,
  "checkOrderingEnabled": true,
  "_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/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: product
StatusDescription
400 Bad Request

Bad Request. One of the request parameters to patch a product was not valid. See _error for more information

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
404 Not Found

Not Found. There is no such product resource at the specified {productId} The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of an active or inactive resource may not be changed to pending.
  • The state of a removed resource may not be changed.
  • The state of the resource may not be changed to active or inactive when the product type or subtype is still `pending'.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use, or the selected subtype is not a subtype of the selected product type.
  • An attempt to set a product's newAccountAvailability to true when the product state is inactive.
  • An attempt to set a product's code when the product state is not pending.
  • An attempt to set a product's code to a value that is used in another product.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
412 Precondition Failed

Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity

unprocessableEntity. The _id and newAccountAvailability cannot be changed

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this product resource.

deleteProduct

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/products/products/{productId} \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.devbank.apiture.com/products/products/{productId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/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',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/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',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/products/products/{productId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/products/products/{productId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/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

Parameter Description
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
productId
(path)
string (required)
The unique identifier of this product. This is an opaque string.

Try It

Example responses

400 Response

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "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": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://api.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

StatusDescription
204 No Content
No Content. The resource was deleted successfully.
StatusDescription
400 Bad Request

Bad Request. One of the request parameters to delete a product was not valid. See _error for more information

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict
Conflict. A product may not be deleted if the state is anything other than pending.
Schema: errorResponse
StatusDescription
412 Precondition Failed

Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.

This error response may have one of the following type values:

Schema: errorResponse

unlockProduct

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/products/unlockedProducts?product=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/products/unlockedProducts?product=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/products/unlockedProducts',
  params: {
  'product' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/products/unlockedProducts', params={
  'product': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/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

Parameter Description
product
(query)
string (required)
A server-supplied value which identifies the product instance.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: productType
StatusDescription
400 Bad Request

Bad Request. The product was malformed or does not refer to a product.

This error response may have one of the following type values:

StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of an active or inactive resource may not be changed to pending.
  • The state of a removed resource may not be changed.
  • The state of the resource may not be changed to active or inactive when the product type or subtype is still `pending'.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use, or the selected subtype is not a subtype of the selected product type.
  • An attempt to set a product's newAccountAvailability to true when the product state is inactive.
  • An attempt to set a product's code when the product state is not pending.
  • An attempt to set a product's code to a value that is used in another product.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

lockProduct

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/products/lockedProducts?product=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/products/lockedProducts?product=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/products/lockedProducts',
  params: {
  'product' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/products/lockedProducts', params={
  'product': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/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

Parameter Description
product
(query)
string (required)
A server-supplied value which identifies the product instance.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: productType
StatusDescription
400 Bad Request

Bad Request. The product was malformed or does not refer to a product.

This error response may have one of the following type values:

StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of an active or inactive resource may not be changed to pending.
  • The state of a removed resource may not be changed.
  • The state of the resource may not be changed to active or inactive when the product type or subtype is still `pending'.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use, or the selected subtype is not a subtype of the selected product type.
  • An attempt to set a product's newAccountAvailability to true when the product state is inactive.
  • An attempt to set a product's code when the product state is not pending.
  • An attempt to set a product's code to a value that is used in another product.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

activateProduct

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/products/activeProducts?product=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/products/activeProducts?product=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/products/activeProducts',
  params: {
  'product' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/products/activeProducts', params={
  'product': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/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

Parameter Description
product
(query)
string (required)
A server-supplied value which identifies the product instance.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: productType
StatusDescription
400 Bad Request

Bad Request. The product was malformed or does not refer to a product.

This error response may have one of the following type values:

StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of an active or inactive resource may not be changed to pending.
  • The state of a removed resource may not be changed.
  • The state of the resource may not be changed to active or inactive when the product type or subtype is still `pending'.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use, or the selected subtype is not a subtype of the selected product type.
  • An attempt to set a product's newAccountAvailability to true when the product state is inactive.
  • An attempt to set a product's code when the product state is not pending.
  • An attempt to set a product's code to a value that is used in another product.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

deactivateProduct

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/products/inactiveProducts?product=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/products/inactiveProducts?product=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/products/inactiveProducts',
  params: {
  'product' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/products/inactiveProducts', params={
  'product': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/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

Parameter Description
product
(query)
string (required)
A server-supplied value which identifies the product instance.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: productType
StatusDescription
400 Bad Request

Bad Request. The product was malformed or does not refer to a product.

This error response may have one of the following type values:

StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of an active or inactive resource may not be changed to pending.
  • The state of a removed resource may not be changed.
  • The state of the resource may not be changed to active or inactive when the product type or subtype is still `pending'.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use, or the selected subtype is not a subtype of the selected product type.
  • An attempt to set a product's newAccountAvailability to true when the product state is inactive.
  • An attempt to set a product's code when the product state is not pending.
  • An attempt to set a product's code to a value that is used in another product.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

removeProduct

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/products/removedProducts?product=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/products/removedProducts?product=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/products/removedProducts',
  params: {
  'product' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/products/removedProducts', params={
  'product': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/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

Parameter Description
product
(query)
string (required)
A server-supplied value which identifies the product instance.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: productType
StatusDescription
400 Bad Request

Bad Request. The product was malformed or does not refer to a product.

This error response may have one of the following type values:

StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of an active or inactive resource may not be changed to pending.
  • The state of a removed resource may not be changed.
  • The state of the resource may not be changed to active or inactive when the product type or subtype is still `pending'.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use, or the selected subtype is not a subtype of the selected product type.
  • An attempt to set a product's newAccountAvailability to true when the product state is inactive.
  • An attempt to set a product's code when the product state is not pending.
  • An attempt to set a product's code to a value that is used in another product.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Product Type

Banking Product Types

getProductTypes

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/products/productTypes \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/products/productTypes HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/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',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/products/productTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/products/productTypes', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/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

Parameter Description
start
(query)
integer(int64)
The zero-based index of the first product type in this page. The default, 0, represents the first page of the collection.
limit
(query)
integer(int32)
The maximum number of product type representations to return in this page.
Default: 100
sortBy
(query)
string
Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
This collection may be sorted by following properties:
state
type
name
subtype
name
(query)
string
Subset the products or product types collection to those with this name value. This is combined with an implicit and with other filters if they are used. See filtering.
type
(query)
string
Subset the products or product types collection to those with this exact type value. This is combined with an implicit and with other filters if they are used. See filtering.
subtype
(query)
boolean
Subset the product types collection to those with this exact subtype value. For example, ?subtype=true will limit the response to only product types which are subtypes. This is combined with an implicit and with other filters if they are used. See filtering.
state
(query)
string
Subset the products or product types collection to those whose state matches this value. Use | to separate multiple values. For example, ?state=pending matches only items whose state is pending; ?state=removed|inactive matches items whose state is removed or inactive. This is combined with an implicit and with other filters if they are used. See filtering.
filter
(query)
string
Optional filter criteria. See filtering.
This collection may be filtered by following properties and functions:
• Property state using functions eq, ne, in
• Property type using functions eq, ne, in
• Property name using functions eq, ne, lt, le, gt, ge, startsWith, endsWith, contains, search
• Property subtype using functions eq, ne, in
q
(query)
string
Optional search string. See searching.
parent
(query)
string
Subset the product types to only those subtypes whose parent type is named by its product type URI. This implements the apiture:children link relation on a product type.

Try It

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/products/productTypes/v1.0.2/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": {
      "anyOf": [
        {
          "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
          "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: productTypes
StatusDescription
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

createProductType

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/products/productTypes \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/products/productTypes HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/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/createProductType/v1.0.1/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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/products/productTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/products/productTypes', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/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. POST to the apiture:activate link after creating a product type to activate it.

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/products/createProductType/v1.0.1/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

Parameter Description
copyOf
(query)
string(uri)
To make a copy of an existing product type, pass the URI of the original product type. Fields in the request body will override the values copied from the existing product type. The new name must be passed in the body, since names must be unique. A new unique code will be assigned to the copy.
body
(body)
createProductType (required)
The data necessary to create a new product type.

Try It

Example responses

201 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
201 Created
Created
Schema: productType
StatusDescription
400 Bad Request

Bad Request. One of the request parameters to create a productType was not valid. See _error for more information

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of the resource may not be changed to pending.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use.
  • Attempt to create a subtype of a subtype.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
201 Location string uri
The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with scheme://host .
201 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource.

getProductType

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/products/productTypes/{productTypeId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/products/productTypes/{productTypeId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/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',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/products/productTypes/{productTypeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/products/productTypes/{productTypeId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/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

Parameter Description
productTypeId
(path)
string (required)
The unique identifier of this product type. This is an opaque string.
If-None-Match
(header)
string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Try It

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: productType
StatusDescription
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
StatusDescription
404 Not Found

Not Found. There is no such product type resource at the specified {productTypeId} The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this product type resource.

updateProductType

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/products/productTypes/{productTypeId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/products/productTypes/{productTypeId} HTTP/1.1
Host: api.devbank.apiture.com
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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/productTypes/{productTypeId}',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/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',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/products/productTypes/{productTypeId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/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": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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
}

Parameters

Parameter Description
productTypeId
(path)
string (required)
The unique identifier of this product type. This is an opaque string.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body
(body)
productType (required)

Try It

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: productType
StatusDescription
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
404 Not Found

Not Found. There is no such product type resource at the specified {productTypeId} The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of the resource may not be changed to pending.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use.
  • Attempt to create a subtype of a subtype.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
412 Precondition Failed

Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this product type resource.

patchProductType

Code samples

# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/products/productTypes/{productTypeId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.devbank.apiture.com/products/productTypes/{productTypeId} HTTP/1.1
Host: api.devbank.apiture.com
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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/productTypes/{productTypeId}',
  method: 'patch',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.devbank.apiture.com/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',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.devbank.apiture.com/products/productTypes/{productTypeId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.devbank.apiture.com/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": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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
}

Parameters

Parameter Description
productTypeId
(path)
string (required)
The unique identifier of this product type. This is an opaque string.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body
(body)
productType (required)

Try It

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: productType
StatusDescription
400 Bad Request

Bad Request. One of the request parameters to patch a productType was not valid. See _error for more information

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
404 Not Found

Not Found. There is no such product type resource at the specified {productTypeId} The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of the resource may not be changed to pending.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use.
  • Attempt to create a subtype of a subtype.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
412 Precondition Failed

Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this product type resource.

deleteProductType

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/products/productTypes/{productTypeId} \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.devbank.apiture.com/products/productTypes/{productTypeId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/productTypes/{productTypeId}',
  method: 'delete',

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

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

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/products/productTypes/{productTypeId}',
{
  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',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/products/productTypes/{productTypeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/products/productTypes/{productTypeId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/products/productTypes/{productTypeId}");
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"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/products/productTypes/{productTypeId}", data)
    req.Header = headers

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

Delete this product type resource

DELETE /productTypes/{productTypeId}

Delete this product type resource and any resources that are owned by it. A product type may only be deleted if its state is pending, and it is not in use by a product.

Parameters

Parameter Description
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
productTypeId
(path)
string (required)
The unique identifier of this product type. This is an opaque string.

Try It

Example responses

409 Response

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "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": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://api.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

StatusDescription
204 No Content
No Content. The resource was deleted successfully.
StatusDescription
409 Conflict
Conflict. A product type may not be deleted if the state is anything other than pending, or if the type is used by a pending product.
Schema: errorResponse
StatusDescription
412 Precondition Failed

Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.

This error response may have one of the following type values:

Schema: errorResponse

activateProductType

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/products/activeProductTypes?productType=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/products/activeProductTypes?productType=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/activeProductTypes',
  method: 'post',
  data: '?productType=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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/products/activeProductTypes?productType=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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/products/activeProductTypes',
  params: {
  'productType' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/products/activeProductTypes', params={
  'productType': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/products/activeProductTypes?productType=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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Activate a product type

POST /activeProductTypes

Activate a product type 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 type.

This changes the state to active.

Parameters

Parameter Description
productType
(query)
string (required)
A server-supplied value which identifies the product type instance.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: productType
StatusDescription
400 Bad Request

Bad Request. The productType was malformed or does not refer to a product type.

This error response may have one of the following type values:

StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of the resource may not be changed to pending.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use.
  • Attempt to create a subtype of a subtype.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

deactivateProductType

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/products/inactiveProductTypes?productType=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/products/inactiveProductTypes?productType=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/inactiveProductTypes',
  method: 'post',
  data: '?productType=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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/products/inactiveProductTypes?productType=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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/products/inactiveProductTypes',
  params: {
  'productType' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/products/inactiveProductTypes', params={
  'productType': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/products/inactiveProductTypes?productType=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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Deactivate a product type

POST /inactiveProductTypes

Deactivate a product type that is eligible to be deactivated.

Only product types which are pending or active and which are not in use by any pending or active products or accounts, and which are not the parent type of pending or active product types may be deactivated.

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

This changes the state to inactive.

Parameters

Parameter Description
productType
(query)
string (required)
A server-supplied value which identifies the product type instance.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: productType
StatusDescription
400 Bad Request

Bad Request. The productType was malformed or does not refer to a product type.

This error response may have one of the following type values:

StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of the resource may not be changed to pending.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use.
  • Attempt to create a subtype of a subtype.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

removeProductType

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/products/removedProductTypes?productType=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/products/removedProductTypes?productType=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/removedProductTypes',
  method: 'post',
  data: '?productType=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',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/products/removedProductTypes?productType=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',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/products/removedProductTypes',
  params: {
  'productType' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/products/removedProductTypes', params={
  'productType': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/products/removedProductTypes?productType=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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Remove a product type

POST /removedProductTypes

Remove a product type that is eligible to be removed.

Only product types which are active or inactive and which are not in use by any pending, active or inactive products or accounts, and which are not the parent type of pending, active, or inactive product types may be removed. This operation is invoked from the apiture:remove link on a product type when it is eligible to be removed.

This changes the state to removed.

Removing a product type 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 product types.

Parameters

Parameter Description
productType
(query)
string (required)
A server-supplied value which identifies the product type instance.
If-Match
(header)
string
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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

StatusDescription
200 OK
OK
Schema: productType
StatusDescription
400 Bad Request

Bad Request. The productType was malformed or does not refer to a product type.

This error response may have one of the following type values:

StatusDescription
409 Conflict

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

  • The state of the resource may not be changed to pending.
  • The resource cannot be created or modified due to a conflict with other resources. For example, the name may already be in use.
  • Attempt to create a subtype of a subtype.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Account Verification Letter Template

Account Verification Letter Template

getVerificationLetterTemplate

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate \
  -H 'Accept: text/markdown' \
  -H 'Accept: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate HTTP/1.1
Host: api.devbank.apiture.com
Accept: text/markdown
Accept: string

var headers = {
  'Accept':'text/markdown',
  'Accept':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate',
  method: 'get',

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

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

const headers = {
  'Accept':'text/markdown',
  'Accept':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/markdown',
  'Accept' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'text/markdown',
  'Accept': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate");
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{"text/markdown"},
        "Accept": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Fetch an account verification letter template

GET /products/{productId}/verificationLetterTemplate

Return a representation of account verification letter template for this product. This is a Mustache template. The content is Github Flavored Markdown with Mustache template variables for replaceable text.

The variables in the template are:

This template is used to format the account verification letter in the createVerificationLetter operation in the Accounts API.

Parameters

Parameter Description
productId
(path)
string (required)
The unique identifier of this product. This is an opaque string.
Accept
(header)
string
The media type of the desired response representation. Only text/markdown is currently supported.

Try It

Example responses

200 Response

"string"

Responses

StatusDescription
200 OK
Markdown template for the account verifications letter template.
Schema: string
StatusDescription
404 Not Found

Not Found. There is no such product resource at the specified {productId} The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
406 Not Acceptable
Not Acceptable. Indicates that the server cannot produce a response matching the list of acceptable values defined in the request's headers (i.e. not text/markdown)
Schema: errorResponse

Response Headers

StatusDescription
200 Content-Type string
The media type of the response representation. The Content-Type will be text/markdown.

updateVerificationLetterTemplate

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate \
  -H 'Content-Type: text/markdown' \
  -H 'Accept: text/markdown' \
  -H 'Accept: string' \
  -H 'Content-Type: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: text/markdown
Accept: text/markdown
Accept: string
Content-Type: string

var headers = {
  'Content-Type':'text/markdown',
  'Accept':'text/markdown',
  'Accept':'string',
  'Content-Type':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = 'string';
const headers = {
  'Content-Type':'text/markdown',
  'Accept':'text/markdown',
  'Accept':'string',
  'Content-Type':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate',
{
  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' => 'text/markdown',
  'Accept' => 'text/markdown',
  'Accept' => 'string',
  'Content-Type' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'text/markdown',
  'Accept': 'text/markdown',
  'Accept': 'string',
  'Content-Type': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/products/products/{productId}/verificationLetterTemplate");
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{"text/markdown"},
        "Accept": []string{"text/markdown"},
        "Accept": []string{"string"},
        "Content-Type": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Update this account verification letter template

PUT /products/{productId}/verificationLetterTemplate

Set or replace the account verification letter template for this product.

Body parameter

"string"

Parameters

Parameter Description
productId
(path)
string (required)
The unique identifier of this product. This is an opaque string.
Accept
(header)
string
The media type of the desired response representation. Only text/markdown is currently supported.
Content-Type
(header)
string
The media type of the request body representation. Only text/markdown is currently supported.
body
(body)
string (required)
The Github Flavored Markdown text (with Mustache variables) defining the template for the verification letter.

Try It

Example responses

200 Response

"string"

Responses

StatusDescription
200 OK
OK
Schema: string
StatusDescription
404 Not Found

Not Found. There is no such product resource at the specified {productId} The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 Content-Type string
The media type of the response representation. The Content-Type will be text/markdown.

API

The Products API

getApi

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/products/ \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/products/ HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/products/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/products/', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/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:

Try It

Example responses

OK

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

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.0.0/profile.json",
  "_links": {}
}

Responses

StatusDescription
200 OK
OK
Schema: root

getApiDoc

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/products/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/products/apiDoc HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json

var headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/apiDoc',
  method: 'get',

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

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

const headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/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',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/products/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/products/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/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"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/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

Example responses

200 Response

{}

Responses

StatusDescription
200 OK
OK
Schema: Inline

Response Schema

getLabels

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/products/labels \
  -H 'Accept: application/hal+json' \
  -H 'Accept-Language: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/products/labels HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
Accept-Language: string

var headers = {
  'Accept':'application/hal+json',
  'Accept-Language':'string',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/products/labels',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'Accept-Language':'string',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/products/labels',
{
  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',
  'Accept-Language' => 'string',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/products/labels',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'Accept-Language': 'string',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/products/labels', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/products/labels");
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"},
        "Accept-Language": []string{"string"},
        "API-Key": []string{"API_KEY"},
        
    }

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

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

Localized Labels

GET /labels

Return a JSON object which defines labels for enumeration types defined by the schemas defined in this API.

The labels in the response may not all match the requested language; some may be in the default language (en-us).

Parameters

Parameter Description
Accept-Language
(header)
string
The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per RFC 7231.

Try It

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/common/labelGroups/v1.0.1/profile.json",
  "groups": {
    "structure": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "corporation": {
        "label": "Corporation",
        "code": "1",
        "variants": {
          "fr": {
            "label": "Soci\\u00e9t\\u00e9"
          }
        }
      },
      "partnership": {
        "label": "Partnership",
        "code": "2",
        "variants": {
          "fr": {
            "label": "Partenariat"
          }
        }
      },
      "llc": {
        "label": "Limited Liability Company",
        "code": "2",
        "variants": {
          "fr": {
            "label": "Soci\\u00e9t\\u00e9 \\u00e9 Responsabilit\\u00e9 Limit\\u00e9e"
          }
        }
      },
      "nonProfit": {
        "label": "Non Profit",
        "code": "4",
        "variants": {
          "fr": {
            "label": "Non Lucratif"
          }
        }
      },
      "financialInstitution": {
        "label": "Financial Institution",
        "code": "8",
        "variants": {
          "fr": {
            "label": "Institution financi\\u00e8re"
          }
        }
      },
      "soleProprietorship": {
        "label": "Sole Proprietorship",
        "code": "11",
        "variants": {
          "fr": {
            "label": "Entreprise individuelle"
          }
        }
      },
      "other": {
        "label": "Other",
        "code": "254",
        "variants": {
          "fr": {
            "label": "Autre"
          }
        }
      }
    },
    "estimatedAnnualRevenue": {
      "unknown": {
        "label": "Unknown",
        "code": "0"
      },
      "under1Million": {
        "label": "Under $1M",
        "code": "1",
        "range": "[0,1000000.00)"
      },
      "from1to10Million": {
        "label": "$1M to $10M",
        "code": "2",
        "range": "[1000000.00,10000000.00)"
      },
      "from10to100Million": {
        "label": "$10M to $100M",
        "code": "3",
        "range": "[10000000.00,100000000.00)"
      },
      "over100Million": {
        "label": "Over $100,000,000.00",
        "code": "4",
        "range": "[100000000.00,]"
      },
      "other": {
        "label": "Other",
        "code": "254"
      }
    }
  }
}

Responses

StatusDescription
200 OK
OK
Schema: labelGroups

Schemas

abstractRequest

{
  "_profile": "{uri of resource profile.json}",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  }
}

Abstract Request (v2.0.0)

An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource.

This schema was resolved from common/abstractRequest.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.

abstractResource

{
  "_profile": "{uri of resource profile.json}",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  }
}

Abstract Resource (v2.0.0)

An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

This schema was resolved from common/abstractResource.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.

accrualType

"compounding"

Accrual Type (v1.0.0)

Indicates how interest is accrued according to the compoundPeriod.

accrualType strings may have one of the following enumerated values:

ValueDescription
compoundingCompounding interest
simpleSimple interest

These enumeration values are further described by the label group named accrualType in the response from the getLabels operation.

Type: string
Enumerated values:
compounding
simple

attributeValue

{}

Attribute Value (v2.0.0)

The data associated with this attribute.

This schema was resolved from common/attributeValue.

Properties

attributes

{
  "property1": {},
  "property2": {}
}

Attributes (v2.0.0)

An optional map of name/value pairs which contains additional dynamic data about the resource.

This schema was resolved from common/attributes.

Properties

NameDescription
additionalProperties attributeValue
The data associated with this attribute.

This schema was resolved from common/attributeValue.

autoOrderCards

{
  "forDigitalAccountOpening": true,
  "forJointOwners": true,
  "forAuthorizedSigners": true
}

Automatically Order Cards (v1.0.0)

Configuration for whether the financial institution automatically orders new debit cards for primary applicants or other account holders. New cards are not ordered during user/account migration.

Properties

NameDescription
forDigitalAccountOpening boolean
If true, the financial institution will automatically order a debit card for the primary applicant after opening a new account associated with this product via the digital account opening process.
Default: false
forJointOwners boolean
If true, the financial institution will automatically order a debit card for new joint owners when they become an account holder on a personal account associated with this product.
Default: false
forAuthorizedSigners boolean
If true, the financial institution will automatically order a debit card for the organization's existing authorized signers or when a new authorized signer becomes an account holder on accounts associated with this product. If both forDigitalAccountOpening and forAuthorizedSigners are true, the applicant receives only one card even though they may be listed in the organization's authorized signers.
Default: false

cardImage

{
  "height": 1024,
  "width": 833,
  "uri": "http://cdn.3rdparty.bank/images/products/DDA_203389/debit-card-large.png"
}

Card Image Details (v1.0.0)

Details of a debit card image for this product. The height and width are optional but should be provided if the card.images object contains more than one image, so that clients can choose the most appropriate image size. The image may have portrait or landscape orientation, but the maximum aspect ratio is 2:1 (IEC 7810 is 85.60:53.98, approximately 1.6:1).

Properties

NameDescription
height integer
The image height, in pixels.
minimum: 64
maximum: 4096
width integer
The image width, in pixels.
minimum: 64
maximum: 4096
uri string(uri) (required)
The image URI which a client can fetch in order to render the sample card image in the client. This resource does not require authentication.
maxLength: 2048

cardProvider

{
  "id": "DDA_203389"
}

Card Provider Details (v1.0.0)

Details of the debit card processor/provider.

Properties

NameDescription
id string (required)
The unique identifier for this product within the card provider's environment.
read-only

collection

{
  "_links": {
    "property1": {
      "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Applicant"
    },
    "property2": {
      "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Applicant"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1575c0a7b0115a4b3",
    "message": "Descriptive error message...",
    "statusCode": 422,
    "type": "errorType1",
    "remediation": "Remediation string...",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "errors": [
      {
        "_id": "ccdbe2c5c938a230667b3827",
        "message": "An optional embedded error"
      },
      {
        "_id": "dbe9088dcfe2460f229338a3",
        "message": "Another optional embedded error"
      }
    ],
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/errorType1"
      }
    }
  },
  "count": 0,
  "start": 0,
  "limit": 0,
  "name": "string"
}

Collection (v2.0.0)

A collection of resources. This is an abstract model schema which is extended to define specific resource collections.

This schema was resolved from common/collection.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
count integer
The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start integer
The start index of this page of items.
limit integer
The maximum number of items per page.
name string
The name of the collection.

constraints

{
  "transactionTypes": [
    "debit"
  ],
  "minimumBalance": "500.00",
  "minimumFundingAmount": "500.00",
  "maximumFundingAmount": "2500.00",
  "minimumTransferAmount": "25.00",
  "maximumTransferAmount": "10000.00",
  "maximumWithdrawalCount": 6,
  "fundingTerm": "P30D",
  "depositsRestrictedAfterGracePeriod": true,
  "depositsRestrictedAfterFunding": true,
  "gracePeriod": "P14D"
}

Product Constraints (v1.0.0)

Product constraints, such as minimum and maximum balances.

Properties

NameDescription
transactionTypes transactionTypes
The types of transactions permitted for this account. Values which appear in this array are permitted.
Default: ["debit","credit"]
minimumBalance string
The minimum balance for accounts of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
minimumFundingAmount string
The minimum monetary value when funding a new account of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
maximumFundingAmount string
The maximum monetary value when funding a new account of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
minimumTransferAmount string
The minimum monetary value for new transfers from accounts of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
maximumTransferAmount string
The maximum monetary value for new transfers from accounts of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
maximumWithdrawalCount integer
The maximum number of withdrawals allowed per cycle. If not present, there is no hard limit.
fundingTerm string(period)
The time limit within which account opening funding must occur after account creation. This is expressed as an ISO 8601 duration duration; only day and month periods are allowed, and the only allowed fractional value for months is 0.5, as in P5D or P14D or P1M or P0.5M.
depositsRestrictedAfterGracePeriod boolean
If true, deposits are not allowed after the rollover grace period (see gracePeriod). This applies to time deposit products only.
Default: true
depositsRestrictedAfterFunding boolean
If true, deposits are not allowed after the initial account funding has completed. This typically applies to time deposit products.
Default: true
gracePeriod string(period)
A period of time after account rollover when additional deposits are allowed. This is an ISO 8601 duration duration; only day and month periods are allowed, and the only allowed fractional value for months is 0.5, as in P5D or P14D or P1M or P0.5M.

createProduct

{
  "_profile": "https://api.apiture.com/schemas/products/createProduct/v2.1.0/profile.json",
  "name": "Business Checking",
  "label": "Business Checking",
  "description": "A demand deposit checking account for business use.",
  "code": "B2001",
  "category": "Checking",
  "rates": {
    "apy": "1.41",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "card": {
    "provider": {
      "id": "DDA_203389"
    },
    "images": [
      {
        "height": 1024,
        "width": 833,
        "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
      }
    ],
    "activationExpiration": 30,
    "expeditedShippingAllowed": {
      "forNew": true,
      "forReplacements": true
    },
    "autoOrder": {
      "forDigitalAccountOpening": true,
      "forJointOwners": true,
      "forAuthorizedSigners": true
    }
  },
  "_links": {
    "apiture:productSubtype": {
      "href": "/products/productTypes/b2134f56-3645-490d-a788-79e974635ae8"
    }
  }
}

Create Product (v2.1.0)

Representation used to create a new product. The request must include links in the _links object which refer to the product subtype. (The product's type will be the parent type of the named subtype).

Response and request bodies using this createProduct schema may contain the following links:

RelSummaryMethod
apiture:productSubtypeFetch a representation of this product type.GET

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
state prodState
The state of this product or product type. New resources are pending by default and must be activated before they may be used.

The state property is immutable and derived and may not be changed via the PUT or PATCH operations. To change the state of a product or product type, use the POST operation using the apiture:activate, apiture:deactivate or apiture:remove links on the resource.

name string (required)
The name of this product.
minLength: 1
maxLength: 128
label string (required)
The text label for this product. This field may be localized.
minLength: 1
maxLength: 128
description string(markdown) (required)
A fuller description of this product. This field may be localized. The content is processed as Github Flavored Markdown and thus supports rich text.
minLength: 1
maxLength: 4096
code string (required)
The unique product code for this product, normally defined by the underlying banking core. The code cannot be changed once the state is beyond pending.
maxLength: 64
newAccountAvailability newAccountAvailability
Indicates if the product is available for opening new accounts.

  • available means the product may be selected for a new account application.
  • notAvailable means the product may not be selected for a new account application.

The default is available. Note that clients must check both the product state and the newAccountAvailability when listing products for new account opening. The ?openable=true query parameter on getProducts combines these.

(Labels and descriptions for the enumeration values are in the newAccountAvailability key in the response of the getLabels operation.) Upate this property with the unlockProduct or unlockProduct operations
read-only

category string
The product category name. This is a more readable form of the product's type.
ifxType ifxType
The product IFX Account Type.
target productTarget
Describes the target audience or consumer of the accounts, personal or business. Labels and descriptions for the enumeration values are in the productTarget key in the response of the getLabels operation.
rates productInterestRates
The interest rates for this product.
rate rate
The interest rate for this product.
Warning: The property rate was deprecated on version v2.1.0 of the schema. Use rates object instead. rate will be removed on version v3.0.0 of the schema.
institutionName string
The name of the financial institution.
minLength: 1
maxLength: 128
coreType string
Identifies the underlying bank core system.
onlineBankingEnabled boolean
true if this product is enabled and eligible for online banking.
Default: false
currency string
The ISO 4217 currency code for this product.
minLength: 3
maxLength: 3
fees [fee]
Zero or more fees for accounts of this product. If the array is empty or not present, there are no fees.
statementFrequency string(period)
The frequency with which statements are issued for accounts of this product. This is expressed as an ISO 8601 duration duration; only day and month periods are allowed, and the only allowed fractional value for months is 0.5, as in P5D or P14D or P1M or P0.5M.
timeDeposit timeDeposit
Properties of time deposit products, primarily Certificate of Deposit products.
card productCard
Debit card details associated with this product.
attributes object
An optional map of name/value pairs which provide additional metadata about the product.

createProductType

{
  "_profile": "https://api.apiture.com/schemas/products/createProductType/v1.0.1/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"
    }
  }
}

Create Product Type (v1.0.1)

Representation used to create a new product type. To create a subtype, the request may include a link in the _links object which refers to the parent product type.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
state prodState
The state of this product or product type. New resources are pending by default and must be activated before they may be used.

The state property is immutable and derived and may not be changed via the PUT or PATCH operations. To change the state of a product or product type, use the POST operation using the apiture:activate, apiture:deactivate or apiture:remove links on the resource.

name string (required)
The name of this product type.
minLength: 1
maxLength: 128
label string (required)
The text label for this product type. This field may be localized.
minLength: 1
maxLength: 128
description string(markdown) (required)
A fuller description of this product type. This field may be localized. The content is processed as Github Flavored Markdown and thus supports rich text.
minLength: 1
maxLength: 4096
subtype boolean
Indicates if this is a subtype. This is a derived, immutable property, based on whether the product type was created with a link to a parent type. See also the apiture:parent link on the productSubtype schema.
attributes object
An optional map of name/value pairs which provide additional metadata about the product type.

error

{
  "_id": "2eae46e1575c0a7b0115a4b3",
  "message": "Descriptive error message...",
  "statusCode": 422,
  "type": "errorType1",
  "remediation": "Remediation string...",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "errors": [
    {
      "_id": "ccdbe2c5c938a230667b3827",
      "message": "An optional embedded error"
    },
    {
      "_id": "dbe9088dcfe2460f229338a3",
      "message": "Another optional embedded error"
    }
  ],
  "_links": {
    "describedby": {
      "href": "https://developer.apiture.com/errors/errorType1"
    }
  }
}

Error (v2.0.0)

Describes an error in an API request or in a service called via the API.

This schema was resolved from common/error.

Properties

NameDescription
message string (required)
A localized message string describing the error condition.
_id string
A unique identifier for this error instance. This may be used as a correlation ID with the root cause error (i.e. this ID may be logged at the source of the error). This is is an opaque string.
read-only
statusCode integer
The HTTP status code associate with this error.
minimum: 100
maximum: 599
type string
An error identifier which indicates the category of error and associate it with API support documentation or which the UI tier can use to render an appropriate message or hint. This provides a finer level of granularity than the statusCode. For example, instead of just 400 Bad Request, the type may be much more specific. such as integerValueNotInAllowedRange or numericValueExceedsMaximum or stringValueNotInAllowedSet.
occurredAt string(date-time)
An RFC 3339 UTC time stamp indicating when the error occurred.
attributes attributes
Informative values or constraints which describe the error. For example, for a value out of range error, the attributes may specify the minimum and maximum values. This allows clients to present error messages as they see fit (the API does not assume the client/presentation tier). The set of attributes varies by error type.
remediation string
An optional localized string which provides hints for how the user or client can resolve the error.
errors [error]
An optional array of nested error objects. This property is not always present.
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

errorResponse

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "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": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://api.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response (v2.0.0)

Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details.

This schema was resolved from common/errorResponse.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.

expeditedShippingAllowed

{
  "forNew": true,
  "forReplacements": true
}

Expedited Shipping Allowed (v1.0.0)

Indicates if the bank customer can request expedited shipping for cards associated with the accounts for this product.

Properties

NameDescription
forNew boolean
If true, expedited shipping is allowed for new cards.
Default: false
forReplacements boolean
If true, expedited shipping is allowed for replacement cards (reorders).
Default: false

fee

{
  "type": "servicing",
  "period": "P1M",
  "description": "string",
  "structure": "unknown",
  "amount": "1.00"
}

Fee (v1.0.1)

Fees that are attached to accounts of this product.

Properties

NameDescription
type productFeeType
The fee type.
period string
The period at which the fee is assessed. If omitted, the fee is assessed per transaction.

This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the fee period in the number of years/months/weeks/days. For example, the values P1d, P1W, P2W, P1M, P0.25Y, P0.5Y, P1Y indicate a term of daily, weekly, by-weekly, monthly, quarterly, biannually, and annually, respectively, (although other periods may be allowed).

description string
A description of the fee and its structure and period.
structure feeStructure
The fee structure for this fee
amount string
The amount of the (fixed) fee, in the product's currency.

feeStructure

"unknown"

Product Fee Structure (v1.0.0)

The fee structure. fixed fee, variable fee, or other. For example, the service fee or atm may be fixed (such as "amount" : "2.00") but the foreignTransactions fee may be variable.

feeStructure strings may have one of the following enumerated values:

ValueDescription
unknownUndetermined fee structure
variableA variable rate fee
fixedA fixed rate fee

These enumeration values are further described by the label group named feeStructure in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
variable
fixed

ifxType

"CCA"

IFX Account Type (v1.0.0)

A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.

ifxType strings may have one of the following enumerated values:

ValueDescription
CCACredit card account
CDACertificate of deposit account (CD)
CLACommercial loan account
CMACash management account
DDADemand deposit account
EQUHome equity loan
GLAGeneral ledger account
ILAInstallment loan account
INVInvestment account
IRAIndividual retirement account
IRLAccounts held in Ireland
LOCConsumer line of credit
MLAMilitary Lending Account: Credit facility held by former US service member
MMAMoney market account
PBAPackaged bank Account: Account with additional benefits that charges a fixed monthly fee.
PPAPrivate pension administrator
RWDReward accounts
SDASavings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

Type: string
Enumerated values:
CCA
CDA
CLA
CMA
DDA
EQU
GLA
ILA
INV
IRA
IRL
LOC
MLA
MMA
PBA
PPA
RWD
SDA

interestRateType

"apr"

Interest Rate Type (v1.0.0)

The rate type. The rate type may not be changed once it is set at product creation. Rate types are:

Type: string
Enumerated values:
apr
apy

labelGroup

{
  "unknown": {
    "label": "Unknown",
    "code": "0",
    "hidden": true
  },
  "under1Million": {
    "label": "Under $1M",
    "code": "1",
    "range": "[0,1000000.00)",
    "variants": {
      "fr": {
        "label": "Moins de $1M"
      }
    }
  },
  "from1to10Million": {
    "label": "$1M to $10M",
    "code": "2",
    "range": "[1000000.00,10000000.00)",
    "variants": {
      "fr": {
        "label": "$1M \\u00e0 $10M"
      }
    }
  },
  "from10to100Million": {
    "label": "$10M to $100M",
    "code": "3",
    "range": "[10000000.00,100000000.00)",
    "variants": {
      "fr": [
        "label $10M \\u00e0 $100M"
      ]
    }
  },
  "over100Million": {
    "label": "Over $100,000,000.00",
    "code": "4",
    "range": "[100000000.00,]",
    "variants": {
      "fr": {
        "label": "Plus de $10M"
      }
    }
  },
  "other": {
    "label": "Other",
    "code": 254
  }
}

Label Group (v1.0.0)

A map that defines labels for the items in a group. This is a map from each item namea labelItem object. For example, consider a JSON response that includes a property named revenueEstimate; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue, with options ranging under1Million, to over100Million. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}, and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00).

This allows the client to let the user select a value from a list, such as the following derivde from the labels in the example:

Note that the other item is hidden from the selection list, as that item is marked as hidden. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }.

This schema was resolved from common/labelGroup.

Properties

NameDescription
additionalProperties labelItem
An item in a labelGroup, with a set of variants which contains different localized labels for the item. Each (simpleLabel) variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external syststems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI.

This schema was resolved from common/labelItem.

labelGroups

{
  "_profile": "https://api.apiture.com/schemas/common/labelGroups/v1.0.1/profile.json",
  "groups": {
    "structure": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "corporation": {
        "label": "Corporation",
        "code": "1",
        "variants": {
          "fr": {
            "label": "Soci\\u00e9t\\u00e9"
          }
        }
      },
      "partnership": {
        "label": "Partnership",
        "code": "2",
        "variants": {
          "fr": {
            "label": "Partenariat"
          }
        }
      },
      "llc": {
        "label": "Limited Liability Company",
        "code": "2",
        "variants": {
          "fr": {
            "label": "Soci\\u00e9t\\u00e9 \\u00e9 Responsabilit\\u00e9 Limit\\u00e9e"
          }
        }
      },
      "nonProfit": {
        "label": "Non Profit",
        "code": "4",
        "variants": {
          "fr": {
            "label": "Non Lucratif"
          }
        }
      },
      "financialInstitution": {
        "label": "Financial Institution",
        "code": "8",
        "variants": {
          "fr": {
            "label": "Institution financi\\u00e8re"
          }
        }
      },
      "soleProprietorship": {
        "label": "Sole Proprietorship",
        "code": "11",
        "variants": {
          "fr": {
            "label": "Entreprise individuelle"
          }
        }
      },
      "other": {
        "label": "Other",
        "code": "254",
        "variants": {
          "fr": {
            "label": "Autre"
          }
        }
      }
    },
    "estimatedAnnualRevenue": {
      "unknown": {
        "label": "Unknown",
        "code": "0"
      },
      "under1Million": {
        "label": "Under $1M",
        "code": "1",
        "range": "[0,1000000.00)"
      },
      "from1to10Million": {
        "label": "$1M to $10M",
        "code": "2",
        "range": "[1000000.00,10000000.00)"
      },
      "from10to100Million": {
        "label": "$10M to $100M",
        "code": "3",
        "range": "[10000000.00,100000000.00)"
      },
      "over100Million": {
        "label": "Over $100,000,000.00",
        "code": "4",
        "range": "[100000000.00,]"
      },
      "other": {
        "label": "Other",
        "code": "254"
      }
    }
  }
}

Label Groups (v1.0.1)

A set of named groups of labels, each of which contains multiple item labels.

The abbreviated example shows two groups, one named structure and one named estimatedAnnualRevenue. The first has items with names such as corporation, llc and soleProprietorship, with text labels for each in the default and in French. The second has items for estimated revenue ranges but no localized labels. For example, the item named from1to10Million has the label "$1M to $10M" and the range [1000000.00,10000000.00).

This schema was resolved from common/labelGroups.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
groups object
Groups of localized labels. This maps group namesa group of labels within that group.
» additionalProperties labelGroup
A map that defines labels for the items in a group. This is a map from each item namea labelItem object. For example, consider a JSON response that includes a property named revenueEstimate; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue, with options ranging under1Million, to over100Million. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}, and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00).

This allows the client to let the user select a value from a list, such as the following derivde from the labels in the example:

  • Unknown
  • Under $1M
  • $1M to $10M
  • $10M to $100M
  • $100M or more

Note that the other item is hidden from the selection list, as that item is marked as hidden. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }.

This schema was resolved from common/labelGroup.

labelItem

{
  "over100Million": {
    "label": "Over $100,000,000.00",
    "code": "4",
    "range": "[100000000.00,]",
    "variants": {
      "fr": {
        "label": "Plus de $10M"
      }
    }
  }
}

Label Item (v1.0.0)

An item in a labelGroup, with a set of variants which contains different localized labels for the item. Each (simpleLabel) variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external syststems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI.

This schema was resolved from common/labelItem.

Properties

NameDescription
label string (required)
A label or title which may be used as labels or other UI controls which present a value.
description string
A more detailed localized description of a localizable label.
variants object
The language-specific variants of this label. The keys in this object are RFC 7231 language codes.
» additionalProperties simpleLabel
A text label and optional description.

This schema was resolved from common/simpleLabel.

code string
If the localized value is associated with an external standard or definition, this is a lookup code or key or URI for that value.
minLength: 1
hidden boolean
If true, this item is normally hidden from the User Interface.
range string
The range of values, if the item describes a bounded numeric value. This is range notation such as [min,max], (exclusiveMin,max], [min,exclusiveMax), or (exclusiveMin,exclusiveMax). For example, [0,100) is the range greater than or equal to 0 and less than 100. If the min or max value are omitted, that end of the range is unbounded. For example, (,1000.00) means less than 1000.00 and [20000.00,] means 20000.00 or more. The ranges do not overlap or have gaps.
pattern: ^[\[\(](-?(0|[1-9][0-9]*)(\.[0-9]+)?)?,(-?(0|[1-9][0-9]*)(\.[0-9]+)?)?[\]\)]$

{
  "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Applicant"
}

Link (v1.0.0)

Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.

This schema was resolved from common/link.

Properties

NameDescription
href string(uri) (required)
The URI or URI template for the resource/operation this link refers to.
type string
The media type for the resource.
templated boolean
If true, the link's href is a URI template.
title string
An optional human-readable localized title for the link.
deprecation string(uri)
If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation.
profile string(uri)
The URI of a profile document, a JSON document which describes the target resource/operation.

{
  "property1": {
    "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Applicant"
  },
  "property2": {
    "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Applicant"
  }
}

Links (v1.0.0)

An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

Properties

NameDescription
additionalProperties link
Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.

This schema was resolved from common/link.

maturityPolicy

"rolloverPrincipalAndInterest"

Maturity Policy (v1.0.0)

Indicates how the principal and interest are processed upon maturity. The values indicate whether to rollover (to a time deposit account of the same rate and term), transfer funds to another (possibly new) deposit account, or simply hold the funds in the current account (which may no longer accrue interest). Labels and descriptions for the enumeration values are in the maturityPolicy key in the response of the getLabels operation.

maturityPolicy strings may have one of the following enumerated values:

ValueDescription
rolloverPrincipalAndInterestRollover principal and interest to a new CD of the same product: Upon maturity, both principal and interest rollover into a specified banking product, such as a savings, checking, or other deposit account.
transferPrincipalAndInterestTransfer principal and interest to a deposit account: Upon maturity, the principal an interest are both transferred to an existing or new deposit account.
rolloverPrincipalAndTransferInterestTransfer interest to a new deposit account an rollover principal to a new CD of the same product: Upon maturity, the principal rolls over into a specified banking product and the interest is transferred to an existing deposit account.
holdPrincipalAndInterestHold principal and accued interest in the CD account until withdrawal: Upon maturity, the principal and interest are held in the current time deposit account. The account may or may not accrue further interest, depending on the terms of the time deposit product. Funds may be withdrawn or transferred.
partialTransferPartial Transfer: Upon maturity, any funds greater than the maturity threshold is transfered to an existing deposit account and the rest remains on deposit. The account may or may not accrue further interest, depending on the terms of the time deposit product. Funds may be withdrawn or transferred.

These enumeration values are further described by the label group named maturityPolicy in the response from the getLabels operation.

Type: string
Enumerated values:
rolloverPrincipalAndInterest
transferPrincipalAndInterest
rolloverPrincipalAndTransferInterest
holdPrincipalAndInterest
partialTransfer

newAccountAvailability

"available"

New Account Availability (v1.0.0)

Describes if the product is available for opening new accounts.

newAccountAvailability strings may have one of the following enumerated values:

ValueDescription
availableUsers may open new accounts of this type
notAvailableUsers may not open new accounts of this type

These enumeration values are further described by the label group named newAccountAvailability in the response from the getLabels operation.

Type: string
Enumerated values:
available
notAvailable

prodState

"pending"

Product or Product Type State (v1.0.0)

The state of this product or product type. New resources are pending by default and must be activated before they may be used.

The state property is immutable and derived and may not be changed via the PUT or PATCH operations. To change the state of a product or product type, use the POST operation using the apiture:activate, apiture:deactivate or apiture:remove links on the resource.

prodState strings may have one of the following enumerated values:

ValueDescription
pendingThis product has been created in draft form but is not yet available
activeThis product is active and available for use
inactiveThis product is temporarily not available for use
removedThis product has been removed and is permanently not available for use

These enumeration values are further described by the label group named prodState in the response from the getLabels operation.

Type: string
Enumerated values:
pending
active
inactive
removed

product

{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/product/v2.3.0/profile.json",
  "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",
  "target": "business",
  "newAccountAvailability": "available",
  "ifxType": "DDA",
  "rates": {
    "apy": "1.45",
    "nominal": "1.455",
    "apye": "1.45",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "card": {
    "provider": {
      "id": "DDA_203389"
    },
    "images": [
      {
        "height": 1024,
        "width": 833,
        "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
      }
    ],
    "activationExpiration": 30,
    "expeditedShippingAllowed": {
      "forNew": true,
      "forReplacements": true
    },
    "autoOrder": {
      "forDigitalAccountOpening": true,
      "forJointOwners": false,
      "forAuthorizedSigners": true
    }
  },
  "highlights": [
    "FDIC Insurance",
    "No Monthly Maintenance Fees",
    "Minimum Deposit of $2,500"
  ],
  "coreBanking": {
    "finxact": {
      "productGroup": "1",
      "productSegments": {
        "deptId": "350",
        "vertical": "01"
      }
    }
  },
  "paymentsEnabled": true,
  "checkOrderingEnabled": true,
  "_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/v1.0.1/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/v1.0.1/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"
        }
      }
    }
  }
}

Product (v2.3.0)

Representation of product resources. The _links in a product may contain the following (which may be passed when creating a product via the POST /products operation or in PATCH operations to this product instance): The representation contains the product type and subtype in the _embedded objects.

Response and request bodies using this product schema may contain the following links:

RelSummaryMethod
selfFetch a representation of this productGET
apiture:productTypeFetch a representation of this product type.GET
apiture:productSubtypeFetch a representation of this product type.GET
apiture:activateActivate a productPOST
apiture:deactivateDeactivate a productPOST
apiture:removeRemove a productPOST
apiture:lockMarks an active product as ineligible for new account openingPOST
apiture:unlockMarks an active product as eligible for new account openingPOST
apiture:productTermsAndConditions The URL of the Terms and Conditions document for this productGET
apiture:electronicConsent The URL of the Electronic Use consent document for this productGET

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded productEmbeddedObjects
Embedded objects related to this product. A product contains summary representation of the product type and subtype.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
state prodState
The state of this product or product type. New resources are pending by default and must be activated before they may be used.

The state property is immutable and derived and may not be changed via the PUT or PATCH operations. To change the state of a product or product type, use the POST operation using the apiture:activate, apiture:deactivate or apiture:remove links on the resource.

name string
The name of this product.
minLength: 1
maxLength: 128
label string
The text label for this product. This field may be localized.
minLength: 1
maxLength: 128
description string(markdown)
A fuller description of this product. This field may be localized. The content is processed as Github Flavored Markdown and thus supports rich text.
minLength: 1
maxLength: 4096
code string
The unique product code for this product, normally defined by the underlying banking core. The code cannot be changed once the state is beyond pending.
maxLength: 64
newAccountAvailability newAccountAvailability
Indicates if the product is available for opening new accounts.

  • available means the product may be selected for a new account application.
  • notAvailable means the product may not be selected for a new account application.

The default is available. Note that clients must check both the product state and the newAccountAvailability when listing products for new account opening. The ?openable=true query parameter on getProducts combines these.

(Labels and descriptions for the enumeration values are in the newAccountAvailability key in the response of the getLabels operation.) Upate this property with the unlockProduct or unlockProduct operations
read-only

category string
The product category name. This is a more readable form of the product's type.
ifxType ifxType
The product IFX Account Type.
target productTarget
Describes the target audience or consumer of the accounts, personal or business. Labels and descriptions for the enumeration values are in the productTarget key in the response of the getLabels operation.
rates productInterestRates
The interest rates for this product.
rate rate
The interest rate for this product.
Warning: The property rate was deprecated on version v2.1.0 of the schema. Use rates object instead. rate will be removed on version v3.0.0 of the schema.
_id string
The unique identifier for this product resource. This is an immutable opaque string.
read-only
type string
The product type name, which is derived from the linked product type.
read-only
subtype string
The product subtype name, which is derived from the linked product subtype. This is a derived, immutable property.
read-only
timeDeposit timeDeposit
Properties of time deposit products, primarily Certificate of Deposit products.
constraints constraints
Product constraints, such as minimum and maximum balances.
paymentsEnabled boolean
If true, active accounts of this banking product may be eligible for payment features such as bill pay. This is merely the default; clients should check the paymentsEnabled property on the account service to ensure payment services are available for the authenticated account user.
The property paymentsEnabled was added on version 2.3.0 of the schema.
read-only
checkOrderingEnabled boolean
If true, active accounts derived from this banking product may allow ordering checks through the Check Orders API. Accounts inherit this value from their product. The financial institution may disable check ordering on individual accounts, so clients should reference the checkOrderingEnabled property on the account.
The property checkOrderingEnabled was added on version 2.3.0 of the schema.
Default: false
read-only
institutionName string
The name of the financial institution.
minLength: 1
maxLength: 128
coreType string
Identifies the underlying bank core system.
onlineBankingEnabled boolean
true if this product is enabled and eligible for online banking.
Default: false
currency string
The ISO 4217 currency code for this product.
minLength: 3
maxLength: 3
fees [fee]
Zero or more fees for accounts of this product. If the array is empty or not present, there are no fees.
statementFrequency string(period)
The frequency with which statements are issued for accounts of this product. This is expressed as an ISO 8601 duration duration; only day and month periods are allowed, and the only allowed fractional value for months is 0.5, as in P5D or P14D or P1M or P0.5M.
attributes object
An optional map of name/value pairs which provide additional metadata about the product type.
createdAt string(date-time)
The date-time when this product was created. This value is derived and immutable.
read-only
card productCard
Debit card details associated with this product.
highlights [string]
A list of end-user descriptive strings which highlight attributes of the product. These strings are presented to the end users in the product details.
read-only
coreBanking productCoreBanking
Properties of a product that are specific to the banking core provider.
read-only

productCard

{
  "provider": {
    "id": "DDA_203389"
  },
  "images": [
    {
      "height": 1024,
      "width": 833,
      "uri": "http://cdn.3rdparty.bank/images/products/CD-3892/debit-card-large.png"
    }
  ],
  "activationExpiration": 30,
  "expeditedShippingAllowed": {
    "forNew": true,
    "forReplacements": true
  },
  "autoOrder": {
    "forDigitalAccountOpening": true,
    "forJointOwners": true,
    "forAuthorizedSigners": true
  }
}

Product Card Details (v1.0.0)

Debit card details associated with this product.

Properties

NameDescription
provider cardProvider (required)
Details of the card provider.
images [cardImage] (required)
Image (JPEG or PNG) of a sample blank debit card for this product.
activationExpiration integer (required)
After a card is issued, it must be activated before this many days before the card activation expires.
minimum: 7
expeditedShippingAllowed expeditedShippingAllowed
Indicates if the bank customer can request expedited shipping for cards associated with the accounts for this product.
autoOrder autoOrderCards
Whether the financial institution will automatically order new debit cards for bank customers.

productCoreBanking

{
  "finxact": {
    "productGroup": "1",
    "productSegments": {
      "deptId": "350",
      "vertical": "01"
    }
  }
}

Product Core Banking Properties (v1.0.0)

Product properties that are specific to the banking core provider. The actual banking core in which the Apiture platfiorm is executing determines what data appears. The sub-object for each banking core is present on a product only if the Apiture system is connected to the corresponding core banking provider. The name of each sub-object is the name of that provider.

Properties

NameDescription
finxact productFinxactCoreBanking
Product properties that are specific to the Finxact banking core system. This object is present only if the Apiture platform is connected to a Finxact system.
read-only

productEmbeddedObjects

{
  "productType": {
    "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
    "_profile": "https://api.apiture.com/schemas/products/summaryProductType/v1.0.1/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/summaryProductType/v1.0.1/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
  }
}

Product Embedded Objects (v1.0.0)

Related objects embedded within a product resource.

Properties

NameDescription
productType summaryProductType
The product type resource.
productSubtype summaryProductType
The product subtype resource.

productFeeType

"servicing"

Product Fee Type (v1.0.1)

A type identifier which indicates what type of fee exists for a banking product.

Warning: the enum list will be removed in a future release. and the values defined at runtime via the productFeeType group in the response from the getLabels operation.

Type: string
Enumerated values:
servicing
minimumBalance
overdraft
returnedCheck
statementHardCopy
atm
foreignTransaction
earlyClosing
earlyWithdrawal
other

productFinxactCoreBanking

{
  "productGroup": "1",
  "productSegments": {
    "deptId": "350",
    "vertical": "01"
  }
}

Product Core Banking Properties (v1.0.0)

Product properties that are specific to the Finxact banking core system.

Properties

NameDescription
productGroup string
Each product in Finxact belongs to a product group. This property is Finxact identifier of the customer group that this product belongs to.
read-only
productSegments object
An object which maps marketing segment names to the value for that named segment. The financial institution sets the names and values when configuring their banking products in Finxact.
read-only
» additionalProperties string
The value for this marking segment name.

productInterestRates

{
  "apy": "1.40",
  "nominal": "1.405",
  "apye": "1.40",
  "compoundPeriod": "P1D",
  "accrualType": "compounding"
}

Product Interest Rates (v1.0.0)

The interest rates for accounts based on this product. For deposit products, the rates describe the rate of return. For loan products, this includes the interest rate charged on balances. The apy, apye, nominal and apr values are a decimal percentage, coded as strings in order to represent the rate exactly. Rates are coded to two or three decimal places. Rates can be fixed, such { "apy" : "1.40" } for 1.4% APY. Rates (usually only on loan accounts) may relative to a benchmark, such as { "benchmark" : "primeUs", "apr" : "0.50" } to express U.S. Prime Rate + 0.5%.

Properties

NameDescription
apy string(decimal)
The annual percentage yield (APY): the effective yield from interest, including compounding, as a percentage. Used on deposit account products.
read-only
pattern: ^-?\d{1,2}\.\d{2}$
apye string(decimal)
The annualized rate based on the amount of interest actually earned, including compounding, as a percentage of the account's average daily balance. Used on deposit account products.
read-only
pattern: ^-?\d{1,2}\.\d{2}$
nominal string(decimal)
The effective interest rate before accounting for inflation. Used on deposit and loan account products.
read-only
pattern: ^-?\d{1,2}\.\d{2,3}$
apr string(decimal)
The base annual percentage rate (APR) charged on loan accounts. If benchmark is set, the current APR is relative to that benchark: For example, a rate of { 'apr': '1.00', 'benchmark': 'primeUS' } means the APR is "Prime plus 1.00%": if the current Prime rate is 1.10%, the actual APR is 2.10%. A negative rate means a rate below the benchmark.
read-only
pattern: ^-?\d{1,2}\.\d{2,3}$
benchmark string

An optional base benchmark that the rate is relative to. This typically only applie to loan products. If omitted, the rate is fixed. Otherwise the rate is added to the benchmark rate. Values may be (but are not limited to):

compoundPeriod string
The period at which interest compounds. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the compounding in the number of years/months/days. P1D mean compounded daily and P1M mean compounded monthly. The default is "P0D" (continuous).
accrualType accrualType
Indicates how interest is accrued according to the compoundPeriod.
adjustmentPeriod string(period)
The period at which the rate is adjusted or recomputed to account for changes in the benchmark rate. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days; The default is "P1D" (daily).

productTarget

"personal"

Product Target (v1.0.0)

The target audience for this product.

productTarget strings may have one of the following enumerated values:

ValueDescription
personalBanking products for personal use
businessBanking products for business use

These enumeration values are further described by the label group named productTarget in the response from the getLabels operation.

Type: string
Enumerated values:
personal
business

productType

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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
}

Product Type (v1.0.1)

Representation of a product type resource. If the type is a subtype, the _embedded resource contains the parent type.

Response and request bodies using this productType schema may contain the following links:

RelSummaryMethod
selfFetch a representation of this product type.GET
apiture:parentFetch a representation of this product type.GET
apiture:childrenReturn a collection of product typesGET
apiture:productsReturn a collection of productsGET
apiture:activateActivate a product typePOST
apiture:deactivateDeactivate a product typePOST
apiture:removeRemove a product typePOST

Properties

NameDescription
state prodState
The state of this product or product type. New resources are pending by default and must be activated before they may be used.

The state property is immutable and derived and may not be changed via the PUT or PATCH operations. To change the state of a product or product type, use the POST operation using the apiture:activate, apiture:deactivate or apiture:remove links on the resource.

name string
The name of this product type.
minLength: 1
maxLength: 128
label string
The text label for this product type. This field may be localized.
minLength: 1
maxLength: 128
description string(markdown)
A fuller description of this product type. This field may be localized. The content is processed as Github Flavored Markdown and thus supports rich text.
minLength: 1
maxLength: 4096
subtype boolean
Indicates if this is a subtype. This is a derived, immutable property, based on whether the product type was created with a link to a parent type. See also the apiture:parent link on the productSubtype schema.
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded productTypeEmbeddedObjects
Embedded resources for this product type. This may contain the parent type, if any. _embedded may not appear if there are no embedded resources.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
_id string
The unique identifier for this product type resource. This is an opaque string.
read-only
subtypeCount integer
0 if this type does not have subtypes; otherwise this holds the indicated number of direct subtypes. This is a derived, immutable property. See also the apiture:children link on the productSubtype schema.
read-only
createdAt string(date-time)
The date-time when this product type was created. This value is derived and immutable.
read-only
attributes object
An optional map of name/value pairs which provide additional metadata about the product type.

productTypeEmbeddedObjects

{
  "parent": {
    "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
    "_profile": "https://api.apiture.com/schemas/products/summaryProductType/v1.0.1/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
  }
}

Product Type Embedded Objects (v1.0.0)

Objects embedded in a poduct type resource.

Properties

NameDescription
parent summaryProductType
In subtypes, this is the parent type.

productTypeFields

{
  "state": "pending",
  "name": "string",
  "label": "string",
  "description": "string",
  "subtype": true
}

Product Type Fields (v1.0.0)

Common fields of the product type resource.

Properties

NameDescription
state prodState
The state of this product or product type. New resources are pending by default and must be activated before they may be used.

The state property is immutable and derived and may not be changed via the PUT or PATCH operations. To change the state of a product or product type, use the POST operation using the apiture:activate, apiture:deactivate or apiture:remove links on the resource.

name string
The name of this product type.
minLength: 1
maxLength: 128
label string
The text label for this product type. This field may be localized.
minLength: 1
maxLength: 128
description string(markdown)
A fuller description of this product type. This field may be localized. The content is processed as Github Flavored Markdown and thus supports rich text.
minLength: 1
maxLength: 4096
subtype boolean
Indicates if this is a subtype. This is a derived, immutable property, based on whether the product type was created with a link to a parent type. See also the apiture:parent link on the productSubtype schema.

productTypes

{
  "_profile": "https://api.apiture.com/schemas/products/productTypes/v1.0.2/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": {
      "anyOf": [
        {
          "_id": "4ea6fe4e-405c-4d71-93e3-ad637b5cab2d",
          "_profile": "https://api.apiture.com/schemas/products/productType/v1.0.1/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/v1.0.1/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"
            }
          }
        }
      ]
    }
  }
}

Product Type Collection (v1.0.2)

Collection of product types. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded productTypesEmbeddedObjects
Embedded objects.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
count integer
The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start integer
The start index of this page of items.
limit integer
The maximum number of items per page.
name string
The name of the collection.

productTypesEmbeddedObjects

{
  "items": [
    {
      "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
      "_profile": "https://api.apiture.com/schemas/products/summaryProductType/v1.0.1/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
    }
  ]
}

Product Types Embedded Objects (v1.0.0)

Objects embedded in the productTypes items array.

Properties

NameDescription
items [summaryProductType]
An array containing a page of product type items.

products

{
  "_profile": "https://api.apiture.com/schemas/products/products/v2.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": "Checking",
      "rate": {
        "value": "1.40",
        "type": "apy"
      },
      "rates": {
        "apy": "1.40",
        "compoundPeriod": "P1D"
      },
      "_profile": "https://api.apiture.com/schemas/products/summaryProduct/v2.3.0/profile.json",
      "_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"
        }
      }
    }
  }
}

Product Collection (v2.3.0)

A collection of product summaries in the _embedded.items array. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded productsEmbeddedObjects
_embedded.items is array of product summaries.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
count integer
The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start integer
The start index of this page of items.
limit integer
The maximum number of items per page.
name string
The name of the collection.

productsEmbeddedObjects

{
  "items": [
    {
      "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
      "_profile": "https://api.apiture.com/schemas/products/summaryProduct/v2.3.0/profile.json",
      "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",
      "target": "business",
      "_embedded": {},
      "ifxType": "DDA",
      "rates": {
        "apy": "1.45",
        "nominal": "1.455",
        "apye": "1.45",
        "compoundPeriod": "P1D",
        "accrualType": "compounding"
      },
      "paymentsEnabled": true,
      "checkOrderingEnabled": true,
      "constraints": {
        "transactionTypes": [
          "debit",
          "credit"
        ],
        "minimumBalance": "500.00",
        "minimumFundingAmount": "500.00",
        "maximumFundingAmount": "25000.00",
        "maximumTransferAmount": "25000.00",
        "fundingTerm": "P7D"
      },
      "_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"
        }
      }
    }
  ]
}

Products Embedded Objects (v2.3.0)

Objects embedded in the products schema's items array.

Properties

NameDescription
items [summaryProduct]
An array containing a page of product items.

rate

{
  "value": "1.40",
  "type": "apr"
}

Interest Rate (v1.1.0)

The interest rate for accounts. For deposit accounts, this is the rate of return. For loan accounts, this is the interest rate charged on balances. Rates can be fixed, such as "1.40" to indicate 1.4%, which is expressed as { "value" : "1.40" }, or relative to a benchmark, such as U.S. Prime Rate + 0.5% which is expressed as { "benchmark" : "prime", "value" : "0.50" }.
Warning: The schema rate was deprecated on version v0.20.0 of the API. Use rates object instead. rate will be removed on version v0.22.0 of the API.

Properties

NameDescription
value string
The rate, expressed as an decimal percentage string in order to represent the rate exactly. This number must have leading digits before the decimal point an two to threee decimal points, such as 2.00 or 0.50 or 1.015, but not 2 or .5.
pattern: ^-?\d{1,2}\.\d{2,3}$
benchmark string

An optional base benchmark that the rate is relative to. If omitted, the rate is fixed. Otherwise the rate is added to the benchmark rate. Values may be (but are not limited to):

compoundPeriod string
The period at which interest compounds.

This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days. The default is "P0D" (continuous).

accrualType accrualType
Indicates how interest is accrued according to the compoundPeriod.
adjustmentPeriod string(period)
The period at which the rate is adjusted or recomputed to account for differences in the benchmark rate.

This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days; The default is "P1D" (daily).

type interestRateType
The interest rate type.

root

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.0.0/profile.json",
  "_links": {}
}

API Root (v2.0.0)

A HAL response, with hypermedia _links for the top-level resources and operations in API.

This schema was resolved from common/root.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
_id string
This API's unique ID.
read-only
name string
This API's name.
apiVersion string
This API's version.

simpleLabel

{
  "label": "Board of Directors",
  "description": "string"
}

Simple Label (v1.0.0)

A text label and optional description.

This schema was resolved from common/simpleLabel.

Properties

NameDescription
label string (required)
A label or title which may be used as labels or other UI controls which present a value.
description string
A more detailed localized description of a localizable label.

summaryProduct

{
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "_profile": "https://api.apiture.com/schemas/products/summaryProduct/v2.3.0/profile.json",
  "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",
  "target": "business",
  "_embedded": {},
  "ifxType": "DDA",
  "rates": {
    "apy": "1.45",
    "nominal": "1.455",
    "apye": "1.45",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "paymentsEnabled": true,
  "checkOrderingEnabled": true,
  "constraints": {
    "transactionTypes": [
      "debit",
      "credit"
    ],
    "minimumBalance": "500.00",
    "minimumFundingAmount": "500.00",
    "maximumFundingAmount": "25000.00",
    "maximumTransferAmount": "25000.00",
    "fundingTerm": "P7D"
  },
  "_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"
    }
  }
}

Product Summary (v2.3.0)

Summary representation of a product resource in products collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects. This representation omits the attributes of the full representation.

Response and request bodies using this summaryProduct schema may contain the following links:

RelSummaryMethod
selfFetch a representation of this productGET
apiture:productTypeFetch a representation of this product type.GET
apiture:productSubtypeFetch a representation of this product type.GET

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
state prodState
The state of this product or product type. New resources are pending by default and must be activated before they may be used.

The state property is immutable and derived and may not be changed via the PUT or PATCH operations. To change the state of a product or product type, use the POST operation using the apiture:activate, apiture:deactivate or apiture:remove links on the resource.

name string
The name of this product.
minLength: 1
maxLength: 128
label string
The text label for this product. This field may be localized.
minLength: 1
maxLength: 128
description string(markdown)
A fuller description of this product. This field may be localized. The content is processed as Github Flavored Markdown and thus supports rich text.
minLength: 1
maxLength: 4096
code string
The unique product code for this product, normally defined by the underlying banking core. The code cannot be changed once the state is beyond pending.
maxLength: 64
newAccountAvailability newAccountAvailability
Indicates if the product is available for opening new accounts.

  • available means the product may be selected for a new account application.
  • notAvailable means the product may not be selected for a new account application.

The default is available. Note that clients must check both the product state and the newAccountAvailability when listing products for new account opening. The ?openable=true query parameter on getProducts combines these.

(Labels and descriptions for the enumeration values are in the newAccountAvailability key in the response of the getLabels operation.) Upate this property with the unlockProduct or unlockProduct operations
read-only

category string
The product category name. This is a more readable form of the product's type.
ifxType ifxType
The product IFX Account Type.
target productTarget
Describes the target audience or consumer of the accounts, personal or business. Labels and descriptions for the enumeration values are in the productTarget key in the response of the getLabels operation.
rates productInterestRates
The interest rates for this product.
rate rate
The interest rate for this product.
Warning: The property rate was deprecated on version v2.1.0 of the schema. Use rates object instead. rate will be removed on version v3.0.0 of the schema.
_id string
The unique identifier for this product resource. This is an immutable opaque string.
read-only
type string
The product type name, which is derived from the linked product type.
read-only
subtype string
The product subtype name, which is derived from the linked product subtype. This is a derived, immutable property.
read-only
timeDeposit timeDeposit
Properties of time deposit products, primarily Certificate of Deposit products.
constraints constraints
Product constraints, such as minimum and maximum balances.
paymentsEnabled boolean
If true, active accounts of this banking product may be eligible for payment features such as bill pay. This is merely the default; clients should check the paymentsEnabled property on the account service to ensure payment services are available for the authenticated account user.
The property paymentsEnabled was added on version 2.3.0 of the schema.
read-only
checkOrderingEnabled boolean
If true, active accounts derived from this banking product may allow ordering checks through the Check Orders API. Accounts inherit this value from their product. The financial institution may disable check ordering on individual accounts, so clients should reference the checkOrderingEnabled property on the account.
The property checkOrderingEnabled was added on version 2.3.0 of the schema.
Default: false
read-only

summaryProductType

{
  "_id": "eccb54ed-0f0a-443b-9f2e-32d5b8f4371c",
  "_profile": "https://api.apiture.com/schemas/products/summaryProductType/v1.0.1/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
}

Product Type Summary (v1.0.1)

Summary representation of a product type resource in product types collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects. This representation omits the attributes of the full representation.

Properties

NameDescription
state prodState
The state of this product or product type. New resources are pending by default and must be activated before they may be used.

The state property is immutable and derived and may not be changed via the PUT or PATCH operations. To change the state of a product or product type, use the POST operation using the apiture:activate, apiture:deactivate or apiture:remove links on the resource.

name string
The name of this product type.
minLength: 1
maxLength: 128
label string
The text label for this product type. This field may be localized.
minLength: 1
maxLength: 128
description string(markdown)
A fuller description of this product type. This field may be localized. The content is processed as Github Flavored Markdown and thus supports rich text.
minLength: 1
maxLength: 4096
subtype boolean
Indicates if this is a subtype. This is a derived, immutable property, based on whether the product type was created with a link to a parent type. See also the apiture:parent link on the productSubtype schema.
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
_id string
The unique identifier for this product type resource. This is an opaque string.
read-only

timeDeposit

{
  "maturityPolicy": "rolloverPrincipalAndInterest",
  "minimumTerm": "P31D",
  "maximumTerm": "P31D",
  "fees": "string"
}

Time Deposit Products (v1.0.0)

Properties of time deposit products, primarily Certificate of Deposit products.

Properties

NameDescription
maturityPolicy maturityPolicy
Indicates how the principal and interest are processed upon maturity. The values indicate whether to rollover (to a time deposit account of the same rate and term), transfer funds to another (possibly new) deposit account, or simply hold the funds in the current account (which may no longer accrue interest). Labels and descriptions for the enumeration values are in the maturityPolicy key in the response of the getLabels operation.

maturityPolicy strings may have one of the following enumerated values:

ValueDescription
rolloverPrincipalAndInterestRollover principal and interest to a new CD of the same product: Upon maturity, both principal and interest rollover into a specified banking product, such as a savings, checking, or other deposit account.
transferPrincipalAndInterestTransfer principal and interest to a deposit account: Upon maturity, the principal an interest are both transferred to an existing or new deposit account.
rolloverPrincipalAndTransferInterestTransfer interest to a new deposit account an rollover principal to a new CD of the same product: Upon maturity, the principal rolls over into a specified banking product and the interest is transferred to an existing deposit account.
holdPrincipalAndInterestHold principal and accued interest in the CD account until withdrawal: Upon maturity, the principal and interest are held in the current time deposit account. The account may or may not accrue further interest, depending on the terms of the time deposit product. Funds may be withdrawn or transferred.
partialTransferPartial Transfer: Upon maturity, any funds greater than the maturity threshold is transfered to an existing deposit account and the rest remains on deposit. The account may or may not accrue further interest, depending on the terms of the time deposit product. Funds may be withdrawn or transferred.

These enumeration values are further described by the label group named maturityPolicy in the response from the getLabels operation.

minimumTerm string(period)
The minimum maturity term offered by this product, for products such as certificates of deposits. See also maximumTerm For example, Some CD products may be opened with a flexible term such as 31 to 181 days, expressed as minimumTerm: P31D, maximumTerm: P181D For fixed-term products, minimumTerm and maximumTerm should be the same.

This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days. For example, the values P30D, P6M, P2Y indicate a term of 30 days, six months, and two years, respectively.

maximumTerm string(period)
The maximum maturity term offered by this product, for products such as certificates of deposits. If omitted, there is no fixed term (not all product types impose a term). For example, Some CD products may be opened with a flexible term such as 31 to 181 days, expressed as minimumTerm: P31D, maximumTerm: P181D For fixed-term products, minimumTerm and maximumTerm should be the same.

This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days. For example, the values P30D, P6M, P2Y indicate a term of 30 days, six months, and two years, respectively.

fees string(period)
The time period in which additional deposits may be made to a CD after it has rolled over after maturity. This value applies only if the depositsAllowed is duringGracePeriod. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days.

transactionType

"debit"

Transaction Type (v1.0.0)

A string which defines a transaction type allowed for an account.

transactionType strings may have one of the following enumerated values:

ValueDescription
debitA transaction which descreases an account's balance
creditA transaction which increases an accounts's balance

These enumeration values are further described by the label group named transactionType in the response from the getLabels operation.

Type: string
Enumerated values:
debit
credit

transactionTypes

[
  "debit"
]

Transaction Types (v1.0.0)

An array which lists which transaction types are allowed for an account.

transactionTypes is an array schema.

Array Elements

NameDescription
Transaction Types (v1.0.0) [transactionType]
An array which lists which transaction types are allowed for an account.