Check Orders v0.18.0

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

The Check Orders API allows bank customers to order new checkbooks for their checking accounts. This API manages several resources:

• Checking Products lists the orderable products, such as checkbooks and checkbook covers. Products are filterable by an existing checking account to list products available for that account. This is a read-only resource.
• A Check Order consists of an order of a Checkbook and/or a Checkbook Cover order items and quantities.

Clients should list the available checking products for an active checking account and product type, such as GET /checkOrders/products?type=checkbook&account={accountId}. The client should then create a new check order resource. As the customer chooses products from the list of orderable products, the client can set the order's checkbook or set new order's checkbook cover. While the order is pending, the client may perform the following operations:

• update the order
• set or replace the order's checkbook
• add the default checkbook cover to the order or set or replace the order's checkbook cover
• delete the order's checkbook
• delete the order's checkbook cover

The API computes the cost of the order, if any, as the customer makes changes. The corresponding account must have a balance to cover the cost. To submits the order, use the submitOrder operation.

Some checkbook products come in pairs that offer single checks or duplicate checks. The customer can easily toggle the order's checkbook product between the two. The client can POST to the apiture:convertToDuplicateChecks link (with no request body) to change the checkbook product from single to duplicate checks or or the apiture:convertToSingleChecks link to convert from duplicate to single checks. The link are conditional, based on whether the checkbook product offers the alternatives.

The client may also list the customer's previously submitted check orders with GET /checkOrders/orders?state=submitted&account={accountId} and create a new order based on the saved order details from a previous order with POST /checkOrders/order?copyOf={orderId}.

The system may delete older orders once they pass an expiration and are no longer re-orderable.

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.

addressIsPending

Description: Check orders are not allowed if the user has pending (not yet approved) address changes.
Remediation: Wait until the the financial institution has approved all address changes.

checkOrderRefNotFound

Description: There is no check order resource for the given checkOrder query parameter.
Remediation: Supply the _id of an existing check order resource in the checkOrder query parameter.

duplicateOrder

Description: The order has already been submitted, or another check order has been made elsewhere which renders this order invalid.
Remediation: Do not submit an order twice. The client should replace the stale, local copy of the check order with the response from submitOrder.

groupNotFound

Description: No Groups were found for the specified groupName.
Remediation: Check to make sure that the supplied groupName corresponds to an apiture group resource.

ineligibleAccount

Description: The selected account is not eligible for check orders.
Remediation: Select an open active checking account.

ineligibleCheckingProduct

Description: The selected product is not eligible for check order for the selected account.
Remediation: Choose a checking product that is orderable for the account (use GET /products?account={accountId}).

insufficientFunds

Description: The account balance is insufficient to cover the cost of this order.
Remediation: Remove items from the order or wait until more funds are available.

invalidCoverForCheckbook

Description: The checkbook cover is not compatible with the checkbook in the order.
Remediation: Select a compatible cover, or replace the checkbook with one that is compatible before ordering this cover.

invalidId

Description: The _id in the request body does not match the corresponding path variable.
Remediation: Do not modify the _id in the response from the GET and always PUT back using the same URL.

invalidOrder

Description: The previous order is not canceled, submitted, or processed, or it refers to an ineligible account.
Remediation: Only reorder from valid previous orders with a apiture:copyCheckOrder link.

invalidPreviousCheckOrder

Description: The checkOrder is not eligible for copying.
Remediation: Use a more recent previously submitted check order that is associated with the same account.

invalidProduct

Description: The selected product does not exist or is not allowed for this account type.
Remediation: Select a valid personal product for personal checking accounts or a valid business product for business account.

invalidProductForAccount

Description: The selected product is not allowed for this order item.
Remediation: Use checkbook products for the checkbook order item and cover products for the checkbookCover order item.

invalidQuantity

Description: The selected corresponding product for the quantity does not exist.
Remediation: Choose and existing product to create a quantity for.

invalidShippingAddressId

Description: There is no such address resource for this shippingAddressId.
Remediation: Use an address _id of the account owner for personal checking accounts or an address _id of the owning organization for business checking accounts.

invalidShippingAddressSource

Description: The shipping address source must be either organization or user.
Remediation: Provide a value of either organization or user.

noDefaultCover

Description: The selected product does not have a default checkbook cover product.
Remediation: Use the setDefaultCheckbookCover only if the checkbook order has a apiture:setDefaultCheckbookCover link.

noSuchAlternateProduct

Description: The checkbook product in this order does not have an alternative product.
Remediation: Choose a product that has single/duplicate check alternatives.

noSuchCheckbook

Description: There is no checkbook in the check order.
Remediation: Add a checkbook first.

noSuchCheckbookCover

Description: There is no checkbook cover in the check order.
Remediation: Add a checkbook cover first.

noSuchOrder

Description: There is no such check order resource for this orderId.
Remediation: Use an order _id of an existing check order resource.

orderIsImmutable

Description: Cannot change a processed check order.
Remediation: Create a new order and modify it.

valueNotFound

Description: No Group values were found for the specified groupName and valueName.
Remediation: Check to make sure that the supplied groupName and valueName corresponds to an apiture group and value resource.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.devbank.apiture.com/checkOrders

Terms of service

Email: Apiture Web: Apiture

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based authentication. Each client application must pass its private, unique API key, allocated in the developer portal, via the API-Key: {api-key} request header.

• OAuth2 authentication (accessToken)
  • OAuth2 client access token authentication. The client authenticates against the server at authorizationUrl, passing the client's private clientId (and optional clientSecret) as part of this flow. The client obtains an access token from the server at tokenUrl. It then passes the received access token via the Authorization: Bearer {access-token} header in subsequent API calls. The authorization process also returns a refresh token which the client should use to renew the access token before it expires.
  • Flow: authorizationCode
  • Authorization URL = https://auth.apiture.com/oauth2/authorize
  • Token URL = https://auth.apiture.com/auth/oauth2/token

Scope	Scope Description
banking/read	Read access to accounts and account-related resources such as transfers and transactions.
banking/write	Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete	Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance	Read access to account balances. This must be granted in addition to the banking/read scope in order to view balances, but is included in the banking/full scope.
banking/full	Full access to accounts and account-related resources such as transfers and transactions.

Checking Products

Checking Products

getProducts

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Return a collection of checking products

GET https://api.devbank.apiture.com/checkOrders/products

Return a collection of checking products.

Parameters

Parameter	Description
account in: query	string Return only products that are eligible for ordering for the account identified by this ID. The value is _id of an Account resource (not an account number). The customer must be the account owner (for personal accounts) or an authorized signer (for business accounts).
type in: query	string Filter only products of the listed type. This corresponds to the type property on the checking product. enum values: checkbook, checkbookCover

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkingProducts/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/products?start=10&limit=10"
    }
  },
  "name": "checkingProducts",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": [
      {
        "code": "S-EXDDB",
        "name": "Business Checks",
        "label": "Executive Deskbook - Blu Safety Checks - Single",
        "description": "Business Blue safety checks",
        "type": "checkbook",
        "accountTarget": "business",
        "checkbookOptions": {
          "includedCheckbookCoverProductId": "C-CMEXEB",
          "includesDuplicateChecks": false,
          "correspondingDuplicateProductId": "D-DXDDB"
        },
        "currency": "USD",
        "quantities": [
          {
            "quantity": 250,
            "price": "75.00"
          },
          {
            "quantity": 500,
            "price": "150.00"
          },
          {
            "quantity": 1000,
            "price": "300.00"
          }
        ],
        "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkingProduct/v1.3.1/profile.json",
        "_links": {
          "self": {
            "href": "https://production.api.apiture.com/checkOrders/products/D-DXDDB-a1b2"
          }
        }
      },
      {
        "code": "DXDDB",
        "name": "Business Checks",
        "label": "Executive Deskbook - Blu Safety Checks - Duplicate",
        "description": "Business Blue safety checks with duplicate checks",
        "type": "checkbook",
        "accountTarget": "business",
        "checkbookOptions": {
          "includedCheckbookCoverProductId": "C-CMEXEB",
          "includesDuplicateChecks": true,
          "correspondingSingleProductId": "S-EXDDB"
        },
        "currency": "USD",
        "quantities": [
          {
            "quantity": 250,
            "price": "100.00"
          },
          {
            "quantity": 500,
            "price": "15200.00"
          },
          {
            "quantity": 1000,
            "price": "400.00"
          }
        ],
        "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkingProduct/v1.3.1/profile.json",
        "_links": {
          "self": {
            "href": "https://production.api.apiture.com/checkOrders/products/D-DXDDB-a1b2"
          }
        }
      }
    ]
  }
}

Responses

getProduct

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Fetch a representation of this checking product

GET https://api.devbank.apiture.com/checkOrders/products/{productId}

Return a HAL representation of this checking product resource.

Parameters

