BIbill
payments

Get check image data

Changed on

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}
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

Path parameters

paymentIdstring required

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

Example:{{payment_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Get check image data response

Changes