Check Orders v0.3.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/checkingProducts?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
• delete 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 user'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.

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.

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.

ineligibleAccount

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

ineligibleCheckingProduct

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

invalidPreviousCheckOrder

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

invalidCheckAddressId

Description: There is no such address resource for this checkAddressId.
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.

invalidShippingAddressId

Description: There is no such address resource for this checkAddressId.
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.

noSuchOrder

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

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.

noSuchAlternateProduct

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

orderIsImmutable

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

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.

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.

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.

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.

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.

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.

Download OpenAPI Definition (YAML)

Base URLs:

• /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 /checkOrders/products \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /checkOrders/products HTTP/1.1

Accept: application/hal+json

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/checkOrders/products', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/checkOrders/products", data)
    req.Header = headers

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

Return a collection of checking products

GET /products

Return a collection of checking products.

Parameters

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

Try It

Example responses

200 Response

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

Responses

getProduct

Code samples

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

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/checkOrders/products/{productId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/checkOrders/products/{productId}", data)
    req.Header = headers

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

Fetch a representation of this checking product

GET /products/{productId}

Return a HAL representation of this checking product resource.

Parameters

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

Try It

Example responses

200 Response

{
  "code": "DXDDB",
  "name": "Business Checks",
  "label": "Executive Dskbk - Blu Safety Checks - Duplicate",
  "description": "Business Blue safety checks with duplicates",
  "type": "checkbook",
  "target": "business",
  "checkbookOptions": {
    "includedCheckbookCoverProductId": "CMEXEB",
    "includesDuplicateChecks": false,
    "correspondingSingleProductId": "EXDDB"
  },
  "currency": "USD",
  "quantities": [
    {
      "quantity": 250,
      "price": "75.00"
    },
    {
      "quantity": 500,
      "price": "150.00"
    },
    {
      "quantity": 1000,
      "price": "300.00"
    }
  ],
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkingProduct/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.apiture.com/checkOrders/checkingProducts/DXDDB"
    },
    "apiture:image": {
      "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/DXDDB.png"
    },
    "apiture:includedCover": {
      "href": "https://api.apiture.com/checkOrders/checkingProducts/CVRCMEXEB"
    },
    "apiture:includedCoverImage": {
      "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRCMEXEB.png"
    },
    "apiture:correspondingSingleChecksProduct": {
      "href": "https://api.apiture.com/checkOrders/checkingProducts/EXDDB"
    }
  }
}

Responses

Check Orders

Check Orders

chooseAlternateCheckbook

Code samples

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

POST /checkOrders/orders/{orderId}/checkbook/alternateCheckbook HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/checkOrders/orders/{orderId}/checkbook/alternateCheckbook',
  method: 'post',

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

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

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

};

fetch('/checkOrders/orders/{orderId}/checkbook/alternateCheckbook',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

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

result = RestClient.post '/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('/checkOrders/orders/{orderId}/checkbook/alternateCheckbook', params={

}, headers = headers)

print r.json()

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

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

Choose an alternate checkbook

POST /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 poduct, 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 (path)	string (required) The unique identifier (_id) of a previous check order to copy.

Try It

Example responses

200 Response

{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}

Responses

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update the resource to perform conditional updates.

getOrders

Code samples

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

GET /checkOrders/orders HTTP/1.1

Accept: application/hal+json

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

};

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

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

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

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

};

fetch('/checkOrders/orders',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/checkOrders/orders', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/checkOrders/orders", data)
    req.Header = headers

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

Return a collection of check orders

GET /orders

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

Parameters

Parameter	Description
account (query)	string Filter orders by account identified by this ID. The value is _id of an Account resource (not an account number). The user must be the account owner (for personal accounts) or an authorized signer (for business accounts).
state (query)	array[string] Subset the result to those orders whose state matches one of the passed values. For example, ?state=pending or ?state=canceled|submited.
start (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.
limit (query)	integer(int32) The maximum number of check order representations to return in this page. Default: 100
sortBy (query)	string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
filter (query)	string Optional filter criteria. See filtering.

Try It

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrders/v1.0.0/profile.json",
  "name": "checkOrders",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_links": {
    "self": {
      "href": "https://api.apiture.com/checkOrders/checkOrders?start=10&limit=10"
    },
    "first": {
      "href": "https://api.apiture.com/checkOrders/checkOrders?start=0&limit=10"
    },
    "next": {
      "href": "https://api.apiture.com/checkOrders/checkOrders?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.apiture.com/checkOrders/checkOrders"
    }
  },
  "_embedded": {
    "items": {
      "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
      "state": "submitted",
      "name": "Lucille Welphunded",
      "checkbookCostWaived": false,
      "checkAddressId": "ha1",
      "shippingAddressId": "ha1",
      "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": {
        "price": "22.00",
        "currency": "USD"
      },
      "createdAt": "2020-08-03T13:01:47.375Z",
      "submittedAt": "2020-08-03T13:09:54.375Z",
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
        }
      }
    }
  }
}

