Get check image data

Get an image of an existing check sent to a vendor.

The check image is available when the vendor bank processes the check payment. BILL checks in with the bank every 30 minutes to get the check image. The image file format is determined by the vendor bank.

From the response, use downloadLink in a GET request to download the front and back images of the check.

curl '{downloadLink}' --header 'sessionId: {session_id}' --output {check_name}
Path Params
string
required
length ≥ 1

BILL-generated ID of the payment. The value begins with stp.

Headers
string | null

API session ID generated with /v3/login

string | null

Developer key generated with your BILL developer account

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json