Skip to main content
GET
/
v2
/
transaction
/
search
Get transactions list
curl --request GET \
  --url https://api.pgw-sandbox.finventi.com/v2/transaction/search
{
  "meta": {
    "next_page_token": "<string>",
    "previous_page_token": "<string>"
  },
  "result": [
    {
      "amount": 123,
      "creditor_account": "<string>",
      "creditor_bank_bic": "<string>",
      "creditor_name": "<string>",
      "currency_isocode_alphabetic": "<string>",
      "debtor_account": "<string>",
      "debtor_bank_bic": "<string>",
      "debtor_name": "<string>",
      "direction": "OUTBOUND",
      "sepa_msg_id": "<string>",
      "status": "<string>",
      "status_hardvalue": "<string>",
      "transaction_id": 123,
      "type": "<string>",
      "type_id": 123,
      "compensation_amount": 123,
      "creditor_code": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "debtor_code": "<string>",
      "end_to_end_id": "<string>",
      "method": "SEPA",
      "origin_bic": "<string>",
      "origin_name": "<string>",
      "origin_reason_code": "<string>",
      "origin_reason_info": "<string>",
      "parent_trx_amt": 123,
      "parent_trx_id": 123,
      "rtrn_chrgs_amt": 123,
      "sepa_trx_id": "<string>",
      "settlement_date": "2023-12-25",
      "trx_purpose": "<string>",
      "trx_purpose_information": "<string>",
      "trx_purpose_structured_issuer": "<string>",
      "trx_purpose_structured_ref": "<string>",
      "unaccounted_tax_amt": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Query Parameters

next_page_token
string

A pagination token for fetching the next page of results.

previous_page_token
string

A pagination token for fetching the previous page of results.

limit
string

A limit on the number of objects to be returned. Default is 10 items.

transaction_id
string

A filter by transaction ID.

debtor_bank_code
string

A filter by debtor bank code.

creditor_bank_code
string

A filter by creditor bank code.

datetime_from
string

A filter by transaction datetime from (ISO-8601 format: 2020-01-01T12:00:00Z).

datetime_to
string

A filter by transaction datetime from (ISO-8601 format: 2020-01-01T12:00:00Z).

settlement_date_from
string

A filter by settlement date from or equal (ISO-8601 format: 2020-01-01).

settlement_date_to
string

A filter by settlement date to or equal (ISO-8601 format: 2020-01-01).

end_to_end_id
string

A filter by endToEnd ID.

method
enum<string>

A filter by transaction method. Multiple values are supported e.g. schema=SEPA&schema=INST

Available options:
SEPA,
INST,
SDD,
SWIFT
direction
enum<string>

A filter by direction of transactions.

Available options:
OUTBOUND,
INBOUND
parent_trx_id
string

A filter by Parent Transaction ID.

type_id
string

A filter by transaction Type ID. List of available Type IDs can be retrieved via /getTransactionTypes

amount_from
string

A filter by amount (cents) from or equal.

amount_to
string

A filter by amount (cents) to or equal.

unaccounted_tax_amount_from
string

A filter by unaccounted tax amount (cents) from or equal.

unaccounted_tax_amount_to
string

A filter by unaccounted tax amount (cents) to or equal.

compensation_amount_from
string

A filter by compensation amount (cents) from or equal.

compensation_amount_to
string

A filter by compensation amount (cents) to or equal.

debtor_account
string

A filter by debtor account.

creditor_account
string

A filter by creditor account.

statuses[]
string

A filter by transaction Status ID. List of available Status IDs can be retrieved via /getTransactionStatuses

sort
string
required

A sort by datetime, transaction_id fields. Multiple values are not accepted. Example values: datetime,asc; transaction_id,desc

Response

Returned payments list

meta
object
required

Result metadata.

result
object[]
required

List of found transactions for provided filters.