Responses

createOrder

Code samples

# You can also use wget
curl -X POST /checkOrders/orders \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /checkOrders/orders HTTP/1.1

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

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

};

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "name": "Lucille Welphunded",
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "line1": "\"I have a dream\"",
  "_links": {
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post '/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('/checkOrders/orders', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/checkOrders/orders", data)
    req.Header = headers

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

Create a new check order

POST /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

{
  "name": "Lucille Welphunded",
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "line1": "\"I have a dream\"",
  "_links": {
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    }
  }
}

Parameters

Parameter	Description
copyOf (query)	string Make a new order that is a copy of a previously 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 (body)	createCheckOrder (required)

Try It

Example responses

201 Response

{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}

Responses

Response Headers

Status	Description
201	Location string uri
	The URI of the new check order. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with scheme://host
201	ETag string
	An entity tag which may be passed in the If-Match request header for PUT or PATCH operations which update the resource.

getOrder

Code samples

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

GET /checkOrders/orders/{orderId} HTTP/1.1

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

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

};

$.ajax({
  url: '/checkOrders/orders/{orderId}',
  method: 'get',

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

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

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

};

fetch('/checkOrders/orders/{orderId}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/checkOrders/orders/{orderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/checkOrders/orders/{orderId}", data)
    req.Header = headers

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

Fetch a representation of this check order

GET /orders/{orderId}

Return a HAL representation of this check order resource.

Parameters

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

Try It

Example responses

200 Response

{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}

Responses

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this check order resource.

updateOrder

Code samples

# You can also use wget
curl -X PUT /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 /checkOrders/orders/{orderId} HTTP/1.1

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

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

};

$.ajax({
  url: '/checkOrders/orders/{orderId}',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

require 'rest-client'
require 'json'

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

result = RestClient.put '/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('/checkOrders/orders/{orderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/checkOrders/orders/{orderId}", data)
    req.Header = headers

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

Update this check order

PUT /orders/{orderId}

Replace the properties of this check order. Updatable properties include the name, line1, line2, shippingAddressId, and checkAddressId. The _id must match the {orderId}. This operation does not change the checkbook and checkbook cover; use the setCheckbook'](#op-setCheckbook) [setCheckbookCover` operations.

Body parameter

{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}

Parameters

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

Try It

Example responses

200 Response

{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}

Responses

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this check order resource.

patchOrder

Code samples

# You can also use wget
curl -X PATCH /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 /checkOrders/orders/{orderId} HTTP/1.1

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

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

};

$.ajax({
  url: '/checkOrders/orders/{orderId}',
  method: 'patch',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

require 'rest-client'
require 'json'

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

result = RestClient.patch '/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('/checkOrders/orders/{orderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/checkOrders/orders/{orderId}", data)
    req.Header = headers

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

Update this check order

PATCH /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, and checkAddressId. The _id must match the {orderId}. This operation does not change the checkbook and checkbook cover; use the setCheckbook'](#op-setCheckbook) [setCheckbookCover` operations.

Body parameter

{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}

Parameters

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

Try It

Example responses

200 Response

{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}

Responses

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this check order resource.

deleteOrder

Code samples

# You can also use wget
curl -X DELETE /checkOrders/orders/{orderId} \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE /checkOrders/orders/{orderId} HTTP/1.1

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

};

$.ajax({
  url: '/checkOrders/orders/{orderId}',
  method: 'delete',

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

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

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

};

fetch('/checkOrders/orders/{orderId}',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete '/checkOrders/orders/{orderId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete('/checkOrders/orders/{orderId}', params={

}, headers = headers)

print r.json()

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

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

Delete a check order

DELETE /orders/{orderId}

Delete this check order resource. A deleted order cannot be reordered. Consider canceling an order to leave it's selections for future reordering.

Parameters

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

Try It

Responses

Check Order Actions

Actions on Check Orders

cancelOrder

Code samples

# You can also use wget
curl -X POST /checkOrders/canceledOrders?order=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /checkOrders/canceledOrders?order=string HTTP/1.1

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

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

};

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

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

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

};

fetch('/checkOrders/canceledOrders?order=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

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

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

print r.json()

URL obj = new URL("/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", "/checkOrders/canceledOrders", data)
    req.Header = headers

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

Cancel a check order

POST /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 (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 (header)	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}

Responses

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update the resource to perform conditional updates.

submitOrder

Code samples

# You can also use wget
curl -X POST /checkOrders/submittedOrders?order=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /checkOrders/submittedOrders?order=string HTTP/1.1

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

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

};

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

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

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

};

fetch('/checkOrders/submittedOrders?order=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

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

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

print r.json()

URL obj = new URL("/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", "/checkOrders/submittedOrders", data)
    req.Header = headers

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

Submit a check order

POST /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 at least one item, and the accoun 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 (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 (header)	string The entity tag that was returned in the ETag response. If passed, this must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}

Responses

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update the resource to perform conditional updates.

Check Order Items

Check Order Items

getCheckbook

Code samples

# You can also use wget
curl -X GET /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 /checkOrders/orders/{orderId}/checkbook HTTP/1.1

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

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

};

$.ajax({
  url: '/checkOrders/orders/{orderId}/checkbook',
  method: 'get',

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

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

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

};

fetch('/checkOrders/orders/{orderId}/checkbook',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/checkOrders/orders/{orderId}/checkbook', params={

}, headers = headers)

print r.json()

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

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

Fetch the order's checkbook

GET /orders/{orderId}/checkbook

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

Parameters

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

Try It

Example responses

200 Response

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

Responses

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this check order item resource.

setCheckbook

Code samples

# You can also use wget
curl -X PUT /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 /checkOrders/orders/{orderId}/checkbook HTTP/1.1

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

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

};

$.ajax({
  url: '/checkOrders/orders/{orderId}/checkbook',
  method: 'put',

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

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

require 'rest-client'
require 'json'

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

result = RestClient.put '/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('/checkOrders/orders/{orderId}/checkbook', params={

}, headers = headers)

print r.json()

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

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

Set the order's checkbook

PUT /orders/{orderId}/checkbook

Create or update the checkbook 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 /checkingProducts?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

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

Parameters

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

Try It

Example responses

200 Response

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

Responses

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this check order item resource.

deleteCheckbook

Code samples

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

DELETE /checkOrders/orders/{orderId}/checkbook HTTP/1.1

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

};

