Retrieve a collection of transactions

This API endpoint is designed to retrieve a collection of transactions, providing a valuable tool for accessing recent transaction data for an account within your system.

Query Parameters

• includeTransactionDetail boolean
• page integer

  Default value: 1

  The collection page number

• itemsPerPage integer

  Possible values: <= 50

  Default value: 30

  The number of items per page

• pagination boolean

  Enable or disable pagination

• abs_amount[lt] string

  Filter by absolute amount

• abs_amount[lte] string

  Filter by absolute amount

• abs_amount[gt] string

  Filter by absolute amount

• abs_amount[gte] string

  Filter by absolute amount

• type string

  Possible values: [fee, fx, peer, payout, payin, card]

• account string
• executed boolean
• createdAt[lte] string

  The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"

• createdAt[lt] string

  The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"

• createdAt[gte] string

  The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"

• createdAt[gt] string

  The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"

• updatedAt[lte] string

  The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"

• updatedAt[lt] string

  The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"

• updatedAt[gte] string

  The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"

• updatedAt[gt] string

  The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"

• executionDate[lte] string

  The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"

• executionDate[lt] string

  The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"

• executionDate[gte] string

  The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"

• executionDate[gt] string

  The date and time in ISO 8601 format. If only the date portion is provided, the time will default to 00:00:00. Example: "2024-11-21T11:54:39.000Z"

Responses

• 200
• 401
• 403

---

OK - The request was processed successfully.

application/json

• Schema
• Example (from schema)

---

Schema

• Array [
• id integer
• currency string
• amount string
• type string

  Possible values: [fee, payin, payout, peer, fx, card]

• executionDate string
• executed boolean
• createdAt string
• updatedAt string
• account integer
• transactionDetailId integernull
• tags string[]
• documents object[]

  Array [

  id string

  name stringnull

  mimeType string

  ]
• ]

[
  {
    "id": "1",
    "currency": "CHF",
    "amount": "100.00",
    "type": "payin",
    "executionDate": "2023-01-01T00:00:00+00:00",
    "executed": true,
    "createdAt": "2023-01-01T00:00:00+00:00",
    "updatedAt": "2023-01-01T00:00:00+00:00",
    "account": 1,
    "transactionDetailId": 1,
    "tags": [
      "tag1",
      "tag2"
    ],
    "documents": [
      {
        "id": 1,
        "name": "document1",
        "mimeType": "application/pdf"
      }
    ]
  }
]

Unauthorised -- Your access token is wrong.

application/json

• Schema
• Example (from schema)

---

Schema

• type string
• title string
• detail string

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

Forbidden -- Access to the requested resource or action is forbidden.

application/json

• Schema
• Example (from schema)

---

Schema

• type string
• title string
• detail string

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

Loading...