Lockbox Providers

Batch Format

A batch is a ZIP file containing one or more TIFF images and a single CSV index file. The CSV describes the mail items and their associated transactions. Each TIFF file in the ZIP must have a corresponding row in the CSV, and vice versa.

Also see: Mail Uploads | Rescans | Provisioning

Mail Item Types

Mail items are classified into one of the following types:

  • White Mail. Mail items with no check or grant data.
  • Donor Advised Fund (DAF) Check. Mail items with a check from a Donor Advised Fund. This will typically also include grant data.
  • Other Check. Mail items with a check from a non-DAF source.

ZIP Structure

A batch ZIP should contain one CSV index file and one TIFF file per mail item. The TIFF filenames should correspond to the mail_item_id values in the CSV.

batch.zip
├── index.csv
├── mail_a1b2c3.tiff
├── mail_d4e5f6.tiff
└── mail_g7h8i9.tiff

In this example, the CSV would contain rows with mail_item_id values mail_a1b2c3, mail_d4e5f6, and mail_g7h8i9. If a mail item has multiple transactions, only one TIFF file is needed — the mail_item_id is repeated across CSV rows but maps to a single image.

Validation Rules

  • The ZIP must contain exactly one CSV file and one or more TIFF files
  • Every TIFF file must have a corresponding mail_item_id row in the CSV
  • Every mail_item_id in the CSV must have a corresponding TIFF file in the ZIP

A mail item may have multiple transactions. In this case, use the same mail_item_id for all rows belonging to that mail item.

CSV Structure

The CSV index file has the following columns, listed in the order they should appear. They are grouped into three categories: mail item info, payment info, and transaction info. Note that column requirement indicates that the mail item cannot be processed if the column is missing.

Mail Item Info

Required for all mail items.

ColumnDescriptionRequired
mail_item_idUnique identifier for the mail item. Used to match CSV rows to TIFF files in the ZIP.Yes
mail_sent_to_po_boxPO box number the item was sent toYes
mail_sent_to_department_codeDepartment code within a shared PO box. Must be set if the mail item was sent to a department code.No*

Payment Info

Required for all mail items that contain a check.

ColumnDescriptionRequired
payment_methodPayment method. Must be CHECK.Yes
payment_amountTotal payment amount in cents (e.g., 30000 for $300.00)Yes
check_numberCheck numberYes
check_dateDate on the check in MMddYYYY format (e.g., 07012025 for July 1, 2025)Yes
check_memoMemo line from the checkNo
payerName of the paying entityYes
payeeName of the payeeYes

Transaction Info

Required for DAF checks.

ColumnDescriptionRequiredExample
amountTransaction amount in cents (e.g., 18000 for $180.00)Yes18000
fund_nameThe name of the donor’s account in the DAFNoThe Doe Family Fund
donor_first_nameDonor’s first nameNoJohn
donor_last_nameDonor’s last nameNoDoe
donor_address_line1Donor’s street addressNo123 Main St
donor_address_line2Donor’s address line 2No
donor_address_cityDonor’s cityNoNew York
donor_address_stateDonor’s stateNoNY
donor_address_zipDonor’s ZIP codeNo10001
donor_emailDonor’s email addressNojohn.doe@example.com
purposePurpose of the grantNoGeneral Operating Support
noteDonor provided noteNoIn honor of my mom

Note that a DAF check may be associated with multiple grants (or “transactions”). In this case, the CSV should contain a row for each grant, sharing the same mail_item_id and check information.

Example

A mail item has a $180.00 check from DAFgiving360. The grant letter includes two grants: $100.00 from John Doe for general operating support, and $80.00 from Jane Smith for program support. The CSV should contain two rows:

mail_sent_to_po_boxmail_sent_to_department_codemail_item_idpayment_methodpayment_amountcheck_numbercheck_datecheck_memopayerpayeeamountfund_namedonor_first_namedonor_last_namedonor_address_line1donor_address_line2donor_address_citydonor_address_statedonor_address_zipdonor_emailpurposenote
5432DPT1mail_a1b2c3CHECK180000002617986121820248922058DAFgiving360Save the Whales18000DAFgiving360John DoeDoe123 Main St(empty)New YorkNY10001john.doe@example.comGeneral Operating SupportThis grant is for the general operating support of the organization.
5432DPT1mail_a1b2c3CHECK180000002617986121820248922058DAFgiving360Save the Whales18000DAFgiving360Jane SmithSmith123 Main St(empty)New YorkNY10001jane.smith@example.comProgram SupportThis grant is for the program support of the organization.