$.ajax({
  url: '/checkOrders/orders/{orderId}/checkbook',
  method: 'delete',

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

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

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

};

fetch('/checkOrders/orders/{orderId}/checkbook',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete '/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('/checkOrders/orders/{orderId}/checkbook', params={

}, headers = headers)

print r.json()

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

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

Delete an order's checkbook

DELETE /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 (path)	string (required) The unique identifier of this check order. This is an opaque string.

Try It

Responses

getCheckbookCover

Code samples

# You can also use wget
curl -X GET /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 /checkOrders/orders/{orderId}/checkbookCover HTTP/1.1

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

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

};

$.ajax({
  url: '/checkOrders/orders/{orderId}/checkbookCover',
  method: 'get',

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

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

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

};

fetch('/checkOrders/orders/{orderId}/checkbookCover',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/checkOrders/orders/{orderId}/checkbookCover', params={

}, headers = headers)

print r.json()

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

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

Fetch the order's checkbook cover

GET /orders/{orderId}/checkbookCover

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

Parameters

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

Try It

Example responses

200 Response

{
  "productCode": "CVRBB",
  "label": "Executive Deskbook Check Binder",
  "price": "33.00",
  "quantity": 1,
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
  "self": {
    "apiture:product": {
      "href": "https://api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  },
  "_links": {
    "apiture:product": {
      "href": "https://api.apiture.com/checkOrders/products/CVRBB"
    },
    "apiture:image": {
      "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRBB.png"
    }
  }
}

Responses

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this check order item resource.

setCheckbookCover

Code samples

# You can also use wget
curl -X PUT /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 /checkOrders/orders/{orderId}/checkbookCover HTTP/1.1

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

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

};

$.ajax({
  url: '/checkOrders/orders/{orderId}/checkbookCover',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "productCode": "CVRBB",
  "label": "Executive Deskbook Check Binder",
  "price": "33.00",
  "quantity": 1,
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
  "self": {
    "apiture:product": {
      "href": "https://api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  },
  "_links": {
    "apiture:product": {
      "href": "https://api.apiture.com/checkOrders/products/CVRBB"
    },
    "apiture:image": {
      "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRBB.png"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/checkOrders/orders/{orderId}/checkbookCover',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

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

result = RestClient.put '/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('/checkOrders/orders/{orderId}/checkbookCover', params={

}, headers = headers)

print r.json()

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

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

Set the order's checkbook cover

PUT /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 /checkingProducts?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

{
  "productCode": "CVRBB",
  "label": "Executive Deskbook Check Binder",
  "price": "33.00",
  "quantity": 1,
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
  "self": {
    "apiture:product": {
      "href": "https://api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  },
  "_links": {
    "apiture:product": {
      "href": "https://api.apiture.com/checkOrders/products/CVRBB"
    },
    "apiture:image": {
      "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRBB.png"
    }
  }
}

Parameters

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

Try It

Example responses

200 Response

{
  "productCode": "CVRBB",
  "label": "Executive Deskbook Check Binder",
  "price": "33.00",
  "quantity": 1,
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
  "self": {
    "apiture:product": {
      "href": "https://api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  },
  "_links": {
    "apiture:product": {
      "href": "https://api.apiture.com/checkOrders/products/CVRBB"
    },
    "apiture:image": {
      "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRBB.png"
    }
  }
}

Responses

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this check order item resource.

setDefaultCheckbookCover

Code samples

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

POST /checkOrders/orders/{orderId}/defaultCheckbookCover HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/checkOrders/orders/{orderId}/defaultCheckbookCover',
  method: 'post',

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

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

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

};

fetch('/checkOrders/orders/{orderId}/defaultCheckbookCover',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

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

result = RestClient.post '/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('/checkOrders/orders/{orderId}/defaultCheckbookCover', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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 /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 (path)	string (required) The unique identifier of this check order. This is an opaque string.

Try It

Example responses

200 Response

{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}

Responses

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this check order item resource.

deleteCheckbookCover

Code samples

# You can also use wget
curl -X DELETE /checkOrders/orders/{orderId}/defaultCheckbookCover \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE /checkOrders/orders/{orderId}/defaultCheckbookCover HTTP/1.1

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

};

$.ajax({
  url: '/checkOrders/orders/{orderId}/defaultCheckbookCover',
  method: 'delete',

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

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

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

};

fetch('/checkOrders/orders/{orderId}/defaultCheckbookCover',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete '/checkOrders/orders/{orderId}/defaultCheckbookCover',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete('/checkOrders/orders/{orderId}/defaultCheckbookCover', params={

}, headers = headers)

print r.json()

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

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

Delete an order's checkbook cover

DELETE /orders/{orderId}/defaultCheckbookCover

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 (path)	string (required) The unique identifier of this check order. This is an opaque string.

Try It

Responses

API

The Check Orders API.

getApi

Code samples

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

GET /checkOrders/ HTTP/1.1

Accept: application/hal+json

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/checkOrders/", data)
    req.Header = headers

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

Top-level resources and operations in this API

GET /

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

Try It

Example responses

200 Response

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

Responses

getApiDoc

Code samples

# You can also use wget
curl -X GET /checkOrders/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET /checkOrders/apiDoc HTTP/1.1

Accept: application/json

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

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

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Try It

Example responses

200 Response

{}

Responses

Response Schema

Schemas

abstractRequest

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

Abstract Request (v2.0.0)

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

This schema was resolved from common/abstractRequest.

Properties

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

abstractResource

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

Abstract Resource (v2.0.0)

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

This schema was resolved from common/abstractResource.

Properties

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

address

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

Address (v1.0.0)

A postal address.

This schema was resolved from contacts/address.

Properties

Name	Description
type	addressType (required) The type of this address.
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
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}$
_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
Enumerated values:
unknown
home
prior
work
school
mailing
vacation
shipping
billing
headquarters
commercial
site
property
other
notApplicable

attributeValue

{}

Attribute Value (v2.0.0)

The data associated with this attribute.

This schema was resolved from common/attributeValue.

Properties

attributes

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

Attributes (v2.0.0)

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

This schema was resolved from common/attributes.

Properties

Name	Description
additionalProperties	attributeValue The data associated with this attribute. This schema was resolved from common/attributeValue.

checkOrder

{
  "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
  "state": "submitted",
  "name": "Lucille Welphunded",
  "checkbookCostWaived": false,
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "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": {
    "price": "22.00",
    "currency": "USD"
  },
  "createdAt": "2020-08-03T13:01:47.375Z",
  "submittedAt": "2020-08-03T13:09:54.375Z",
  "_embedded": {
    "checkbook": {
      "productCode": "WALHHSC",
      "label": "Personal Checkbook",
      "price": "20.00",
      "quantity": 200,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbook/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/WALHHSC"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/WALHHSC.png"
        }
      }
    },
    "checkbookCover": {
      "productCode": "CVRRB",
      "label": "Personal Checkbook Cover",
      "price": "2.00",
      "quantity": 1,
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
        },
        "apiture:product": {
          "href": "http://api.apiture.com/checkOrders/products/CVRRB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRRB.png"
        }
      }
    }
  },
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    },
    "apiture:cancel": {
      "href": "http://api.apiture.com/checkOrders/canceledOrders?order=a7bebcae-bef1-434d-a089-42389f3b6027"
    },
    "apiture:copyCheckOrder": {
      "href": "http://api.apiture.com/checkOrders/checkOrders?copyOf=a7bebcae-bef1-434d-a089-42389f3b6027",
      "method": "POST"
    },
    "apiture:setDefaultCheckbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/defaultCheckbookCover",
      "method": "POST"
    },
    "apiture:checkbook": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbook"
    },
    "apiture:checkbookCover": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/checkbookCover"
    },
    "apiture:convertToDuplicateChecks": {
      "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027/alternateCheckbook"
    }
  }
}

