---
title: "Get check image data"
method: GET
path: "/v3/payments/{paymentId}/check-image"
tags: ["payments"]
---

# Get check image data

`GET /v3/payments/{paymentId}/check-image`

## Request

- Base URL: `https://gateway.stage.bill.com/connect`
- URL: `https://gateway.stage.bill.com/connect/v3/payments/{paymentId}/check-image`
- Auth: none declared

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 parameters

- `paymentId` string, required: BILL-generated ID of the payment. The value begins with `stp`.

## Headers

- `sessionId` string, nullable: API session ID generated with `/v3/login`
- `devKey` string, nullable: Developer key generated with your BILL developer account

## Response `200`

Get check image data response

- CheckImageDataResponseDto: Check image data response.
  - `results` DownloadLink[]: URLs for the check image
    - `downloadLink` string: URL for downloading the check image. Use the URL in a GET request to download the check image.

## Other responses

- `4XX`: List of errors.
- `5XX`: List of errors.

## Changes

- **2026-11-03** `54edddceb0a5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bill/apis/bill-v3-api/changes/v3/payments/:paymentId/check-image/get.md)

---

[API](https://skmtc.dev/bill/apis/bill-v3-api.md) - [All operations](https://skmtc.dev/bill/apis/bill-v3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bill/apis/bill-v3-api/revisions/54edddceb0a5?raw)