Checkissuing API Documentation

Get Posted Check Image (Wells Fargo)

This method retrieves front and back images of a cleared (paid) check directly from Wells Fargo. It is available for payments drawn on Wells Fargo-connected bank accounts that have reached Posted/Cashed status — the platform learns the paid date from Wells Fargo's transaction reporting, and an image cannot be requested before that happens. Once retrieved, images are stored on our side and subsequent requests return them immediately without contacting Wells Fargo.

Send a POST request with the parameters below. Note the path is case-sensitive (capital I in wf-checkImage) and does not accept a URL parameter — pass payment_id in the request body.

Sandbox Endpoint

Parameters

Parameter	Type	Required	Default	Description
payment_id	Int	Yes	N/A	The ID of the payment you want to retrieve the posted (cleared) check images for.

Sample Response

On success the response contains Base64-encoded PNG images of the front and back of the cleared check:

{"tplData":{"frontImage":"iVBORw0KGgoAAAANSUhEUgAA...","backImage":"iVBORw0KGgoAAAANSUhEUgAA...","noImageFound":false}}

To display an image, prefix the value with a data URI (data:image/png;base64,...) or Base64-decode it to obtain the PNG file.

If no image is available yet — for example the check has not posted, or Wells Fargo has no image on file for it — the endpoint returns HTTP 200 with:

{"tplData":{"frontImage":null,"backImage":null,"noImageFound":true}}

Unlike most endpoints, the success payload does not include the standard status/errors envelope — check tplData.noImageFound instead.

Error Responses

HTTP Status	Body	Cause
403	`{"status":0,"errors":["Access Denied"],"error_message":"Access Denied"}`	Missing, invalid or expired OAuth token.
403	`{"status":0,"errors":["Access Denied"],"error_message":"No permission to view the posted check image"}`	Your API user has the "view posted check images" permission disabled.
500	`{"error":"Failed to get access token: ..."}`	The platform could not authenticate with Wells Fargo. Retry later or contact support if the problem persists.

Character Encoding