Skip to navigation

Get a processor batch related to an ACH deposit

One DDF batch header related to the deposit, with its child transactions when the loaded records can isolate them exactly; otherwise transaction_status is “unavailable” and the list is empty. Batch amounts are card volume before funding adjustments. TSYS only: a Fiserv deposit lists no related batches, so this returns 404. TSYS ACH funding and Fiserv AccessOne deposits (Omaha FSP, North and Omaha Retail). Fiserv entries are one per report date and trace (a North batch number or an Omaha ACH trace): processing_date is the AccessOne report date, the effective date is unknown, cycle is OTHER and status is unreconciled because AccessOne sends no control total. TSYS merchants without a bindable bank identity and Fiserv merchants on another platform return 404 RESOURCE_NOT_FOUND with a message naming the reason. Amounts are signed decimal dollars. Effective dates are processor dates and do not confirm receipt by the merchant’s bank. meta.coverage reports loaded history and daily freshness as unknown; an empty page never means no funding.

Authentication

X-Partner-API-Keystring
API Key authentication via header

Path parameters

merchant_idstringRequired1-50 characters
Merchant ID
deposit_idstringRequired1-64 characters

32-character lowercase hexadecimal identifier from a previous response

header_idstringRequired1-64 characters

32-character lowercase hexadecimal identifier from a previous response

Response

Successful Response
dataobjectOptional

A related batch header with its exact child transactions when the loaded records can isolate them; otherwise transaction_status is unavailable.

metaobjectOptional

Single-object meta plus the source and coverage disclosure for deposit detail and batch responses.

errorslist of objectsOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error