Get Agent Batch Reports

This endpoint allows you to retrieve batch settlement reports for merchants based on a specified date range. The response contains detailed transaction and settlement information for each merchant account within the given date range.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Details

  • Merchant_Account_Number: Unique identifier for the merchant account.
  • Settlement_Date: Date of settlement.
  • ad_total_sale: Adjusted total sale amount (can be null if no adjustments were made).
  • ad_total_refunds: Adjusted total refunds (can be null).
  • ad_net_amt: Adjusted net amount after refunds (can be null).
  • Amounts: The total sales amount processed.
  • total_refunds: The total refund amount processed.
  • total_net_amt: The total net amount after refunds.
  • rj_total_sale: Rejected total sale amount (can be null).
  • rj_total_refunds: Rejected total refunds (can be null).
  • rj_net_amt: Rejected net amount (can be null).
  • Transactions: The total number of transactions.
  • Batch_Reference_Number: The reference number for the batch.
  • reject_record: Reject record status.
  • dba_name: Doing business as name for the merchant.
  • account_type: The type of account (e.g., payfac).
Body Params
string

(required): The starting date of the report range (format: YYYY-MM-DD).

string

(required): The ending date of the report range (format: YYYY-MM-DD).

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json