List transactions overview

GET 
/Transactions/TransactionsOverview

List transactions overview

Request

Query Parameters

page int32

Possible values: >= 1 and <= 2147483647

The 1-based page number for paginated results.

count int32

Possible values: >= 1 and <= 50

The number of items to return per page (1–50).

sortByProperty string

The property name to sort results by.

sortByAscending boolean

When true, sorts results in ascending order; descending otherwise.

searchValues object

Key-value pairs used to filter results.

findCodeToIncludeInPage string

A specific code to locate; the page containing it will be returned.

searchHistoricData boolean

When true, includes soft-deleted or historical records in the results.

Responses

200

A collection of transactions for the specified page.

application/json

Schema

Schema

page int32required

The current page number in the paginated result set.

count int32required

The number of items returned on this page.

hasNextPage booleanrequired

Indicates whether additional pages of results are available after the current page.

hasPreviousPage booleanrequired

Indicates whether pages of results exist before the current page.

totalCount int32required

The total number of items across all pages.

totalPages int32required

The total number of pages available.

items object[]nullable
The collection of items returned for the current page.
Array [
transCode stringnullablerequired
The unique code identifying the transaction.
transType stringnullablerequired
The display name of the transaction type.
transBranch stringnullablerequired
The display name of the branch where the transaction was processed.
transDate date-timenullablerequired
The date and time when the transaction occurred.
transReversed booleanrequired
Indicates whether the transaction has been reversed.
amlTransId uuidnullablerequired
The unique AML transaction identifier (UUID).
transCommited booleanrequired
Indicates whether the transaction has been committed (finalized).
beneficiaryCustomerCode stringnullablerequired
The unique code of the beneficiary customer.
beneficiaryCustomerFirstName stringnullablerequired
The first name of the beneficiary customer.
beneficiaryCustomerLastName stringnullablerequired
The last name of the beneficiary customer.
originatorCustomerCustomerCode stringnullablerequired
The unique code of the originator customer.
originatorCustomerFirstName stringnullablerequired
The first name of the originator customer.
originatorCustomerLastName stringnullablerequired
The last name of the originator customer.
carrierCustomerCustomerCode stringnullablerequired
The unique code of the carrier customer.
carrierCustomerFirstName stringnullablerequired
The first name of the carrier customer.
carrierCustomerLastName stringnullablerequired
The last name of the carrier customer.
]

Example (from schema)

{
  "page": 0,
  "count": 0,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "totalCount": 0,
  "totalPages": 0,
  "items": [
    {
      "transCode": "string",
      "transType": "string",
      "transBranch": "string",
      "transDate": "2024-07-29T15:51:28.071Z",
      "transReversed": true,
      "amlTransId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transCommited": true,
      "beneficiaryCustomerCode": "string",
      "beneficiaryCustomerFirstName": "string",
      "beneficiaryCustomerLastName": "string",
      "originatorCustomerCustomerCode": "string",
      "originatorCustomerFirstName": "string",
      "originatorCustomerLastName": "string",
      "carrierCustomerCustomerCode": "string",
      "carrierCustomerFirstName": "string",
      "carrierCustomerLastName": "string"
    }
  ]
}

400

The page request parameters are invalid.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

404

A page with the specified page number was not found.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

406

Incorrect JSON format.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...