Update Check Book Order Status

put

https://example.com/programs/{programCode}/accounts/{accountIdentifier}/checkBookOrder

Updates the status of a paper check book order, such as marking it as not received.

Path Params

programCode

string

required

The program code identifying the BaaS program context.

accountIdentifier

string

required

The unique identifier for the account associated with the check book order.

Body Params

The request payload containing check book order details.

AccountIdentifier: The account identifier.
OrderConfirmationToken: The confirmation token for the check book order.
CheckBookOrderStatus: The status of the check book order.

Represents a request to order a checkbook for an account.
Contains account identifier, order confirmation token, and order status.
Inherits standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.

accountIdentifier

string | null

The unique identifier for the account for which the checkbook is being ordered.

orderConfirmationToken

string | null

The token confirming the checkbook order, used for validation or tracking.

checkBookOrderStatus

string | null

The status of the checkbook order (e.g., "Pending", "Confirmed", "Cancelled").

Headers

X-GD-RequestId

string

required

A unique request identifier for tracking and logging. Should be a GUID.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

200OK

403Forbidden

500Internal Server Error

503Service Unavailable