TRtruelayer
Merchant accounts

Get transactions

Get the transactions of a single merchant account. Transactions are filtered and sorted by settled or executed date.

🚧 If the pagination object is missing, add a header tl-enable-pagination: true in the request to enable pagination (for more details click here)

get/v3/merchant-accounts/{id}/transactions

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/v3/merchant-accounts/{id}/transactions
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.truelayer.com/connect/token scopes: payments

Path parameters

idstring uuid required

Unique ID for the Merchant Account

Example:AB8FA060-3F1B-4AE8-9692-4AA3131020D0

ID of the merchant account to return the transactions for.

Query parameters

fromstring datetime required

Timestamp for the start of the range to query (inclusive). Uses the ISO-8601 format of YYYY-MM-DDTHH:MM:SS±HHMM.

tostring datetime required

Timestamp for the end of the range to query (exclusive). Uses the ISO-8601 format of YYYY-MM-DDTHH:MM:SS±HHMM.

cursorstring

Cursor used for pagination purposes, returned as next_cursor in the response payload of the initial request. Not required to access the first page of items.

type'payment' | 'payout'

Filters transactions by payments or payouts. If omitted, both payments and payouts are returned.

Response

Transactions

Example response

{
  "items": [
    {
      "currency": "GBP",
      "payment_source": {
        "id": "e2b41c9d-176k-67aa-b2da-fe1a2b97253c",
        "account_identifiers": [
          {
            "sort_code": "560029",
            "account_number": "26207729"
          }
        ]
      },
      "payment_id": "0afd1f6a-f611-48ce-9488-321129bb3a70",
      "metadata": {
        "prop1": "value1",
        "prop2": "value2"
      }
    }
  ],
  "pagination": {
    "next_cursor": "bWFuZGF0ZXM6MmUwNDk0MTMK"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.