Retrieve an import batch

Retrieve a single import batch by its unique ID.

get/import_batches/{id}

Path parameters

idstring required

The unique identifier of the import batch

Import batch retrieved successfully

idinteger

data_stream_keystring

Key of the data stream this import batch belongs to

source'csv_upload' | 'nacha_upload' | 'bulk_api'

How the records were imported

filenamestring nullable

Original filename for CSV uploads

record_countinteger

Number of records in this batch

total_creditsinteger

Sum of credit amounts in cents

total_debitsinteger

Sum of debit amounts in cents

net_amountinteger

Net amount in cents (credits minus debits)

decimal_placesinteger

Number of decimal places (2 for USD)

date_range_startstring date nullable

Earliest record date in the batch

date_range_endstring date nullable

Latest record date in the batch

created_atstring date-time

records_urlstring

URL to fetch records belonging to this batch