Parameter	Description
productId in: path	string (required) The unique identifier of this checking product. This is an opaque string.
If-None-Match in: 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.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkingProduct/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/products/D-DXDDB-a1b2"
    },
    "apiture:includedCover": {
      "href": "https://production.api.apiture.com/checkOrders/products/C-CMEXEB-a1b2"
    },
    "apiture:includedCoverImage": {
      "href": "https://cdn.apiture.com/images/checkOrders/products/C-CMEXEB.png"
    },
    "apiture:correspondingSingleChecksProduct": {
      "href": "https://production.api.apiture.com/checkOrders/products/S-EXDDB-a1b2"
    }
  },
  "code": "D-DXDDB",
  "name": "Business Checks",
  "label": "Executive Deskbook - Check Binder Safety Checks - Duplicate",
  "description": "Business Blue safety checks with duplicates",
  "type": "checkbook",
  "accountTarget": "business",
  "checkbookOptions": {
    "includedCheckbookCoverProductId": "C-CMEXEB",
    "includesDuplicateChecks": false,
    "correspondingSingleProductId": "S-EXDDB"
  },
  "currency": "USD",
  "quantities": [
    {
      "quantity": 250,
      "price": "75.00"
    },
    {
      "quantity": 500,
      "price": "150.00"
    },
    {
      "quantity": 1000,
      "price": "300.00"
    }
  ],
  "images": [
    {
      "uri": "http://cdn.example.com/images/checkOrders/products/S-WALHHSC.png",
      "height": 1024,
      "width": 833
    }
  ]
}

Responses

Check Orders

Check Orders

chooseAlternateCheckbook

Code samples

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

POST https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook/alternateCheckbook HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook/alternateCheckbook',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook/alternateCheckbook',
  method: 'post',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook/alternateCheckbook',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook/alternateCheckbook', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook/alternateCheckbook");
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"},
        "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/checkOrders/orders/{orderId}/checkbook/alternateCheckbook", data)
    req.Header = headers

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

Choose an alternate checkbook

POST https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook/alternateCheckbook

Change a checkbook order from single checks to duplicate checks, or from duplicate checks to single checks. This replaces the checkbook resource with one that corresponds to the current product, but maintains the other order options, such as quantity.

If the order includes a checkbook cover, it may be changed to the cover corresponding to the new product if they differ. The service will recompute the cost of the order.

This operation is conditionally available with apiture:convertToDuplicateChecks or apiture:convertToSingleChecks links on a check order.

Parameters

Parameter	Description
orderId in: path	string (required) The unique identifier (_id) of a previous check order to copy.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}

Responses

getOrders

Code samples

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

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

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/orders',
{
  method: 'GET',

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Return a collection of check orders

GET https://api.devbank.apiture.com/checkOrders/orders

Return a paginated sortable filterable collection of check orders. The links in the response include pagination links.

Parameters

Parameter	Description
account in: query	string Filter orders by account identified by this ID. The value is _id of an Account resource (not an account number). The customer must be the account owner (for personal accounts) or an authorized signer (for business accounts).
state in: query	array[string] Subset the result to those orders whose state matches one of the passed values. For example, ?state=pending or ?state=canceled|submitted. pipe-delimited items: string » enum values: pending, submitted, canceled, processed, failed
start in: query	integer(int64) The zero-based index of the first check order item to include in this page. The default 0 denotes the beginning of the collection. format: int64 default: 0
limit in: query	integer(int32) The maximum number of check order representations to return in this page. format: int32 default: 100
sortBy in: query	string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2. This collection may be sorted by the following properties: • state • name • createdAt • updatedAt • startingCheckNumber.
filter in: query	string Optional filter criteria. See filtering. This collection may be filtered by the following properties and functions:.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrders/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?start=10&limit=10"
    },
    "first": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?start=0&limit=10"
    },
    "next": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?start=20&limit=10"
    },
    "collection": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders"
    }
  },
  "name": "checkOrders",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": [
      {
        "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
        "state": "submitted",
        "name": "Lucille Welphunded",
        "shippingAddressId": "ha1",
        "shippingAddressSource": "organization",
        "line1": "\"I have a dream\"",
        "startingCheckNumber": 2401,
        "shippingAddress": {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        "checkAddress": {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        "cost": {
          "total": "22.00",
          "currency": "USD"
        },
        "createdAt": "2020-08-03T13:01:47.375Z",
        "submittedAt": "2020-08-03T13:09:54.375Z",
        "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
        "_links": {
          "self": {
            "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
          }
        }
      }
    ]
  }
}

Responses

createOrder

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/checkOrders/orders \
  -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/checkOrders/orders HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    }
  },
  "name": "Lucille Welphunded",
  "line1": "\"I have a dream\"",
  "checkAddress": {
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user"
}';
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/checkOrders/orders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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/checkOrders/orders',
  method: 'post',

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

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/checkOrders/orders',
  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/checkOrders/orders', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/orders");
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/checkOrders/orders", data)
    req.Header = headers

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

Create a new check order

POST https://api.devbank.apiture.com/checkOrders/orders

Create a new check order resource. The request body must contain links to the checking account. A new order may also be created by copying an existing order via the ?copyOf={orderId} query parameter.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    }
  },
  "name": "Lucille Welphunded",
  "line1": "\"I have a dream\"",
  "checkAddress": {
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user"
}

Parameters

Parameter	Description
copyOf in: query	string Make a new order that is a copy of a previous order. The value is the _id of the check order to copy; it must be submitted, canceled, or processed The new order will copy the details from the previous order, but calculate a new cost. Values in the request body, if any, override those from the previous order.
body	createCheckOrder (required) The check order representation.

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}

Responses

getOrder

Code samples

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

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

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/orders/{orderId}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/checkOrders/orders/{orderId}', params={

}, headers = headers)

print r.json()

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

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

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

Fetch a representation of this check order

GET https://api.devbank.apiture.com/checkOrders/orders/{orderId}

Return a HAL representation of this check order resource.

Parameters

Parameter	Description
If-None-Match in: 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.
orderId in: path	string (required) The unique identifier of this check order. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}

Responses

updateOrder

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/checkOrders/orders/{orderId} \
  -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/checkOrders/orders/{orderId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}';
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/checkOrders/orders/{orderId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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/checkOrders/orders/{orderId}',
  method: 'put',

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

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/checkOrders/orders/{orderId}',
  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/checkOrders/orders/{orderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/orders/{orderId}");
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/checkOrders/orders/{orderId}", data)
    req.Header = headers

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

Update this check order

PUT https://api.devbank.apiture.com/checkOrders/orders/{orderId}

Replace the properties of this check order. Updatable properties include the name, line1, line2, shippingAddressId, shippingAddressSource, and checkAddress. The _id must match the {orderId}. This operation does not change the checkbook and checkbook cover; use the setCheckbook setCheckbookCover operations.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}

Parameters

Parameter	Description
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.
body	checkOrder (required) The check order representation.
orderId in: path	string (required) The unique identifier of this check order. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}

Responses

patchOrder

Code samples

# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/checkOrders/orders/{orderId} \
  -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/checkOrders/orders/{orderId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}';
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/checkOrders/orders/{orderId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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/checkOrders/orders/{orderId}',
  method: 'patch',

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

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/checkOrders/orders/{orderId}',
  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/checkOrders/orders/{orderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/orders/{orderId}");
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/checkOrders/orders/{orderId}", data)
    req.Header = headers

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

Update this check order

PATCH https://api.devbank.apiture.com/checkOrders/orders/{orderId}

Perform a partial update of this check order. Fields which are omitted are not updated. Nested _embedded and _links are ignored if included. Patchable properties include the name, line1, line2, shippingAddressId, shippingAddressSource, and checkAddress. The _id must match the {orderId}. This operation does not change the checkbook and checkbook cover; use the setCheckbook setCheckbookCover operations.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}

Parameters

Parameter	Description
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.
body	checkOrder (required) The patch request body.
orderId in: path	string (required) The unique identifier of this check order. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}

Responses

Check Order Actions

Actions on Check Orders

cancelOrder

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/checkOrders/canceledOrders?order=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/checkOrders/canceledOrders?order=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

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/checkOrders/canceledOrders?order=string',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/canceledOrders',
  method: 'post',
  data: '?order=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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/checkOrders/canceledOrders',
  params: {
  'order' => '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/checkOrders/canceledOrders', params={
  'order': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/canceledOrders?order=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/checkOrders/canceledOrders", data)
    req.Header = headers

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

Cancel a check order

POST https://api.devbank.apiture.com/checkOrders/canceledOrders

Cancel a check order. This changes the state property of the check order to canceled. This operation is available via the apiture:cancel link on a pending or submitted check order resource. The response is the updated representation of the check order. The If-Match request header value, if passed, must match the current entity tag value of the check order.

A customer can create and update a check order if the account does not have sufficient funds, but the submit operation is blocked.

Parameters

Parameter	Description
order in: query	string (required) A string which uniquely identifies a check order which is to added to the submitted check orders resource set. This may be the unique checkOrderId or the URI of the check order.
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}

Responses

submitOrder

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/checkOrders/submittedOrders?order=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/checkOrders/submittedOrders?order=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

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/checkOrders/submittedOrders?order=string',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/submittedOrders',
  method: 'post',
  data: '?order=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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/checkOrders/submittedOrders',
  params: {
  'order' => '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/checkOrders/submittedOrders', params={
  'order': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/submittedOrders?order=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/checkOrders/submittedOrders", data)
    req.Header = headers

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

Submit a check order

POST https://api.devbank.apiture.com/checkOrders/submittedOrders

Submit a pending check order. This changes the state property of the check order to submitted. This operation is available via the apiture:submit link on the check order resource, if and only if the check order state is pending, the order has a checkbook item, and the account balance is sufficient to cover the cost of the order. The response is the updated representation of the check order. The If-Match request header value, if passed, must match the current entity tag value of the check order.

Parameters

Parameter	Description
order in: query	string (required) A string which uniquely identifies a check order which is to added to the submitted check orders resource set. This may be the unique checkOrderId or the URI of the check order.
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}

Responses

Check Order Items

Check Order Items

getCheckbook

Code samples

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

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

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Fetch the order's checkbook

GET https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook

Return a HAL representation of the checkbook in this check order.

Parameters

Parameter	Description
If-None-Match in: 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.
orderId in: path	string (required) The unique identifier of this check order. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbook"
    },
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC-a1b2"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  },
  "productCode": "S-WALHHSC",
  "quantity": 200,
  "price": "20.00",
  "type": "personalCheckbook",
  "label": "Personal Checks",
  "duplicates": false
}