Check Order (v1.0.0)

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
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
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
checkAddressId	any The _id of the postal address that is printed on the checks. For a pesonal checking account, the _id is the address ID from the user's addresses. For a business checking account, the _id is the address ID from the owning organization's addresses.
shippingAddressId	string The _id of the postal address where the order is shipped. For a pesonal checking account, the _id is the address ID from the user'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}$
state	checkOrderState The state of this check order. This is updated by using the submitOrder or cancelOrder operations. read-only
checkAddress	address The address printed on the top of the check. This is the address derived from the checkAddressId. read-only
shippingAddress	address The address where the check order is shipped. This is the address derived from the 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
checkbookCostWaived	boolean If true, the financial institution waives the cost of this first checkbook ordered for a new checking account. read-only
cost	checkOrderCost The sum of the prices of the checkbook and checkbook cover in this order, minus any discounts or credits. read-only
availableBalanace	string(decimal) The string representation of the account's decimal available balance. This must be large enough to cover the cost in order in order for the submitOrder operation to be valid. read-only
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
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
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
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

checkOrderCheckbook

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

Check Order Checkbook (v1.0.0)

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:image	URL of the image of the checkbook included in this order	GET
apiture:setDefaultCheckbookCover	Add the default checkbook cover to the order	POST

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
quantity	integer The quantity for this line item. This is one of the values in the product's quantities array.
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

