---
title: "Get Check Book Orders"
method: GET
path: "/programs/{programCode}/accounts/{accountIdentifier}/checkBookOrders"
tags: ["PaperCheck"]
---

# Get Check Book Orders

`GET /programs/{programCode}/accounts/{accountIdentifier}/checkBookOrders`

Retrieves the list of check book orders for the specified account. Optionally filter by order confirmation token.

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required

## Query parameters

- `orderConfirmationToken` string

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- GetCheckBookOrdersResponse — Represents the response returned after retrieving checkbook orders for an account. Contains a list of checkbook order details. Inherits standard response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
  - `checkBookOrders` CheckBookOrder[], nullable — The list of checkbook orders returned by the operation. Each Gd.Bos.DataTransfer.CheckBookOrder includes confirmation token, order date, status, and check number range.
    - `orderConfirmationToken` string, nullable — The token confirming the checkbook order, used for validation or tracking.
    - `checkBookOrderDate` string, date-time — The date when the checkbook order was placed.
    - `checkBookOrderStatus` string, nullable — The status of the checkbook order (e.g., "Pending", "Confirmed", "Cancelled").
    - `firstCheckNumber` string, nullable — The first check number included in the checkbook order.
    - `lastCheckNumber` string, nullable — The last check number included in the checkbook order.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)
