Settlement

List transactions

Changed on

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 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.
get/transactions

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/transactions
  • Auth
    HTTP bearer

Query parameters

beforestring

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.

afterstring

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.

limitinteger

Limit the maximum number of results that we return for each page.

datestring date

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.

batchIdinteger

Filter transactions by the unique identifier of the batch that contains the transaction.

You must provide either the batchId or the date.

merchantIdstring

Filter results by the unique identifier that the processor assigned to the merchant.

transactionType'Capture' | 'Return'

Filter transactions by transaction type.

Response

Successful request. Returns a paginated list of transactions.

limitinteger

Maximum number of results that we return for each page.

countinteger

Number of results we returned on this page.

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

hasMoreboolean

Indicates whether there is another page of results available.

Changes

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API

  • 9af893904873Revision changes
    • info

      api operation id listTransactions removed and replaced with settlement_listTransactions