Overview

This endpoint manages paper checks that are received to be processed.

Check Object

The ampliFi API represents checks (also referred to as cheques) using a JSON object. This table lists properties that may be included in a check (cheque) object. Some details are optional.

Images are encoded in base 64. They may be one of several common file formats, but are interpreted only by the back-office. At least one image should be present.

Property	Description	Schema	Example Values
AFiChequeId	ampliFi ID for this check	string	"qweawcqlq5if7bzdhkpkhyvopbtzbjnqvmvmokpuxtyacij"
AFiUserId	amplifi ID for the user this check belongs to	string	"qweaurl8kgtlv9pc"
amount	Amount of the check	number	1.01
currency	3-letter currency code	string	"USD"
dtsCreated	Date and time created	date	"2023-12-14T18:04:20.063Z"
dtsModified	Date and time last modified	date	"2023-12-14T18:04:20.063Z"
isAccepted	true if check has been accepted	boolean	false
isPendingApproval	true if check is waiting for approval	boolean	false
isCredited	true if check has been credited to user's account	boolean	false
isDeleted	true if check has been deleted	boolean	false
isActive	true if check is active	boolean	true
imgFrontB64	Full image of the front of the check	string	"very-long-b64-string"
imgBackB64	Full image of the back of the check	string	"very-long-b64-string"
thumbFrontB64	Small (thumbnail) image of the front of the check	string	"very-long-b64-string"
thumbBackB64	Small (thumbnail) image of the back of the check	string	"very-long-b64-string"