GRgreendot
PaperCheck

Get Check Payment Images

Retrieves images of check payments for the specified account and check number, including the requested image face type.

get/programs/{programCode}/accounts/{accountIdentifier}/checkImages

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 payment images.

Query parameters

checkNumberstring

The check number for which images are requested.

imageFaceTypestring

The face type of the check image (e.g., front, back).

Headers

X-GD-RequestIdstring required

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

Response

OK

requestedImageFaces'front' | 'rear' | 'both'

The type of image faces requested (e.g., front, rear, both). Uses Gd.Bos.DataTransfer.Enums.ImageFaceType to specify which faces of the check were requested.

imageFetchStatuses'none' | 'front' | 'rear' | 'both'

The status of the image fetch operation (e.g., none, front, rear, both). Uses Gd.Bos.DataTransfer.Enums.ImageFetchStatus to indicate which images were successfully fetched.

Changes

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