Update Paper Check Payment Status

put

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

Stops payment on a paper check. Partners can request a stop payment on checks by providing the check number and account identifier.

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 paper check.

Body Params

The request payload containing paper check payment details.

AccountIdentifier: The account identifier.
CheckNumber: The check number to stop payment on.
CheckInventoryStatus: The status of the check inventory.

Represents a request to stop payment on a paper check.
Contains account identifier, check number, and check inventory status.
Inherits standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.

accountIdentifier

string | null

The unique identifier for the account associated with the check.

checkNumber

string | null

The number of the paper check for which payment is to be stopped.

checkInventoryStatus

string | null

The inventory status of the check.

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