GRgreendot
PaperCheck

Update Check Book Order Status

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

put/programs/{programCode}/accounts/{accountIdentifier}/checkBookOrder

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The program code identifying the BaaS program context.

accountIdentifierstring required

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

Headers

X-GD-RequestIdstring required

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

Request body

accountIdentifierstring nullable

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

orderConfirmationTokenstring nullable

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

checkBookOrderStatusstring nullable

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

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.