checkOrderCheckbookCover

{
  "productCode": "CVRBB",
  "label": "Executive Deskbook Check Binder",
  "price": "33.00",
  "quantity": 1,
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrderCheckbookCover/v1.0.0/profile.json",
  "self": {
    "apiture:product": {
      "href": "https://api.apiture.com/checkOrders/orders/c81094de-4e68-4077-ba94-eb492093f8f2/checkbookCover"
    }
  },
  "_links": {
    "apiture:product": {
      "href": "https://api.apiture.com/checkOrders/products/CVRBB"
    },
    "apiture:image": {
      "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRBB.png"
    }
  }
}

Check Order Checkbook Cover (v1.0.0)

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
apiture:image	URL of the image of the checkbook included in this order	GET

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
quantity	integer The quantity for this line item. This is one of the values in the product's quantities array.
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",
  "price": "22.00"
}

Check Order Cost (v1.0.0)

The computed total cost of the check order.

Properties

Name	Description
currency	string The ISO 4217 currency code for this balance. Default: "USD" read-only minLength: 3 maxLength: 3 pattern: [A-Z]{3}
price	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 pattern: ^-?\d{1,5}\.\d{2}$

checkOrderState

"pending"

Check Order State (v1.0.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 send to the vendor. Users can not cancel processed orders.
canceled	Canceled: A check order that has been canceled after being submitted. The service retains canceled orders for possible re-order.

Type: string
Enumerated values:
pending
submitted
processed
canceled

checkOrders

{
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrders/v1.0.0/profile.json",
  "name": "checkOrders",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_links": {
    "self": {
      "href": "https://api.apiture.com/checkOrders/checkOrders?start=10&limit=10"
    },
    "first": {
      "href": "https://api.apiture.com/checkOrders/checkOrders?start=0&limit=10"
    },
    "next": {
      "href": "https://api.apiture.com/checkOrders/checkOrders?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.apiture.com/checkOrders/checkOrders"
    }
  },
  "_embedded": {
    "items": {
      "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
      "state": "submitted",
      "name": "Lucille Welphunded",
      "checkbookCostWaived": false,
      "checkAddressId": "ha1",
      "shippingAddressId": "ha1",
      "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": {
        "price": "22.00",
        "currency": "USD"
      },
      "createdAt": "2020-08-03T13:01:47.375Z",
      "submittedAt": "2020-08-03T13:09:54.375Z",
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
        }
      }
    }
  }
}

