Deposit entry changes

This page is for Partner API.

The entry-level deposits update corrects cases where several bank deposits appeared as one API record. Rollout timing is coordinated separately; this page describes the new contract.

GET /api/partner/merchants/{merchant_id}/deposits returns entries within each TSYS ACH control total. Lines marked C (Combine) form one entry across their batch references. Other lines group by reference. A reference can contribute to both a separate entry and a combined entry when its card plans have different settings. Amounts remain signed decimal dollars; dates remain processor dates and do not confirm bank receipt.

For example, a previous 2814.93 record becomes 1506.22 and 1308.71. A combined 84151.70 record spanning 22 references remains one entry. Totals across those entries remain unchanged when the underlying data is unchanged. Groups made entirely of No ACH (N) lines that net to zero are omitted when their source control total reconciles. Other zero records and unreconciled source records (including N-only groups) remain visible; they are not confirmation of a bank credit.

Update stored IDs and pagination

All deposit IDs use new opaque entry identities, including deposits that remain a single entry. IDs still contain 32 hexadecimal characters and match the merchant portal’s IDs. Old control-total IDs return 404 and do not redirect to an arbitrary child entry.

After rollout, discard cached deposit IDs, restart pagination at page 1, and refetch each processing-date window you store (maximum 90 days per request). Replace the previous window’s records rather than appending the new IDs, which would double-count funding. Coordinate this replacement with any downstream accounting or reconciliation workflow that persists deposit IDs. Counts and total pages now count entries, so they can increase.

Entry metadata and detail

• entry_type: combined, separate, or unavailable when detail evidence is missing.
• batch_count: distinct nonzero deposit references in the entry, not card-plan lines or matched processor headers.
• reference_number: normalized reference for separate entries; null for combined entries and missing/zero references. A combined entry has no single representative reference.

Every entry inherits its source control total’s reconciliation result. Its amount, categories, effective dates and status are calculated from its own lines. No ACH (N) lines always participate in source reconciliation. Reconciled zero-net N-only groups are omitted from lists, counts and detail URLs; N lines mixed with other non-C attributes and nonzero N-only groups remain visible. Separate (S) is provisionally grouped per reference like Deposit (D).

Detail lines and related-batch ach_deposit_amount / ach_fee_amount are limited to the selected entry. A processor batch can be related to more than one entry; its amount and transaction list still describe the whole processor batch. Do not sum those whole-batch amounts as bank deposits across entries. Use the entry amounts for funding totals.

Summary reference_number is normalized (whitespace and leading zeros removed). Line and related-batch references retain their original processor representation; normalize those values when comparing them with summary references.