Responses

setCheckbook

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook \
  -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/checkOrders/orders/{orderId}/checkbook HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbook"
    },
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC-a1b2"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  },
  "productCode": "S-WALHHSC",
  "quantity": 200,
  "price": "20.00",
  "type": "personalCheckbook",
  "label": "Personal Checks",
  "duplicates": false
}';
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/checkOrders/orders/{orderId}/checkbook',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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/checkOrders/orders/{orderId}/checkbook',
  method: 'put',

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

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/checkOrders/orders/{orderId}/checkbook',
  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/checkOrders/orders/{orderId}/checkbook', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook");
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/checkOrders/orders/{orderId}/checkbook", data)
    req.Header = headers

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

Set the order's checkbook

PUT https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook

Create or update the checkbook item in this check order. Updatable properties include quantity and the apiture:product link. The product link is the URL of a checking product; it must be a checkbook product from the GET /products?type=checkbook&account={accountId} list of products.

The client should fetch the updated check order after this operation. (This operation updates the cost of the order.)

If this order also has a checkbook cover, and that cover is not compatible with the new checkbook product, this operation removes the checkbook cover from the order. The client should consider using setDefaultCheckbookCover if the customer has indicated they want a checkbook and the updated order includes the apiture:setDefaultCheckbookCover link. (If no such link exists in the updated order response, the order's checkbook does not have an orderable default checkbook cover, or it already includes a cover.)

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbook"
    },
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC-a1b2"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  },
  "productCode": "S-WALHHSC",
  "quantity": 200,
  "price": "20.00",
  "type": "personalCheckbook",
  "label": "Personal Checks",
  "duplicates": false
}

Parameters

Parameter	Description
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.
body	checkOrderCheckbook (required) The checkbook for this order.
orderId in: path	string (required) The unique identifier of this check order. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Responses

deleteCheckbook

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook HTTP/1.1
Host: api.devbank.apiture.com

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

const headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook',
{
  method: 'DELETE',

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

var headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook',
  method: 'delete',

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

require 'rest-client'
require 'json'

headers = {
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook");
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{
        "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/checkOrders/orders/{orderId}/checkbook", data)
    req.Header = headers

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

Delete an order's checkbook

DELETE https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbook

Delete the checkbook item from the check.

The client should fetch the updated check order after this operation. (This operation updates the cost of the order.)

Parameters

Parameter	Description
orderId in: path	string (required) The unique identifier of this check order. This is an opaque string.

Responses

getCheckbookCover

Code samples

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

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

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Fetch the order's checkbook cover

GET https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover

Return a HAL representation of the checkbook cover in this check order.

Parameters

Parameter	Description
If-None-Match in: 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.
orderId in: path	string (required) The unique identifier of this check order. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/products/C-CVRBB-a1b2"
    }
  },
  "productCode": "CVRBB",
  "label": "Executive Deskbook Check Binder",
  "price": "33.00",
  "quantity": 1,
  "self": {
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  }
}

Responses

setCheckbookCover

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover \
  -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/checkOrders/orders/{orderId}/checkbookCover HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/products/C-CVRBB-a1b2"
    }
  },
  "productCode": "CVRBB",
  "label": "Executive Deskbook Check Binder",
  "price": "33.00",
  "quantity": 1,
  "self": {
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  }
}';
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/checkOrders/orders/{orderId}/checkbookCover',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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/checkOrders/orders/{orderId}/checkbookCover',
  method: 'put',

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

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/checkOrders/orders/{orderId}/checkbookCover',
  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/checkOrders/orders/{orderId}/checkbookCover', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover");
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/checkOrders/orders/{orderId}/checkbookCover", data)
    req.Header = headers

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

Set the order's checkbook cover

PUT https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover

Create or update the checkbook cover item in this check order. Updatable properties include quantity and the product link. The apiture:product link is the URL of a checking product; it must be a product from the GET /products?type=checkbook&account={accountId} list of products.

The client should fetch the updated check order after this operation. (This operation updates the cost of the order.)

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/products/C-CVRBB-a1b2"
    }
  },
  "productCode": "CVRBB",
  "label": "Executive Deskbook Check Binder",
  "price": "33.00",
  "quantity": 1,
  "self": {
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  }
}

Parameters

Parameter	Description
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.
body	checkOrderCheckbookCover (required) The check order checkbook cover representation.
orderId in: path	string (required) The unique identifier of this check order. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/products/C-CVRBB-a1b2"
    }
  },
  "productCode": "CVRBB",
  "label": "Executive Deskbook Check Binder",
  "price": "33.00",
  "quantity": 1,
  "self": {
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  }
}

Responses

deleteCheckbookCover

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover HTTP/1.1
Host: api.devbank.apiture.com

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

const headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover',
{
  method: 'DELETE',

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

var headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover',
  method: 'delete',

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

require 'rest-client'
require 'json'

headers = {
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover");
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{
        "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/checkOrders/orders/{orderId}/checkbookCover", data)
    req.Header = headers

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

Delete an order's checkbook cover

DELETE https://api.devbank.apiture.com/checkOrders/orders/{orderId}/checkbookCover

Delete the checkbook cover item from the check.

The client should fetch the updated check order after this operation. (This operation updates the cost of the order.)

Parameters

Parameter	Description
orderId in: path	string (required) The unique identifier of this check order. This is an opaque string.

Responses

setDefaultCheckbookCover

Code samples

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

POST https://api.devbank.apiture.com/checkOrders/orders/{orderId}/defaultCheckbookCover HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/orders/{orderId}/defaultCheckbookCover',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}/defaultCheckbookCover',
  method: 'post',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/checkOrders/orders/{orderId}/defaultCheckbookCover',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/checkOrders/orders/{orderId}/defaultCheckbookCover', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/orders/{orderId}/defaultCheckbookCover");
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"},
        "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/checkOrders/orders/{orderId}/defaultCheckbookCover", data)
    req.Header = headers

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

Add the default checkbook cover to the order

POST https://api.devbank.apiture.com/checkOrders/orders/{orderId}/defaultCheckbookCover

Some checkbook products offer a matching checkbook cover product, but it must be ordered separately. This operation removes the existing checkbook cover from the order, if any, and adds the default checkbook cover for the current checkbook. Call this after setCheckbook via a POST to the apiture:setDefaultCheckbookCover link, if and only if that link is present on the check order. The checkbook product lists the default cover's product code in the product.checkbookOptions.checkbookCoverProductIds array. This operation does nothing if the default cover is already set.

The client should use the returned check order after this operation. (This operation may update the cost of the order.)

Parameters

Parameter	Description
orderId in: path	string (required) The unique identifier of this check order. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}

Responses

API

The Check Orders API.

getApi

Code samples

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

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

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/',
{
  method: 'GET',

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/checkOrders/',
  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/checkOrders/', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/");
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/checkOrders/", data)
    req.Header = headers

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

Top-level resources and operations in this API

GET https://api.devbank.apiture.com/checkOrders/

Return links to the top-level resources and operations in this API.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

Responses

getApiDoc

Code samples

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

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

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/apiDoc',
{
  method: 'GET',

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

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

};

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

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/checkOrders/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/checkOrders/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/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/checkOrders/apiDoc", data)
    req.Header = headers

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

Return API definition document

GET https://api.devbank.apiture.com/checkOrders/apiDoc

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

Response Schema

getLabels

Code samples

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

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

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/labels',
{
  method: 'GET',

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

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

};

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

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

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/checkOrders/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/checkOrders/labels', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/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/checkOrders/labels", data)
    req.Header = headers

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

Localized Labels

GET https://api.devbank.apiture.com/checkOrders/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 in: header	string The weighted language tags which indicate the customer's preferred natural language for the localized labels in the response, as per RFC 7231.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "groups": {
    "firstGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "key1": {
        "label": "Label for Key 1",
        "code": "1",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 1)"
          },
          "fr": {
            "label": "(French label for Key 1)"
          }
        }
      },
      "key2": {
        "label": "Label for Key 2",
        "code": "2",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 2)"
          },
          "fr": {
            "label": "(French label for Key 2)"
          }
        }
      },
      "key3": {
        "label": "Label for Key 3",
        "code": "3",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 3)"
          },
          "fr": {
            "label": "(French label for Key 3)"
          }
        }
      },
      "other": {
        "label": "Other",
        "variants": {
          "es": {
            "label": "(Spanish label for Other)"
          },
          "fr": {
            "label": "(French label for Other)"
          }
        },
        "code": "254"
      }
    },
    "secondGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "?",
        "hidden": true
      },
      "optionA": {
        "label": "Option A",
        "code": "A"
      },
      "optionB": {
        "label": "Option B",
        "code": "B"
      },
      "optionC": {
        "label": "Option C",
        "code": "C"
      },
      "other": {
        "label": "Other",
        "code": "_"
      }
    }
  }
}