Check Order Collection (v1.0.0)

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

checkingProduct

{
  "code": "DXDDB",
  "name": "Business Checks",
  "label": "Executive Dskbk - Blu Safety Checks - Duplicate",
  "description": "Business Blue safety checks with duplicates",
  "type": "checkbook",
  "target": "business",
  "checkbookOptions": {
    "includedCheckbookCoverProductId": "CMEXEB",
    "includesDuplicateChecks": false,
    "correspondingSingleProductId": "EXDDB"
  },
  "currency": "USD",
  "quantities": [
    {
      "quantity": 250,
      "price": "75.00"
    },
    {
      "quantity": 500,
      "price": "150.00"
    },
    {
      "quantity": 1000,
      "price": "300.00"
    }
  ],
  "_profile": "https://api.apiture.com/schemas/checkOrders/checkingProduct/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.apiture.com/checkOrders/checkingProducts/DXDDB"
    },
    "apiture:image": {
      "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/DXDDB.png"
    },
    "apiture:includedCover": {
      "href": "https://api.apiture.com/checkOrders/checkingProducts/CVRCMEXEB"
    },
    "apiture:includedCoverImage": {
      "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRCMEXEB.png"
    },
    "apiture:correspondingSingleChecksProduct": {
      "href": "https://api.apiture.com/checkOrders/checkingProducts/EXDDB"
    }
  }
}

Checking Product (v1.0.0)

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:image	URL of the image of this 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 for this checkbook product product, if any	GET

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
code	string The unique product code/identifier of this check order product. minLength: 2
type	checkingProductType The product type (checkbook or checkbookCover).
accountTarget	checkingProductTarget The kind of banking account (personal or business) the product applies to.
label	string A short title or label for the item.
name	string(markdown) The product name.
description	string(markdown) A more complete description of the item.
currency	string The ISO 4217 currency code for the quantities offered for this product. Default: "USD" read-only minLength: 3 maxLength: 3 pattern: [A-Z]{3}
checkbookOptions	checkingProductCheckbookOptions Options that apply only to checkbook products.
quantities	[checkingProductQuantity] Orderable quantities and the order price for each quantity.

checkingProductCheckbookOptions

{
  "includedCheckbookCoverProductId": "CMEXEB",
  "includesDuplicateChecks": false,
  "correspondingSingleProductId": "EXDDB"
}

Checking Product Checkbook Options (v1.0.0)

Options that apply only to checkbook products.

Properties

