Get pivot report
Returns an aggregated snapshot report for the specified date range and report type. Use reportType to select the grouping dimension:
amex-transactions— AMEX ESA program insightssettlement-batch— transactions grouped by settlement batchdaily-report— transactions grouped by datelocation— transactions grouped by department/locationuser-account— transactions grouped by user account
query Parameters
clientIdFilter by clientId
startDayFilter from Start Date
endDayFilter to End Date
reportTypeReport type. Allowed values: amex-transactions (AMEX ESA insights), settlement-batch (grouped by batch), daily-report (grouped by date), location (grouped by department/location), user-account (grouped by user account).
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). Provide mid to filter by a specific merchant account.
query Parameters
startDayFilter from Start Date
endDayFilter to End Date
pagePage number for paginating
limitLimit items per page
midMID (Merchant ID) to filter deposits. Required to retrieve meaningful results.
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.
query Parameters
paymentReferencePayment reference from the deposit report. Required to retrieve deposit line-item details for a specific batch.
pagePage number for paginating
limitLimit items per page
Get deposit details › Responses
Deposit detail rows.