SchemaReportingSettlement

List transactions

Use this method to return a paginated list of your merchants’ transactions. **Note:** If you want to view the details of a specific transaction and you have its transactionId, use our [Retrieve Transaction](https://docs.payroc.com/api/schema/reporting/settlement/retrieve-transaction) method. Use query parameters to filter the list of results that we return, for example, to search for transactions for a specific merchant. > **Important:** You must provide a value for either the date query parameter or the batchId query parameter. Our gateway returns the following information about each transaction in the list: - Merchant and processing account that ran the transaction. - Transaction type, date, amount, and the payment method that the customer used. - Batch that contains the transaction, and authorization details for the transaction. - Processor that settled the transaction and the ACH deposit containing the transaction.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

beforestringOptional

Return the previous page of results before the value that you specify.

You can’t send the before parameter in the same request as the after parameter.

afterstringOptional

Return the next page of results after the value that you specify.

You can’t send the after parameter in the same request as the before parameter.

limitintegerOptional<=100Defaults to 10
Limit the maximum number of results that we return for each page.
datedateRequired

Filter transactions by the date that the merchant submitted the batch that contains the transaction. The format of this value is YYYY-MM-DD.

You must provide either the batchId or the date.

batchIdintegerRequired
Filter transactions by the unique identifier of the batch that contains the transaction. You must provide either the batchId or the date.
merchantIdstringOptional
Filter results by the unique identifier that the processor assigned to the merchant.
transactionTypeenumOptional
Filter transactions by transaction type.
Allowed values:

Response

Successful request. Returns a paginated list of transactions.
datalist of objects
Array of transaction objects.
countdouble or null

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean or null
Indicates whether there is another page of results available.
limitdouble or null
Maximum number of results that we return for each page.

Errors