Paper Checks Overview

Paper Checks APIs provide essential functionality for handling paper check operations within an account.

It allows partners to stop payments on issued checks, ensuring quick action in cases of fraud or error. Additionally, the API supports updating the status of checkbook orders, retrieving detailed lists of existing orders, and accessing images of processed check payments for verification or record-keeping.

These endpoints offer a streamlined approach to managing check-related activities, improving operational efficiency and reducing risk for businesses that rely on paper-based transactions.

Paper Checks API Endpoints

Stop Paper Check Payment

Stops payment on a paper check. Partners can request a stop payment on checks by providing the check number and account identifier.

API Call Structure

PUT /programs/{programCode}/accounts/{accountIdentifier}/checkInventory

Update Check Book Order Status

Updates the status of a paper check book order, such as marking it as notReceived.

API Call Structure

PUT /programs/{programCode}/accounts/{accountIdentifier}/checkBookOrder

Get Check Book Orders

Retrieves the list of check book orders for the specified account. Optionally filter by order confirmation token.

API Call Structure

GET /programs/{programCode}/accounts/{accountIdentifier}/checkBookOrders

Transaction Description

For check purchases, the customer will see transaction description Paper Check Debit #XXXX, where XXXX is a check number.

Get Check Payment Images

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

API Call Structure

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