Sign in
Transactions

List transactions

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

get/v2.1/merchants/{merchant_code}/transactions/history

Path parameters

merchant_codestring required
Example:MH4H92C7

Short unique identifier for the merchant.

Query parameters

transaction_codestring
Example:TEENSK4W2K

Retrieves the transaction resource with the specified transaction code.

order'ascending' | 'descending'

Specifies the order in which the returned results are displayed.

limitinteger
Example:10

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

users[]string[]

Filters the returned results by user email.

[
  "merchant@example.com"
]
statuses[]string[]

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

[
  "SUCCESSFUL",
  "REFUNDED"
]
payment_types[]PaymentType[]

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

[
  "ECOM",
  "POS"
]
entry_modes[]EntryMode[]

Filters the returned results by the specified list of entry modes.

[
  "CUSTOMER_ENTRY",
  "CHIP"
]
types[]string[]

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

[
  "PAYMENT",
  "REFUND"
]
changes_sincestring date-time
Example:2019-08-28T09:00:00Z

Filters the results by the latest modification time of resources and returns only transactions that are modified at or after the specified timestamp (in ISO8601 format).

newest_timestring date-time
Example:2019-08-29T09:00:00Z

Filters the results by the creation time of resources and returns only transactions that are created before the specified timestamp (in ISO8601 format).

newest_refstring
Example:090df9bf-93b7-40f1-8181-fbdb236568a1

Filters the results by the reference ID of transaction 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_timestring date-time
Example:2019-08-28T09:00:00Z

Filters the results by the creation time of resources and returns only transactions that are created at or after the specified timestamp (in ISO8601 format).

oldest_refstring
Example:090df9bf-93b7-40f1-8181-fbdb236568a1

Filters the results by the reference ID of transaction 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).

Response

Returns a page of transaction history items.

Example response

{
  "items": [
    {
      "transaction_code": "TEENSK4W2K",
      "amount": 10.1,
      "currency": "EUR",
      "timestamp": "2020-02-29T10:56:56.876Z",
      "status": "SUCCESSFUL",
      "payment_type": "ECOM",
      "installments_count": 1,
      "merchant_code": "MH4H92C7",
      "transaction_id": "410fc44a-5956-44e1-b5cc-19c6f8d727a4",
      "user": "merchant@example.com",
      "type": "PAYMENT",
      "payout_date": "2019-08-28",
      "payout_type": "BANK_ACCOUNT",
      "refunded_amount": 0
    }
  ],
  "links": []
}

Changes

Changed in 12 of the 53 revisions of this API.12727

  • c75ca16e1e441See the full diff
    • ○

      the security scope transactions.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 89d32e0b22e233See the full diff
    • ●

      deleted the query request parameter payment_types

      request-parameter-removed

    • ●

      deleted the query request parameter types

      request-parameter-removed

    • ●

      deleted the query request parameter users

      request-parameter-removed

    • ○

      added the new optional query request parameter payment_types[]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter types[]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter users[]

      new-optional-request-parameter

  • 3b883d8c8a7c1See the full diff
    • ●

      added the new REFUNDED enum value to the items/items/allOf[subschema #1: Transaction Base]/status response property for the response status 200

      response-property-enum-value-added

  • bc466839f97d1See the full diff
    • ○

      added the enum value TWINT to the property items/ of the query request parameter entry_modes[]

      request-parameter-property-enum-value-added

  • cd79d83b07e037See the full diff
    • ●

      deleted the query request parameter statuses

      request-parameter-removed

    • ●

      removed the optional property error_code from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property message from the response with the 401 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter statuses[]

      new-optional-request-parameter

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the optional property detail to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property instance to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property title to the response with the 401 status

      response-optional-property-added

    • ○

      added the required property type to the response with the 401 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bef1083e0580125See the full diff
    • ▲

      the links/items/href response's property type/format changed from string/uri to string/ for status 200

      response-property-type-changed

    • ●

      removed the optional property links/items/type from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new COP enum value to the items/items/allOf[TransactionBase]/currency response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property items/items/allOf[subschema #3]/payout_date to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/allOf[subschema #3]/payout_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/allOf[subschema #3]/refunded_amount to the response with the 200 status

      response-optional-property-added

    • ○

      the response property links/items/href became required for the status 200

      response-property-became-required

    • ○

      the response property links/items/rel became required for the status 200

      response-property-became-required

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e28f194df27e101See the full diff
    • ●

      added the new ALELO enum value to the items/items/allOf[subschema #3]/card_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new CONECS enum value to the items/items/allOf[subschema #3]/card_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new EFTPOS enum value to the items/items/allOf[subschema #3]/card_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new GIROCARD enum value to the items/items/allOf[subschema #3]/card_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new INTERAC enum value to the items/items/allOf[subschema #3]/card_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PLUXEE enum value to the items/items/allOf[subschema #3]/card_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SWILE enum value to the items/items/allOf[subschema #3]/card_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new TICKET enum value to the items/items/allOf[subschema #3]/card_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new VPAY enum value to the items/items/allOf[subschema #3]/card_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new VR enum value to the items/items/allOf[subschema #3]/card_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional query request parameter entry_modes[]

      new-optional-request-parameter

  • 132e5091a88574See the full diff
    • ●

      added the new APM enum value to the items/items/allOf[TransactionBase]/payment_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new BALANCE enum value to the items/items/allOf[TransactionBase]/payment_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new BITCOIN enum value to the items/items/allOf[TransactionBase]/payment_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new CASH enum value to the items/items/allOf[TransactionBase]/payment_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new DIRECT_DEBIT enum value to the items/items/allOf[TransactionBase]/payment_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new MOTO enum value to the items/items/allOf[TransactionBase]/payment_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new UNKNOWN enum value to the items/items/allOf[TransactionBase]/payment_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value APM to the property items/ of the query request parameter payment_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value BITCOIN to the property items/ of the query request parameter payment_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value DIRECT_DEBIT to the property items/ of the query request parameter payment_types

      request-parameter-property-enum-value-added

    • ○

      added the enum value RECURRING to the property items/ of the query request parameter payment_types

      request-parameter-property-enum-value-added

  • b0fd605a49292See the full diff
    • ○

      added TransactionBase to the items/items/ response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed TransactionMixinBase from the items/items/ response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 200136cdef811See the full diff
    • ●

      added the new POS enum value to the items/items/allOf[TransactionMixinBase]/payment_type response property for the response status 200

      response-property-enum-value-added