Responses

Configuration

Products Service Configuration

getConfigurationGroups

Code samples

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

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

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/configurations/groups',
{
  method: 'GET',

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

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

Return a collection of configuration groups

GET https://api.devbank.apiture.com/checkOrders/configurations/groups

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroups/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/configurations/groups?start=10&limit=10"
    },
    "first": {
      "href": "/configurations/configurations/groups?start=0&limit=10"
    },
    "next": {
      "href": "/configurations/configurations/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/configurations/configurations/groups"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_embedded": {
    "items": [
      {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/basic"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/calendar"
          }
        },
        "name": "calendar",
        "label": "Calendar",
        "description": "A calendar that specifies which dates are valid for performing transfers (e.g., weekdays excluding federal holidays)"
      }
    ]
  }
}

Responses

getConfigurationGroup

Code samples

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

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

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Fetch a representation of this configuration group

GET https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}

Return a HAL representation of this configuration group resource.

Parameters

Parameter	Description
groupName in: path	string (required) The unique name of this configuration group.
If-None-Match in: 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.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API",
  "schema": {
    "type": "object",
    "properties": {
      "dailyLimit": {
        "type": "number",
        "description": "The daily limit for the number of transfers"
      },
      "cutoffTime": {
        "type": "string",
        "format": "time",
        "description": "The cutoff time for scheduling transfers for the current day"
      }
    }
  },
  "values": {
    "dailyLimit": 5,
    "cutoffTime": 63000
  }
}

Responses

getConfigurationGroupSchema

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/schema \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/schema HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/schema',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/schema',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/schema',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/schema', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/schema");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Fetch the schema for this configuration group

GET https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/schema

Return a HAL representation of this configuration group schema resource.

Parameters

Parameter	Description
groupName in: path	string (required) The unique name of this configuration group.
If-None-Match in: 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.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Responses

getConfigurationGroupValues

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Fetch the values for the specified configuration group

GET https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values

Return a representation of this configuration group values resource.

Parameters

Parameter	Description
groupName in: path	string (required) The unique name of this configuration group.
If-None-Match in: 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.

Example responses

200 Response

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Responses

updateConfigurationGroupValues

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values \
  -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/checkOrders/configurations/groups/{groupName}/values HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "dailyLimit": 5,
  "cutoffTime": 63000
}';
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/checkOrders/configurations/groups/{groupName}/values',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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/checkOrders/configurations/groups/{groupName}/values',
  method: 'put',

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

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/checkOrders/configurations/groups/{groupName}/values',
  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/checkOrders/configurations/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values");
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/checkOrders/configurations/groups/{groupName}/values", data)
    req.Header = headers

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

Update the values for the specified configuration group

PUT https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values

Perform a complete replacement of this set of values.

Body parameter

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Parameters

Parameter	Description
groupName in: path	string (required) The unique name of this configuration group.
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.
body	configurationValues (required)

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Responses

getConfigurationGroupValue

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values/{valueName} \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values/{valueName} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values/{valueName}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values/{valueName}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values/{valueName}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values/{valueName}");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

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

Fetch a single value associated with the specified configuration group

GET https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values/{valueName}

Fetch a single value associated with this configuration group. This provides convenient access to individual values of the configuration group. The response is always a JSON value which can be parsed with a strict JSON parser. The response may be

• a primitive number, boolean, or quoted JSON string.
• a JSON array.
• a JSON object.
• null. Examples:
• "a string configuration value"
• 120
• true
• null
• { "borderWidth": 8, "foregroundColor": "blue" } To update a specific value, use PUT /users/configurations/groups/{groupName}/values/{valueName} (operation updateConfigurationGroupValue).

Parameters

Parameter	Description
groupName in: path	string (required) The unique name of this configuration group.
valueName in: path	string (required) The unique name of a value in a configuration group. This is the name of the value in the schema. A {valueName} must be a simple identifier following the pattern letter [letter | digit | '-' | '_']*.

Example responses

200 Response

"string"

Responses

updateConfigurationGroupValue

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values/{valueName} \
  -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/checkOrders/configurations/groups/{groupName}/values/{valueName} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = 'string';
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/checkOrders/configurations/groups/{groupName}/values/{valueName}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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/checkOrders/configurations/groups/{groupName}/values/{valueName}',
  method: 'put',

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

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/checkOrders/configurations/groups/{groupName}/values/{valueName}',
  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/checkOrders/configurations/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values/{valueName}");
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/checkOrders/configurations/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

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

Update a single value associated with the specified configuration group

PUT https://api.devbank.apiture.com/checkOrders/configurations/groups/{groupName}/values/{valueName}

Update a single value associated with this configuration group. This provides convenient access to individual values of the configuration group as defined in the configuration group's schema. The request body must conform to the configuration group's schema for the named {valueName}. This operation is idempotent. The request body must be a JSON value which can be parsed with a strict JSON parser. The response may be

• a primitive number, boolean, or quoted JSON string.
• a JSON array.
• a JSON object.
• null. Examples:
• "a string configuration value"
• 120
• true
• null
• { "borderWidth": 8, "foregroundColor": "blue" } To fetch specific value, use GET /users/configurations/groups/{groupName}/values/{valueName} (operation getConfigurationGroupValue).

Body parameter

"string"

Parameters

Parameter	Description
groupName in: path	string (required) The unique name of this configuration group.
valueName in: path	string (required) The unique name of a value in a configuration group. This is the name of the value in the schema. A {valueName} must be a simple identifier following the pattern letter [letter | digit | '-' | '_']*.
If-Match in: header	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.
body	string (required) The request body must a valid JSON value and should be parsable with a JSON parser. The result may be a string, number, boolean, array, or object.

Example responses

200 Response

"string"

Responses

Schemas

abstractRequest

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {}
}

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

Name	Description
Abstract Request (v2.0.0)	object 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.
_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.
_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. read-only format: uri

abstractResource

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Abstract Resource (v2.1.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

Name	Description
Abstract Resource (v2.1.0)	object 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.
_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.
_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. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only

address

{
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US",
  "_id": "ha5",
  "type": "home"
}

Address (v1.0.0)

A postal address with the address type and an identifier.

This schema was resolved from contacts/address.

Properties

Name	Description
Address (v1.0.0)	object A postal address with the address type and an identifier. This schema was resolved from contacts/address.
addressLine1	string The first street address line of the address, normally a house number and street name. minLength: 4 maxLength: 128
addressLine2	string The optional second street address line of the address. maxLength: 128
city	string The name of the city or municipality. minLength: 2 maxLength: 128
regionCode	string The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: "^[a-zA-Z]{2}$"
postalCode	string The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5 maxLength: 10 pattern: "^[0-9]{5}(?:-[0-9]{4})?$"
countryCode	string The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: "^[a-zA-Z]{2}$"
type	addressType (required) The type of this address. enum values: unknown, home, prior, work, school, mailing, vacation, shipping, billing, headquarters, commercial, site, property, other, notApplicable
label	string A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other read-only minLength: 4 maxLength: 32
otherType	string The actual address type if type is other. minLength: 4 maxLength: 32
_id	string An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array. minLength: 1 maxLength: 8 pattern: "^[-a-zA-Z0-9_]{1,8}$"

addressType

"unknown"

Address Type (v1.0.0)

The type of a postal address.

Warning: The enum list will be removed in a future release.

The allowed values for this property are defined at runtime in the label group named addressType in the response from the getLabels operation.

This schema was resolved from contacts/addressType.

type: string

enum values: unknown, home, prior, work, school, mailing, vacation, shipping, billing, headquarters, commercial, site, property, other, notApplicable

attributes

{}

Attributes (v2.1.0)

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

This schema was resolved from common/attributes.

Properties

Name	Description
Attributes (v2.1.0)	object An optional map of name/value pairs which contains additional dynamic data about the resource. This schema was resolved from common/attributes. Additional Properties: true

checkOrder

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "https://production.api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  },
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user",
  "line1": "\"I have a dream\"",
  "startingCheckNumber": 2401,
  "shippingAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "checkAddress": {
    "_id": "ha1",
    "type": "home",
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "cost": {
    "total": "2.00",
    "currency": "USD"
  },
  "discounts": [
    {
      "fixedAmount": "10.00",
      "type": "first100ChecksFree",
      "appliesTo": "checkbook"
    }
  ],
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "S-WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC"
        }
      }
    },
    "checkbookCover": {
      "productCode": "C-CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CVRRB"
        }
      }
    }
  }
}