Name	Description
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	[string] This is a list of product IDs (_id) of orderable checkbook covers that go with this for this checkbook.
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

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

Type: string
Enumerated 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
cover	Checkbook Cover

Type: string
Enumerated values:
checkbook
cover

checkingProducts

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

Checking Product Collection (v1.0.0)

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

Properties

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

collection

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

Collection (v2.0.0)

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

This schema was resolved from common/collection.

Properties

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

createCheckOrder

{
  "name": "Lucille Welphunded",
  "checkAddressId": "ha1",
  "shippingAddressId": "ha1",
  "line1": "\"I have a dream\"",
  "_links": {
    "apiture:account": {
      "href": "http://api.apiture.com/accounts/accounts/bff971b6-c4c2-4a6b-a216-faa6af1464cd"
    }
  }
}

Create Check Order (v1.0.0)

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 user owns or manages.	GET

Properties

Name	Description
_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.
_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.
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
checkAddressId	any (required) The _id of the postal address that is printed on the checks. For a pesonal checking account, the _id is the address ID from the user's addresses. For a business checking account, the _id is the address ID from the owning organization's addresses.
shippingAddressId	string (required) The _id of the postal address where the order is shipped. For a pesonal checking account, the _id is the address ID from the user'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}$

embeddedCheckOrders

{
  "items": {
    "_id": "a7bebcae-bef1-434d-a089-42389f3b6027",
    "state": "submitted",
    "name": "Lucille Welphunded",
    "checkbookCostWaived": false,
    "checkAddressId": "ha1",
    "shippingAddressId": "ha1",
    "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": {
      "price": "22.00",
      "currency": "USD"
    },
    "createdAt": "2020-08-03T13:01:47.375Z",
    "submittedAt": "2020-08-03T13:09:54.375Z",
    "_profile": "https://api.apiture.com/schemas/checkOrders/checkOrder/v1.0.0/profile.json",
    "_links": {
      "self": {
        "href": "http://api.apiture.com/checkOrders/orders/a7bebcae-bef1-434d-a089-42389f3b6027"
      }
    }
  }
}

Embedded Check Orders (v1.0.0)

Items embedded in the checkOrders collection.

Properties

Name	Description
items	[checkOrder] An array containing check orders.

embeddedCheckingProducts

{
  "items": [
    {
      "code": "DXDDB",
      "name": "Business Checks",
      "label": "Executive Dskbk - Blu Safety Checks - Duplicate",
      "description": "Business Blue safety checks with duplicates",
      "type": "checkbook",
      "target": "business",
      "checkbookOptions": {
        "includedCheckbookCoverProductId": "CMEXEB",
        "includesDuplicateChecks": false,
        "correspondingSingleProductId": "EXDDB"
      },
      "currency": "USD",
      "quantities": [
        {
          "quantity": 250,
          "price": "75.00"
        },
        {
          "quantity": 500,
          "price": "150.00"
        },
        {
          "quantity": 1000,
          "price": "300.00"
        }
      ],
      "_profile": "https://api.apiture.com/schemas/checkOrders/checkingProduct/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.apiture.com/checkOrders/checkingProducts/DXDDB"
        },
        "apiture:image": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/DXDDB.png"
        },
        "apiture:includedCover": {
          "href": "https://api.apiture.com/checkOrders/checkingProducts/CVRCMEXEB"
        },
        "apiture:includedCoverImage": {
          "href": "https://cdn.apiture.com/images/checkOrders/checkingProducts/CVRCMEXEB.png"
        },
        "apiture:correspondingSingleChecksProduct": {
          "href": "https://api.apiture.com/checkOrders/checkingProducts/EXDDB"
        }
      }
    }
  ]
}

Embedded Checking Products (v1.0.0)

Items embedded in the checkingProducts collection.

Properties

Name	Description
items	[checkingProduct] An array containing checking products.

error

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

Error (v2.0.0)

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

This schema was resolved from common/error.

Properties

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

errorResponse

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://api.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response (v2.0.0)

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

This schema was resolved from common/errorResponse.

Properties

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

link

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

Link (v1.0.0)

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

This schema was resolved from common/link.

Properties

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

links

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

Links (v1.0.0)

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

This schema was resolved from common/links.

Properties

Name	Description
additionalProperties	link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property. This schema was resolved from common/link.

root

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

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