Skip to main content
GET
Retrieve an import batch

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

The unique identifier of the import batch

Response

Import batch retrieved successfully

id
integer
data_stream_key
string

Key of the data stream this import batch belongs to

source
enum<string>

How the records were imported

Available options:
csv_upload,
nacha_upload,
bulk_api
filename
string | null

Original filename for CSV uploads

record_count
integer

Number of records in this batch

total_credits
integer

Sum of credit amounts in cents

total_debits
integer

Sum of debit amounts in cents

net_amount
integer

Net amount in cents (credits minus debits)

decimal_places
integer
default:2

Number of decimal places (2 for USD)

date_range_start
string<date> | null

Earliest record date in the batch

date_range_end
string<date> | null

Latest record date in the batch

created_at
string<date-time>
records_url
string

URL to fetch records belonging to this batch