Get pivot report
Returns an aggregated snapshot report for the specified date range and report type. Transaction-backed report types are restricted to AMEX transactions (network=amex is forced server-side): daily-report, settlement-batch, location, user-account, payment-method, card-type, terminal-id, source, amex-balance, amex-transactions. The deposit report types (deposit-report, deposit-detail, automobile-deposit-report) query deposit records by MID, date and batch type and are not filtered by card network. Amounts in the per-bucket data[] rows (amount, surcharge, baseAmount) are in cents; the bucket totals (totalCharges, totalRefund, totalPaidSurcharge, baseAmount, amex, total, ...) are in dollars. startDay / endDay are YYYY-MM-DD; when both are omitted the full history is returned. Results are not paginated. timezone (IANA, default America/New_York) controls the date buckets. Use reportType to select the grouping dimension (unknown values fall back to daily-report):
daily-report— transactions grouped by date (default)settlement-batch— transactions grouped by settlement batchlocation— transactions grouped by department/locationuser-account— transactions grouped by user accountpayment-method,card-type,terminal-id,source— grouped by that dimensionamex-balance,amex-transactions— AMEX ESA program insightsdeposit-report,deposit-detail,automobile-deposit-report— deposit reports (all card networks)
query Parameters
clientIdIgnored. Derived from your API key (key-hash).
timezoneIANA timezone for date buckets, default America/New_York
startDayFilter from start date (YYYY-MM-DD). When both startDay and endDay are omitted the full history is returned.
endDayFilter to end date (YYYY-MM-DD). When both startDay and endDay are omitted the full history is returned.
reportTypeReport type. Accepted values: daily-report (grouped by date), settlement-batch (grouped by batch), location (grouped by department/location), user-account (grouped by user account), payment-method, card-type, terminal-id, source, amex-balance, amex-transactions, deposit-report, deposit-detail, automobile-deposit-report. Unknown values fall back to daily-report. Transaction-backed types are restricted to AMEX; deposit types are not filtered by card network.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Get pivot report › Responses
Pivot report data.
Get deposit report
Returns a list of deposits showing how much was funded for the given date range and MID (Merchant ID). Use startDay and endDay to filter by date range (format: YYYY-MM-DD, UTC); both default to today when omitted. Amounts are in cents. Provide mid to filter by a specific merchant account. Rows may also include settlementDate, customerFeeAmount, merchantFeeAmount, chargebackAmount, adjustmentAmount, diffAmount, customerName, externalMid and source; meta.totals aggregates the money fields over the whole date range (not just the current page).
query Parameters
startDayFilter from Start Date (YYYY-MM-DD, UTC). Defaults to today when omitted.
endDayFilter to End Date (YYYY-MM-DD, UTC). Defaults to today when omitted.
pagePage number (default 1)
limitItems per page (default 10; -1 returns all rows)
midMID (Merchant ID) to filter deposits. Required to retrieve meaningful results.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Get deposit report › Responses
Deposit report data.
Get deposit details
Returns line-item transaction detail for a specific deposit batch. Provide the paymentReference value from the deposit report to drill into individual transactions within that batch. Optional startDay / endDay (YYYY-MM-DD, UTC) filter by settlement date. Rows are raw deposit records (including _id, __v, masked accountNumber, routingNumber).
query Parameters
paymentReferencePayment reference from the deposit report. Required to retrieve deposit line-item details for a specific batch.
pagePage number (default 1)
limitItems per page (default 10; -1 returns all rows)
reportTypeSet to details to return CHARGEBACK and ADJUSTMENT rows instead of DEPOSIT rows.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Get deposit details › Responses
Deposit detail rows.