Check Order (v1.6.1)

Representation of check order resources.

Links

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

Rel	Summary	Method
self	Fetch a representation of this check order	GET
apiture:account	The checking account associated with the check order	GET
apiture:submit	Submit a check order	POST
apiture:cancel	Cancel a check order	POST
apiture:copyCheckOrder	Create a new order using a copy of this order's details.	POST
apiture:checkbook	Fetch the order's checkbook	GET
apiture:checkbookCover	Fetch the order's checkbook cover	GET
apiture:convertToDuplicateChecks	Change the order's checkbook to the corresponding duplicate checks product	POST
apiture:convertToSingleChecks	Change the order's checkbook to the corresponding single checks product	POST
apiture:setDefaultCheckbookCover	Add the default checkbook cover to the order	POST

Properties

Name	Description
Check Order (v1.6.1)	object Representation of check order resources. Links Response and request bodies using this checkOrder schema may contain the following links: Rel Summary Method self Fetch a representation of this check order GET apiture:account The checking account associated with the check order GET apiture:submit Submit a check order POST apiture:cancel Cancel a check order POST apiture:copyCheckOrder Create a new order using a copy of this order's details. POST apiture:checkbook Fetch the order's checkbook GET apiture:checkbookCover Fetch the order's checkbook cover GET apiture:convertToDuplicateChecks Change the order's checkbook to the corresponding duplicate checks product POST apiture:convertToSingleChecks Change the order's checkbook to the corresponding single checks product POST apiture:setDefaultCheckbookCover Add the default checkbook cover to the order POST
_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.
_embedded	checkOrderEmbeddedObjects This order's checkbook and checkbook cover, if set on a check order. These objects are also available individually via the getCheckbook and getCheckbookCover operations and links.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string The name to display on the top of the checks. maxLength: 45
line1	string An additional line of text, printed on the check below the name. maxLength: 45
line2	string An additional line of text, printed on the check below the line2. maxLength: 45
checkAddress	address The address printed on the top of the check.
checkbookCode	string The product code for the corresponding checkbook product maxLength: 20
checkbookCoverCode	string The product code for the corresponding cover product maxLength: 20
checkbookQuantity	number The quantity amount for the corresponding checkbook product maximum: 6
shippingAddressId	string The _id of the postal address where the order is shipped. For a personal checking account, the _id is the address ID from the customer's addresses. For a business checking account, the _id is the address ID from the owning organization's addresses. minLength: 1 maxLength: 8 pattern: "^[-a-zA-Z0-9_]{1,8}$"
shippingAddressSource	shippingAddressSource Used with shippingAddressId to identify which resource the shipping address is associated with. For business checks, the default is organization and for personal checking, the default is user. enum values: organization, user
_id	string The unique identifier for this check order resource. This is an immutable opaque string. read-only
state	checkOrderState The state of this check order. This is updated by using the submitOrder or cancelOrder operations. read-only enum values: pending, submitted, processed, failed, canceled
shippingAddress	address The address where the check order is shipped. This is the address derived from the combination of shippingAddressSource and shippingAddressId read-only
startingCheckNumber	integer The starting check number, derived by adding 1 to the end of the previous check order range of the checking account. read-only minimum: 1
cost	checkOrderCost The sum of the prices of the checkbook and checkbook cover in this order, minus any discounts or credits. read-only
discounts	array: [checkOrderDiscount] Discounts the financial institution has applied to the order. This may be omitted if no discounts apply. read-only items: object
createdAt	string(date-time) Date-time the order resource was created (not not yet submitted), in RFC 3339 YYYY-MM-DDThh:mm:ssZ date-time format. read-only format: date-time
updatedAt	string(date-time) Date-time the order resource was last modified, in RFC 3339 YYYY-MM-DDThh:mm:ssZ date-time format. read-only format: date-time
submittedAt	string(date-time) Date-time the order resource was submitted, in RFC 3339 YYYY-MM-DDThh:mm:ssZ date-time format. Not present if the order has not yet been submitted. read-only format: date-time
canceledAt	string(date-time) Date-time the order resource was canceled. in RFC 3339 YYYY-MM-DDThh:mm:ssZ date-time format. Not present if the order has not been submitted. read-only format: date-time

checkOrderCheckbook

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbook"
    },
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC-a1b2"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  },
  "productCode": "S-WALHHSC",
  "quantity": 200,
  "price": "20.00",
  "type": "personalCheckbook",
  "label": "Personal Checks",
  "duplicates": false
}

Check Order Checkbook (v1.1.2)

The details of a checkbook item in a check order. The quantity is the number of checks in the order.

Links

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

Rel	Summary	Method
self	Fetch the order's checkbook	GET
apiture:product	The checking product for this order item	GET
apiture:setDefaultCheckbookCover	Add the default checkbook cover to the order	POST

Properties

Name	Description
Check Order Checkbook (v1.1.2)	object The details of a checkbook item in a check order. The quantity is the number of checks in the order. Links Response and request bodies using this checkOrderCheckbook schema may contain the following links: Rel Summary Method self Fetch the order's checkbook GET apiture:product The checking product for this order item GET apiture:setDefaultCheckbookCover Add the default checkbook cover to the order POST
_links	links (required) 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.
_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. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
quantity	integer The quantity for this line item. This is one of the values in the product's quantities array. For example, for a checkbook, the quantity 200 means a book of 200 checks.
label	string The label of the product selected for this order item. read-only
productCode	string The code of the product selected for this order item. read-only
price	string The price for this quantity. This is the price from the product's quantities array that corresponds to the quantity on this line item. read-only
duplicates	boolean true if this checkbook includes duplicate checks. read-only

checkOrderCheckbookCover

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/products/C-CVRBB-a1b2"
    }
  },
  "productCode": "CVRBB",
  "label": "Executive Deskbook Check Binder",
  "price": "33.00",
  "quantity": 1,
  "self": {
    "apiture:product": {
      "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  }
}

Check Order Checkbook Cover (v1.1.1)

The details of a checkbook cover item in a check order. The quantity is the number of covers to order.

Links

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

Rel	Summary	Method
self	Fetch the order's checkbook cover	GET
apiture:product	The checking product for this order item	GET

Properties

Name	Description
Check Order Checkbook Cover (v1.1.1)	object The details of a checkbook cover item in a check order. The quantity is the number of covers to order. Links Response and request bodies using this checkOrderCheckbookCover schema may contain the following links: Rel Summary Method self Fetch the order's checkbook cover GET apiture:product The checking product for this order item GET
_links	links (required) 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.
_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. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
quantity	integer The quantity for this line item. This is one of the values in the product's quantities array. For example, for a checkbook, the quantity 200 means a book of 200 checks.
label	string The label of the product selected for this order item. read-only
productCode	string The code of the product selected for this order item. read-only
price	string The price for this quantity. This is the price from the product's quantities array that corresponds to the quantity on this line item. read-only

checkOrderCost

{
  "currency": "USD",
  "total": "22.00"
}

Check Order Cost (v1.0.0)

The computed total cost of the check order.

Properties

Name	Description
Check Order Cost (v1.0.0)	object The computed total cost of the check order.
currency	string The ISO 4217 currency code for this balance. read-only minLength: 3 maxLength: 3 default: "USD" pattern: "[A-Z]{3}"
total	string(decimal) The total cost. The numeric value is represented as a string so that it can be represented exactly with no loss of precision. The currency is defined in the checkingProduct.currency (normally USD). read-only format: decimal pattern: "^-?\\d{1,5}\\.\\d{2}$"

checkOrderDiscount

{
  "type": "string",
  "fixedAmount": "20.00",
  "percentage": 100,
  "appliesTo": "checkbook"
}

Check Order Discounts (v1.1.0)

The discount amount and the reason for the discount.

Properties

Name	Description
Check Order Discounts (v1.1.0)	object The discount amount and the reason for the discount.
type	string The type of discount. The allowed values for this property are defined at runtime in the label group named checkOrderDiscountTypes in the response from the getLabels operation.
fixedAmount	string A discount amount, as a decimal currency value, using the currency of the order's cost. Mutually exclusive of percentage. pattern: "-?\\d{1,5}\\.\\d{2}$"
percentage	integer A percentage discount. Mutually exclusive of fixedAmount. minimum: 0 maximum: 100
appliesTo	checkingProductType Indicates what part of the check order the discount applies to. enum values: checkbook, checkbookCover

checkOrderEmbeddedObjects

{
  "checkbook": {
    "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.1.2/profile.json",
    "_links": {
      "self": {
        "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbook"
      },
      "apiture:product": {
        "href": "https://production.api.apiture.com/checkOrders/products/S-WALHHSC-a1b2"
      },
      "apiture:setDefaultCheckbookCover": {
        "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
      }
    },
    "productCode": "S-WALHHSC",
    "quantity": 200,
    "price": "20.00",
    "type": "personalCheckbook",
    "label": "Personal Checks",
    "duplicates": false
  },
  "checkbookCover": {
    "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
      },
      "apiture:product": {
        "href": "https://production.api.apiture.com/checkOrders/products/C-CVRBB-a1b2"
      }
    },
    "productCode": "CVRBB",
    "label": "Executive Deskbook Check Binder",
    "price": "33.00",
    "quantity": 1,
    "self": {
      "apiture:product": {
        "href": "https://production.api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
      }
    }
  }
}

