GRgreendot
PaperCheck

Update Paper Check Payment Status

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

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

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

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 associated with the check.

checkNumberstring nullable

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

checkInventoryStatusstring nullable

The inventory status of the check.

Response

OK

Changes

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