Skip to main content

List transactions

Lists detailed history of all transactions associated with the merchant account.

Query Parameters
  • transaction_code string

    Retrieves the transaction resource with the specified transaction code.

  • order string

    Possible values: [ascending, descending]

    Default value: ascending

    Specifies the order in which the returned results are displayed.

  • limit integer

    Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will return 10 results.

  • users email[]

    Filters the returned results by user email.

  • statuses string[]

    Possible values: [SUCCESSFUL, CANCELLED, FAILED, REFUNDED, CHARGE_BACK]

    Filters the returned results by the specified list of final statuses of the transactions.

  • payment_types string[]

    Possible values: [CASH, POS, ECOM, BALANCE, MOTO, BOLETO, UNKNOWN]

    Filters the returned results by the specified list of payment types used for the transactions.

  • types string[]

    Possible values: [PAYMENT, REFUND, CHARGE_BACK]

    Filters the returned results by the specified list of transaction types.

  • changes_since date-time

    Filters the results by the latest modification time of resources and returns only transactions that are modified at or after the specified timestamp (in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="noopener">ISO8601</a> format).

  • newest_time date-time

    Filters the results by the creation time of resources and returns only transactions that are created before the specified timestamp (in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="noopener">ISO8601</a> format).

  • newest_ref string

    Filters the results by the reference ID of transaciton events and returns only transactions with events whose IDs are smaller than the specified value. This parameters supersedes the newest_time parameter (if both are provided in the request).

  • oldest_time date-time

    Filters the results by the creation time of resources and returns only transactions that are created at or after the specified timestamp (in <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="noopener">ISO8601</a> format).

  • oldest_ref string

    Filters the results by the reference ID of transaciton events and returns only transactions with events whose IDs are greater than the specified value. This parameters supersedes the oldest_time parameter (if both are provided in the request).

Responses

OK


Schema
  • items object[]
  • links object[]
  • rel string

    Specifies the relation to the current resource.

  • href uri

    URL for accessing the related resource.

  • type string

    Specifies the media type of the related resource.