Check Order Embedded Objects (v1.1.2)

Objects embedded in a check order.

Properties

Name	Description
Check Order Embedded Objects (v1.1.2)	object Objects embedded in a check order.
checkbook	checkOrderCheckbook The checkbook (getCheckbook).
checkbookCover	checkOrderCheckbookCover The checkbook cover (getCheckbookCover).

checkOrderState

"pending"

Check Order State (v1.1.0)

The state of the check order.

checkOrderState strings may have one of the following enumerated values:

Value	Description
pending	Pending: A check order that has been created but not yet submitted.
submitted	Submitted: A check order that has been submitted for processing. The financial institution will process the order later in the day, or the user can cancel or delete a submitted order before it is processed.
processed	Processed: A check order that has been processed and sent to the vendor. Users can not cancel processed orders.
failed	Failed: Processing the check order failed. The service retains orders that failed to process for manual review.
canceled	Canceled: A check order that has been canceled after being submitted. The service retains canceled orders for possible re-order.

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

type: string

enum values: pending, submitted, processed, failed, canceled

checkOrders

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrders/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?start=10&limit=10"
    },
    "first": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?start=0&limit=10"
    },
    "next": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders?start=20&limit=10"
    },
    "collection": {
      "href": "https://production.api.apiture.com/checkOrders/checkOrders"
    }
  },
  "name": "checkOrders",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": [
      {
        "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
        "state": "submitted",
        "name": "Lucille Welphunded",
        "shippingAddressId": "ha1",
        "shippingAddressSource": "organization",
        "line1": "\"I have a dream\"",
        "startingCheckNumber": 2401,
        "shippingAddress": {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        "checkAddress": {
          "_id": "ha1",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        "cost": {
          "total": "22.00",
          "currency": "USD"
        },
        "createdAt": "2020-08-03T13:01:47.375Z",
        "submittedAt": "2020-08-03T13:09:54.375Z",
        "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
        "_links": {
          "self": {
            "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
          }
        }
      }
    ]
  }
}

Check Order Collection (v1.6.1)

Collection of check orders. The items in the collection are ordered in the _embedded.items array; the name is checkOrders. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

Properties

Name	Description
Check Order Collection (v1.6.1)	object Collection of check orders. The items in the collection are ordered in the _embedded.items array; the name is checkOrders. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).
_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.
_embedded	embeddedCheckOrders Embedded objects: an array of checkOrders
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
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.

checkingProduct

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkingProduct/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/products/D-DXDDB-a1b2"
    },
    "apiture:includedCover": {
      "href": "https://production.api.apiture.com/checkOrders/products/C-CMEXEB-a1b2"
    },
    "apiture:includedCoverImage": {
      "href": "https://cdn.apiture.com/images/checkOrders/products/C-CMEXEB.png"
    },
    "apiture:correspondingSingleChecksProduct": {
      "href": "https://production.api.apiture.com/checkOrders/products/S-EXDDB-a1b2"
    }
  },
  "code": "D-DXDDB",
  "name": "Business Checks",
  "label": "Executive Deskbook - Check Binder Safety Checks - Duplicate",
  "description": "Business Blue safety checks with duplicates",
  "type": "checkbook",
  "accountTarget": "business",
  "checkbookOptions": {
    "includedCheckbookCoverProductId": "C-CMEXEB",
    "includesDuplicateChecks": false,
    "correspondingSingleProductId": "S-EXDDB"
  },
  "currency": "USD",
  "quantities": [
    {
      "quantity": 250,
      "price": "75.00"
    },
    {
      "quantity": 500,
      "price": "150.00"
    },
    {
      "quantity": 1000,
      "price": "300.00"
    }
  ],
  "images": [
    {
      "uri": "http://cdn.example.com/images/checkOrders/products/S-WALHHSC.png",
      "height": 1024,
      "width": 833
    }
  ]
}

Checking Product (v1.3.1)

Representation of checking products. A product can be either a personal checking checkbook, a business checking checkbook, or a cover/binder (see type).

Links

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

Rel	Summary	Method
self	Fetch a representation of this checking product	GET
apiture:includedCover	Link to the checkbook cover product included with this product, if any	GET
apiture:includedCoverImage	URL of the image of the checkbook cover included with this product, if any	GET
apiture:correspondingSingleChecksProduct	The product resource of the corresponding product without duplicate checks	GET
apiture:correspondingDuplicateChecksProduct	The product resource of the corresponding product with duplicate checks	GET
apiture:defaultCheckbookCover	The product resource of default checkbook cover for this checkbook product, if any	GET
apiture:defaultCheckbookCoverImage	URL of the image of the default checkbook cover included with this product, if any	GET

Properties

Name	Description
Checking Product (v1.3.1)	object Representation of checking products. A product can be either a personal checking checkbook, a business checking checkbook, or a cover/binder (see type). Links Response and request bodies using this checkingProduct schema may contain the following links: Rel Summary Method self Fetch a representation of this checking product GET apiture:includedCover Link to the checkbook cover product included with this product, if any GET apiture:includedCoverImage URL of the image of the checkbook cover included with this product, if any GET apiture:correspondingSingleChecksProduct The product resource of the corresponding product without duplicate checks GET apiture:correspondingDuplicateChecksProduct The product resource of the corresponding product with duplicate checks GET apiture:defaultCheckbookCover The product resource of default checkbook cover for this checkbook product, if any GET apiture:defaultCheckbookCoverImage URL of the image of the default checkbook cover included with this product, if any GET
_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.
_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. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
_id	string The unique product code/identifier of this check order product.
code	string The unique product code/identifier of this check order product as defined by the check vendor. minLength: 2
type	checkingProductType The product type (checkbook or cover). enum values: checkbook, checkbookCover
accountTarget	checkingProductTarget The kind of banking account (personal or business) the product applies to. enum values: personal, business
name	string(markdown) The product name. format: markdown
label	string A short title or label for the product.
description	string(markdown) A more complete description of the product. format: markdown
currency	string The ISO 4217 currency code for the quantities offered for this product. read-only minLength: 3 maxLength: 3 default: "USD" pattern: "[A-Z]{3}"
checkbookOptions	checkingProductCheckbookOptions Options that apply only to checkbook products.
quantities	array: [checkingProductQuantity] Orderable quantities and the order price for each quantity. minItems: 1 items: object
images	array: [checkingProductImage] One or more images of the product. minLength: 1 maxLength: 8 items: object

checkingProductCheckbookOptions

{
  "includedCheckbookCoverProductId": "C-CMEXEB",
  "includesDuplicateChecks": false,
  "correspondingSingleProductId": "S-EXDDB"
}

Checking Product Checkbook Options (v1.0.1)

Options that apply only to checkbook products.

Properties

Name	Description
Checking Product Checkbook Options (v1.0.1)	object Options that apply only to checkbook products.
includesDuplicateChecks	boolean true indicates the product includes duplicate checks.
includedCheckbookCoverProductId	string If this product includes a checkbook cover, this is the _id of that product. If omitted, no checkbook cover is included with this product. See also the apiture:includedCover link. minLength: 2
checkbookCoverProductIds	array: [string] This is a list of product IDs (_id) of orderable checkbook covers that go with this checkbook. items: string » minLength: 2
correspondingSingleChecksProductId	string If this product includes check duplicates, this is either the _id of a product which does not include duplicates, or omitted if there is no such corresponding products. minLength: 2
correspondingDuplicateChecksProductId	string If this product does not include check duplicates, this is either the _id of a product which includes duplicates, or omitted if there is no such corresponding products. minLength: 2

checkingProductImage

{
  "uri": "http://cdn.example.com/images/checkOrders/products/S-WALHHSC.png",
  "height": 1024,
  "width": 833
}

Checking Product Image (v1.0.0)

Details of an image checking product. The height and width are optional but are provided if the containing images array 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.

Properties

Name	Description
Checking Product Image (v1.0.0)	object Details of an image checking product. The height and width are optional but are provided if the containing images array 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.
uri	string(uri) (required) The image URI which a client can fetch in order to render the checking product image in the client. format: uri maxLength: 2048
height	integer The image height, in pixels. minimum: 64 maximum: 4096
width	integer The image width, in pixels. minimum: 64 maximum: 4096

checkingProductQuantity

{
  "quantity": 200,
  "price": "20.00"
}

Check Order Product Quantity (v1.0.0)

A quantity that may be ordered for a checking product, and the associated cost for that quantity.

Properties

Name	Description
Check Order Product Quantity (v1.0.0)	object A quantity that may be ordered for a checking product, and the associated cost for that quantity.
quantity	integer The orderable quantity, such as number of checks. minimum: 1
price	string The price for this quantity. The numeric value is represented as a string so that it can be represented exactly with no loss of precision. The currency is defined in the checkingProduct.currency (normally USD). pattern: "^-?\\d{1,5}\\.\\d{2}$"

checkingProductTarget

"personal"

Check Order Product Target (v1.0.0)

The kind of the account this product is for.

checkingProductTarget strings may have one of the following enumerated values:

Value	Description
personal	Personal Checking
business	Business Checking

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

type: string

enum values: personal, business

checkingProductType

"checkbook"

Check Order Product Type (v1.0.0)

The type of the product.

checkingProductType strings may have one of the following enumerated values:

Value	Description
checkbook	Checkbook
checkbookCover	Checkbook Cover

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

type: string

enum values: checkbook, checkbookCover

checkingProducts

{
  "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkingProducts/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/checkOrders/products?start=10&limit=10"
    }
  },
  "name": "checkingProducts",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": [
      {
        "code": "S-EXDDB",
        "name": "Business Checks",
        "label": "Executive Deskbook - Blu Safety Checks - Single",
        "description": "Business Blue safety checks",
        "type": "checkbook",
        "accountTarget": "business",
        "checkbookOptions": {
          "includedCheckbookCoverProductId": "C-CMEXEB",
          "includesDuplicateChecks": false,
          "correspondingDuplicateProductId": "D-DXDDB"
        },
        "currency": "USD",
        "quantities": [
          {
            "quantity": 250,
            "price": "75.00"
          },
          {
            "quantity": 500,
            "price": "150.00"
          },
          {
            "quantity": 1000,
            "price": "300.00"
          }
        ],
        "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkingProduct/v1.3.1/profile.json",
        "_links": {
          "self": {
            "href": "https://production.api.apiture.com/checkOrders/products/D-DXDDB-a1b2"
          }
        }
      },
      {
        "code": "DXDDB",
        "name": "Business Checks",
        "label": "Executive Deskbook - Blu Safety Checks - Duplicate",
        "description": "Business Blue safety checks with duplicate checks",
        "type": "checkbook",
        "accountTarget": "business",
        "checkbookOptions": {
          "includedCheckbookCoverProductId": "C-CMEXEB",
          "includesDuplicateChecks": true,
          "correspondingSingleProductId": "S-EXDDB"
        },
        "currency": "USD",
        "quantities": [
          {
            "quantity": 250,
            "price": "100.00"
          },
          {
            "quantity": 500,
            "price": "15200.00"
          },
          {
            "quantity": 1000,
            "price": "400.00"
          }
        ],
        "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkingProduct/v1.3.1/profile.json",
        "_links": {
          "self": {
            "href": "https://production.api.apiture.com/checkOrders/products/D-DXDDB-a1b2"
          }
        }
      }
    ]
  }
}

Checking Product Collection (v1.3.1)

Collection of checking products. The items in the collection are ordered in the _embedded.items array; the name is checkingProducts.

Properties

Name	Description
Checking Product Collection (v1.3.1)	object Collection of checking products. The items in the collection are ordered in the _embedded.items array; the name is checkingProducts.
_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.
_embedded	embeddedCheckingProducts Embedded objects: an array of checkingProducts
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
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.

collection

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Collection (v2.1.1)

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

Name	Description
Collection (v2.1.1)	object 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.
_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.
_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. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
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.

configurationGroup

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API",
  "schema": {
    "type": "object",
    "properties": {
      "dailyLimit": {
        "type": "number",
        "description": "The daily limit for the number of transfers"
      },
      "cutoffTime": {
        "type": "string",
        "format": "time",
        "description": "The cutoff time for scheduling transfers for the current day"
      }
    }
  },
  "values": {
    "dailyLimit": 5,
    "cutoffTime": 63000
  }
}

Configuration Group (v2.1.1)

Represents a configuration group.

This schema was resolved from configurations/configurationGroup.

Properties

Name	Description
Configuration Group (v2.1.1)	object Represents a configuration group. This schema was resolved from configurations/configurationGroup.
_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.
_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. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string The name of this configuration group, must be unique within the set of all resources of this type. minLength: 1 maxLength: 48 pattern: "[a-zA-Z][-\\w_]*"
label	string The text label for this resource, suitable for presentation to the client. minLength: 1 maxLength: 128
description	string The full description for this resource, suitable for presentation to the client. minLength: 1 maxLength: 4096
schema	configurationSchema The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern letter [letter | digit | - | _]*. This is implicitly a schema for type: object and contains the properties. The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0. This schema was resolved from configurations/configurationSchema.
values	configurationValues The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's schema. Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values. For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema. This schema was resolved from configurations/configurationValues.

configurationGroupSummary

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroupSummary/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API"
}

Configuration Group Summary (v2.1.1)

A summary of the data contained within a configuration group resource.

This schema was resolved from configurations/configurationGroupSummary.

Properties

Name	Description
Configuration Group Summary (v2.1.1)	object A summary of the data contained within a configuration group resource. This schema was resolved from configurations/configurationGroupSummary.
_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.
_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. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string The name of this configuration group, must be unique within the set of all resources of this type. minLength: 1 maxLength: 48 pattern: "[a-zA-Z][-\\w_]*"
label	string The text label for this resource, suitable for presentation to the client. minLength: 1 maxLength: 128
description	string The full description for this resource, suitable for presentation to the client. minLength: 1 maxLength: 4096

configurationGroups

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroups/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/configurations/groups?start=10&limit=10"
    },
    "first": {
      "href": "/configurations/configurations/groups?start=0&limit=10"
    },
    "next": {
      "href": "/configurations/configurations/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/configurations/configurations/groups"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_embedded": {
    "items": [
      {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/basic"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/calendar"
          }
        },
        "name": "calendar",
        "label": "Calendar",
        "description": "A calendar that specifies which dates are valid for performing transfers (e.g., weekdays excluding federal holidays)"
      }
    ]
  }
}

Configuration Group Collection (v2.1.1)

Collection of configuration groups. 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).

This schema was resolved from configurations/configurationGroups.

Properties

Name	Description
Configuration Group Collection (v2.1.1)	object Collection of configuration groups. 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). This schema was resolved from configurations/configurationGroups.
_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.
_embedded	configurationGroupsEmbedded Embedded objects.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
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.

configurationGroupsEmbedded

{
  "items": [
    {
      "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroupSummary/v2.1.1/profile.json",
      "_links": {
        "self": {
          "href": "/configurations/groups/basic"
        }
      },
      "name": "basic",
      "label": "Basic Settings",
      "description": "The basic settings for the Transfers API"
    }
  ]
}

Configuration Groups Embedded Objects (v1.1.1)

Objects embedded in the configurationGroupscollection.

This schema was resolved from configurations/configurationGroupsEmbedded.

Properties

Name	Description
Configuration Groups Embedded Objects (v1.1.1)	object Objects embedded in the configurationGroupscollection. This schema was resolved from configurations/configurationGroupsEmbedded.
items	array: [configurationGroupSummary] An array containing a page of configuration group items. items: object

configurationSchema

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Configuration Schema (v2.1.0)

The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern letter [letter | digit | - | _]*.

This is implicitly a schema for type: object and contains the properties.

The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0.

This schema was resolved from configurations/configurationSchema.

Properties

Name	Description
Configuration Schema (v2.1.0)	object The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern letter [letter | digit | - | _]*. This is implicitly a schema for type: object and contains the properties. The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0. This schema was resolved from configurations/configurationSchema.
Configuration Schema Value (v2.0.0)	configurationSchemaValue The data associated with this configuration schema. This schema was resolved from configurations/configurationSchemaValue.

configurationSchemaValue

{}

Configuration Schema Value (v2.0.0)

The data associated with this configuration schema.

This schema was resolved from configurations/configurationSchemaValue.

Properties

Name	Description
Configuration Schema Value (v2.0.0)	object The data associated with this configuration schema. This schema was resolved from configurations/configurationSchemaValue.

configurationValue

{}

Configuration Value (v2.0.0)

The data associated with this configuration.

This schema was resolved from configurations/configurationValue.

Properties

Name	Description
Configuration Value (v2.0.0)	object The data associated with this configuration. This schema was resolved from configurations/configurationValue.

configurationValues

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Configuration Values (v2.0.0)

The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's schema.

Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values.

For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema.

This schema was resolved from configurations/configurationValues.

Properties

Name	Description
Configuration Values (v2.0.0)	object The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's schema. Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values. For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema. This schema was resolved from configurations/configurationValues.
Configuration Value (v2.0.0)	configurationValue The data associated with this configuration. This schema was resolved from configurations/configurationValue.

createCheckOrder

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {
    "apiture:account": {
      "href": "https://production.api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    }
  },
  "name": "Lucille Welphunded",
  "line1": "\"I have a dream\"",
  "checkAddress": {
    "addressLine1": "555 N Front Street",
    "addressLine2": "Suite 5555",
    "city": "Wilmington",
    "regionCode": "NC",
    "postalCode": "28401-5405",
    "countryCode": "US"
  },
  "shippingAddressId": "ha1",
  "shippingAddressSource": "user"
}

Create Check Order (v1.2.1)

Properties of a request to create a new check order.

Links

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

Rel	Summary	Method
apiture:account	An existing, active checking account the customer owns or manages.	GET

Properties

Name	Description
Create Check Order (v1.2.1)	object Properties of a request to create a new check order. Links Response and request bodies using this createCheckOrder schema may contain the following links: Rel Summary Method apiture:account An existing, active checking account the customer owns or manages. GET
_links	links (required) 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.
_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. read-only format: uri
name	string (required) The name to display on the top of the checks. maxLength: 45
line1	string An additional line of text, printed on the check below the name. maxLength: 45
line2	string An additional line of text, printed on the check below the line2. maxLength: 45
checkAddress	address (required) The address printed on the top of the check.
checkbookCode	string The product code for the corresponding checkbook product maxLength: 20
checkbookCoverCode	string The product code for the corresponding cover product maxLength: 20
checkbookQuantity	number The quantity amount for the corresponding checkbook product maximum: 6
shippingAddressId	string (required) The _id of the postal address where the order is shipped. For a personal checking account, the _id is the address ID from the customer's addresses. For a business checking account, the _id is the address ID from the owning organization's addresses. minLength: 1 maxLength: 8 pattern: "^[-a-zA-Z0-9_]{1,8}$"
shippingAddressSource	shippingAddressSource Used with shippingAddressId to identify which resource the shipping address is associated with. For business checks, the default is organization and for personal checking, the default is user. enum values: organization, user

embeddedCheckOrders

{
  "items": [
    {
      "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
      "state": "submitted",
      "name": "Lucille Welphunded",
      "shippingAddressId": "ha1",
      "shippingAddressSource": "organization",
      "line1": "\"I have a dream\"",
      "startingCheckNumber": 2401,
      "shippingAddress": {
        "_id": "ha1",
        "type": "home",
        "addressLine1": "555 N Front Street",
        "addressLine2": "Suite 5555",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28401-5405",
        "countryCode": "US"
      },
      "checkAddress": {
        "_id": "ha1",
        "type": "home",
        "addressLine1": "555 N Front Street",
        "addressLine2": "Suite 5555",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28401-5405",
        "countryCode": "US"
      },
      "cost": {
        "total": "22.00",
        "currency": "USD"
      },
      "createdAt": "2020-08-03T13:01:47.375Z",
      "submittedAt": "2020-08-03T13:09:54.375Z",
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkOrder/v1.6.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
        }
      }
    }
  ]
}

Embedded Check Orders (v1.6.1)

Items embedded in the checkOrders collection.

Properties

Name	Description
Embedded Check Orders (v1.6.1)	object Items embedded in the checkOrders collection.
items	array: [checkOrder] An array containing check orders. items: object

embeddedCheckingProducts

{
  "items": [
    {
      "_profile": "https://production.api.apiture.com/schemas/checkOrders/checkingProduct/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/checkOrders/products/D-DXDDB-a1b2"
        },
        "apiture:includedCover": {
          "href": "https://production.api.apiture.com/checkOrders/products/C-CMEXEB-a1b2"
        },
        "apiture:includedCoverImage": {
          "href": "https://cdn.apiture.com/images/checkOrders/products/C-CMEXEB.png"
        },
        "apiture:correspondingSingleChecksProduct": {
          "href": "https://production.api.apiture.com/checkOrders/products/S-EXDDB-a1b2"
        }
      },
      "code": "D-DXDDB",
      "name": "Business Checks",
      "label": "Executive Deskbook - Check Binder Safety Checks - Duplicate",
      "description": "Business Blue safety checks with duplicates",
      "type": "checkbook",
      "accountTarget": "business",
      "checkbookOptions": {
        "includedCheckbookCoverProductId": "C-CMEXEB",
        "includesDuplicateChecks": false,
        "correspondingSingleProductId": "S-EXDDB"
      },
      "currency": "USD",
      "quantities": [
        {
          "quantity": 250,
          "price": "75.00"
        },
        {
          "quantity": 500,
          "price": "150.00"
        },
        {
          "quantity": 1000,
          "price": "300.00"
        }
      ],
      "images": [
        {
          "uri": "http://cdn.example.com/images/checkOrders/products/S-WALHHSC.png",
          "height": 1024,
          "width": 833
        }
      ]
    }
  ]
}

Embedded Checking Products (v1.0.2)

Items embedded in the checkingProducts collection.

Properties

Name	Description
Embedded Checking Products (v1.0.2)	object Items embedded in the checkingProducts collection.
items	array: [checkingProduct] An array containing checking products. items: object

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.1.0)

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

This schema was resolved from common/error.

Properties

Name	Description
Error (v2.1.0)	object Describes an error in an API request or in a service called via the API. This schema was resolved from common/error.
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. format: date-time
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. Additional Properties: true
remediation	string An optional localized string which provides hints for how the user or client can resolve the error.
errors	array: [error] An optional array of nested error objects. This property is not always present. items: object

errorResponse

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response (v2.1.1)

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

Name	Description
Error Response (v2.1.1)	object 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.
_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.
_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. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only

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.3)

A map that defines labels for the items in a group. This is a map from each item name → a 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 derived 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.

Properties

Name	Description
Label Group (v1.0.3)	object A map that defines labels for the items in a group. This is a map from each item name → a 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 derived 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.
Label Item (v1.0.2)	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 systems, 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://production.api.apiture.com/schemas/common/labelGroups/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "groups": {
    "firstGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "key1": {
        "label": "Label for Key 1",
        "code": "1",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 1)"
          },
          "fr": {
            "label": "(French label for Key 1)"
          }
        }
      },
      "key2": {
        "label": "Label for Key 2",
        "code": "2",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 2)"
          },
          "fr": {
            "label": "(French label for Key 2)"
          }
        }
      },
      "key3": {
        "label": "Label for Key 3",
        "code": "3",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 3)"
          },
          "fr": {
            "label": "(French label for Key 3)"
          }
        }
      },
      "other": {
        "label": "Other",
        "variants": {
          "es": {
            "label": "(Spanish label for Other)"
          },
          "fr": {
            "label": "(French label for Other)"
          }
        },
        "code": "254"
      }
    },
    "secondGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "?",
        "hidden": true
      },
      "optionA": {
        "label": "Option A",
        "code": "A"
      },
      "optionB": {
        "label": "Option B",
        "code": "B"
      },
      "optionC": {
        "label": "Option C",
        "code": "C"
      },
      "other": {
        "label": "Other",
        "code": "_"
      }
    }
  }
}

Label Groups (v1.1.3)

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

Name	Description
Label Groups (v1.1.3)	object 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.
_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.
_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. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
groups	object Groups of localized labels. This maps group names → a group of labels within that group.
» Label Group (v1.0.3)	labelGroup A map that defines labels for the items in a group. This is a map from each item name → a 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 derived 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

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

Label Item (v1.0.2)

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 systems, 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

Name	Description
Label Item (v1.0.2)	object 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 systems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI. This schema was resolved from common/labelItem.
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.
» Simple Label (v1.0.0)	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]+)?)?[\\]\\)]$"

link

{
  "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Application"
}

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

Name	Description
Link (v1.0.0)	object 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.
href	string(uri) (required) The URI or URI template for the resource/operation this link refers to. format: uri
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. format: uri
profile	string(uri) The URI of a profile document, a JSON document which describes the target resource/operation. format: uri

links

{
  "property1": {
    "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Application"
  },
  "property2": {
    "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Application"
  }
}

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

Name	Description
Links (v1.0.0)	object 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.
Link (v1.0.0)	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.

root

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

API Root (v2.1.1)

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

This schema was resolved from common/root.

Properties

Name	Description
API Root (v2.1.1)	object A HAL response, with hypermedia _links for the top-level resources and operations in API. This schema was resolved from common/root.
_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.
_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. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
_id	string This API's unique ID. read-only
name	string This API's name.
apiVersion	string This API's version.

shippingAddressSource

"organization"

Shipping address source (v1.0.0)

Names the account resource from which the shipping address is taken.

shippingAddressSource strings may have one of the following enumerated values:

Value	Description
organization	Organization Address: The shipping address is from the organization's addresses
user	User Address: The shipping address is from the users's addresses

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

type: string

enum values: organization, user

simpleAddress

{
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US"
}

Simple Address (v1.0.0)

A postal address.

This schema was resolved from contacts/simpleAddress.

Properties

Name	Description
Simple Address (v1.0.0)	object A postal address. This schema was resolved from contacts/simpleAddress.
addressLine1	string The first street address line of the address, normally a house number and street name. minLength: 4 maxLength: 128
addressLine2	string The optional second street address line of the address. maxLength: 128
city	string The name of the city or municipality. minLength: 2 maxLength: 128
regionCode	string The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: "^[a-zA-Z]{2}$"
postalCode	string The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5 maxLength: 10 pattern: "^[0-9]{5}(?:-[0-9]{4})?$"
countryCode	string The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2 maxLength: 2 pattern: "^[a-zA-Z]{2}$"

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

Name	Description
Simple Label (v1.0.0)	object A text label and optional description. This schema was resolved from common/simpleLabel.
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.

---