Get transactions list

Search payments

curl --request GET \
  --url https://api.pgw-sandbox.finventi.com/v3/payments

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pgw-sandbox.finventi.com/v3/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pgw-sandbox.finventi.com/v3/payments"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.pgw-sandbox.finventi.com/v3/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "amount": 100,
      "createdAt": "2023-11-07T05:31:56Z",
      "creditor": {
        "account": {
          "iban": "<string>",
          "other": {
            "id": "<string>",
            "issuer": "<string>",
            "scheme": {
              "code": "<string>",
              "proprietary": "<string>"
            }
          }
        },
        "agent": {
          "bic": "DEMOLT1XXXX",
          "name": "<string>"
        },
        "address": {
          "country": "LT",
          "line": "<string>",
          "structured": {
            "buildingName": "<string>",
            "buildingNumber": "<string>",
            "countrySubDivision": "<string>",
            "department": "<string>",
            "districtName": "<string>",
            "floor": "<string>",
            "postBox": "<string>",
            "postCode": "<string>",
            "room": "<string>",
            "street": "<string>",
            "subDepartment": "<string>",
            "townLocationName": "<string>"
          },
          "town": "Vilnius"
        },
        "name": "<string>",
        "organisationIdentification": {
          "otherIdentifications": [
            {
              "id": "<string>",
              "issuer": "<string>",
              "scheme": {
                "code": "<string>",
                "proprietary": "<string>"
              }
            }
          ],
          "bic": "<string>",
          "lei": "<string>"
        },
        "privateIdentification": {
          "otherIdentifications": [
            {
              "id": "<string>",
              "issuer": "<string>",
              "scheme": {
                "code": "<string>",
                "proprietary": "<string>"
              }
            }
          ],
          "birthInformation": {
            "city": "<string>",
            "country": "<string>",
            "date": "<string>",
            "province": "<string>"
          }
        }
      },
      "currency": "EUR",
      "debtor": {
        "account": {
          "iban": "<string>",
          "other": {
            "id": "<string>",
            "issuer": "<string>",
            "scheme": {
              "code": "<string>",
              "proprietary": "<string>"
            }
          }
        },
        "agent": {
          "bic": "DEMOLT1XXXX",
          "name": "<string>"
        },
        "address": {
          "country": "LT",
          "line": "<string>",
          "structured": {
            "buildingName": "<string>",
            "buildingNumber": "<string>",
            "countrySubDivision": "<string>",
            "department": "<string>",
            "districtName": "<string>",
            "floor": "<string>",
            "postBox": "<string>",
            "postCode": "<string>",
            "room": "<string>",
            "street": "<string>",
            "subDepartment": "<string>",
            "townLocationName": "<string>"
          },
          "town": "Vilnius"
        },
        "name": "<string>",
        "organisationIdentification": {
          "otherIdentifications": [
            {
              "id": "<string>",
              "issuer": "<string>",
              "scheme": {
                "code": "<string>",
                "proprietary": "<string>"
              }
            }
          ],
          "bic": "<string>",
          "lei": "<string>"
        },
        "privateIdentification": {
          "otherIdentifications": [
            {
              "id": "<string>",
              "issuer": "<string>",
              "scheme": {
                "code": "<string>",
                "proprietary": "<string>"
              }
            }
          ],
          "birthInformation": {
            "city": "<string>",
            "country": "<string>",
            "date": "<string>",
            "province": "<string>"
          }
        }
      },
      "endToEndId": "<string>",
      "id": 10300007,
      "metadata": [
        "<string>"
      ],
      "scheme": "SEPA_CT",
      "status": "COMPLETED",
      "type": "PAYMENT",
      "parentPaymentId": 123,
      "settlementDate": "2023-12-25"
    }
  ],
  "meta": {
    "nextPageToken": "<string>",
    "previousPageToken": "<string>"
  }
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

GET

payments

Search payments

curl --request GET \
  --url https://api.pgw-sandbox.finventi.com/v3/payments

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pgw-sandbox.finventi.com/v3/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pgw-sandbox.finventi.com/v3/payments"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.pgw-sandbox.finventi.com/v3/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "amount": 100,
      "createdAt": "2023-11-07T05:31:56Z",
      "creditor": {
        "account": {
          "iban": "<string>",
          "other": {
            "id": "<string>",
            "issuer": "<string>",
            "scheme": {
              "code": "<string>",
              "proprietary": "<string>"
            }
          }
        },
        "agent": {
          "bic": "DEMOLT1XXXX",
          "name": "<string>"
        },
        "address": {
          "country": "LT",
          "line": "<string>",
          "structured": {
            "buildingName": "<string>",
            "buildingNumber": "<string>",
            "countrySubDivision": "<string>",
            "department": "<string>",
            "districtName": "<string>",
            "floor": "<string>",
            "postBox": "<string>",
            "postCode": "<string>",
            "room": "<string>",
            "street": "<string>",
            "subDepartment": "<string>",
            "townLocationName": "<string>"
          },
          "town": "Vilnius"
        },
        "name": "<string>",
        "organisationIdentification": {
          "otherIdentifications": [
            {
              "id": "<string>",
              "issuer": "<string>",
              "scheme": {
                "code": "<string>",
                "proprietary": "<string>"
              }
            }
          ],
          "bic": "<string>",
          "lei": "<string>"
        },
        "privateIdentification": {
          "otherIdentifications": [
            {
              "id": "<string>",
              "issuer": "<string>",
              "scheme": {
                "code": "<string>",
                "proprietary": "<string>"
              }
            }
          ],
          "birthInformation": {
            "city": "<string>",
            "country": "<string>",
            "date": "<string>",
            "province": "<string>"
          }
        }
      },
      "currency": "EUR",
      "debtor": {
        "account": {
          "iban": "<string>",
          "other": {
            "id": "<string>",
            "issuer": "<string>",
            "scheme": {
              "code": "<string>",
              "proprietary": "<string>"
            }
          }
        },
        "agent": {
          "bic": "DEMOLT1XXXX",
          "name": "<string>"
        },
        "address": {
          "country": "LT",
          "line": "<string>",
          "structured": {
            "buildingName": "<string>",
            "buildingNumber": "<string>",
            "countrySubDivision": "<string>",
            "department": "<string>",
            "districtName": "<string>",
            "floor": "<string>",
            "postBox": "<string>",
            "postCode": "<string>",
            "room": "<string>",
            "street": "<string>",
            "subDepartment": "<string>",
            "townLocationName": "<string>"
          },
          "town": "Vilnius"
        },
        "name": "<string>",
        "organisationIdentification": {
          "otherIdentifications": [
            {
              "id": "<string>",
              "issuer": "<string>",
              "scheme": {
                "code": "<string>",
                "proprietary": "<string>"
              }
            }
          ],
          "bic": "<string>",
          "lei": "<string>"
        },
        "privateIdentification": {
          "otherIdentifications": [
            {
              "id": "<string>",
              "issuer": "<string>",
              "scheme": {
                "code": "<string>",
                "proprietary": "<string>"
              }
            }
          ],
          "birthInformation": {
            "city": "<string>",
            "country": "<string>",
            "date": "<string>",
            "province": "<string>"
          }
        }
      },
      "endToEndId": "<string>",
      "id": 10300007,
      "metadata": [
        "<string>"
      ],
      "scheme": "SEPA_CT",
      "status": "COMPLETED",
      "type": "PAYMENT",
      "parentPaymentId": 123,
      "settlementDate": "2023-12-25"
    }
  ],
  "meta": {
    "nextPageToken": "<string>",
    "previousPageToken": "<string>"
  }
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

Query Parameters

limit

integer<int32>

Maximum number of payments returned per page. The default is 10 and the maximum is 100.

Required range: 1 <= x <= 100

nextPageToken

string

Cursor token for fetching the next page of payments.

previousPageToken

string

Cursor token for fetching the previous page of payments.

integer<int64>

Filter by payment identifier.

Example:

10300007

debtorBankCode

string

Filter by debtor agent BIC.

Example:

"LUNALT22XXX"

creditorBankCode

string

Filter by creditor agent BIC.

Example:

"NOVALT22XXX"

datetimeFrom

string<date-time>

Filter payments created at or after this UTC timestamp.

Example:

"2026-01-01T00:00:00Z"

datetimeTo

string<date-time>

Filter payments created at or before this UTC timestamp.

Example:

"2026-01-31T23:59:59Z"

settlementDateFrom

string<date>

Filter payments with a settlement date on or after this date.

Example:

"2026-01-01"

settlementDateTo

string<date>

Filter payments with a settlement date on or before this date.

Example:

"2026-01-31"

endToEndId

string

Filter by the end-to-end identifier assigned by the originator.

metadata

string

Filter by an exact client-defined metadata value.

method

enum<string>

Filter by one or more payment methods.

Available options:

SEPA,

INST,

SDD,

SWIFT,

T2

direction

enum<string>

Filter by payment direction.

Available options:

OUTBOUND,

INBOUND

parentPaymentId

integer<int64>

Filter by parent payment identifier.

idOrParentPaymentId

integer<int64>

Filter by a payment identifier or its parent payment identifier.

typeId

integer<int32>

Filter by transaction type identifier. Available identifiers can be retrieved from /getTransactionTypes.

statusIds

integer<int32>[]

Filter by transaction status identifiers. Available identifiers can be retrieved from /getTransactionStatuses.

currency

string

ISO 4217 currency used both as a filter and for interpreting all amount range parameters. Defaults to EUR for amount interpretation.

Pattern: ^[A-Z]{3}$

Example:

"EUR"

amountFrom

integer

Minimum payment amount in minor units of currency, inclusive.

Example:

100

amountTo

integer

Maximum payment amount in minor units of currency, inclusive.

Example:

10000

unaccountedTaxAmountFrom

integer

Minimum unaccounted tax amount in minor units of currency, inclusive.

unaccountedTaxAmountTo

integer

Maximum unaccounted tax amount in minor units of currency, inclusive.

compensationAmountFrom

integer

Minimum compensation amount in minor units of currency, inclusive.

compensationAmountTo

integer

Maximum compensation amount in minor units of currency, inclusive.

debtorAccount

string

Filter by debtor account identifier.

creditorAccount

string

Filter by creditor account identifier.

excludePaymentReturns

boolean

Exclude payments that have an existing non-rejected payment return.

Response

Payments returned successfully

data

object[]

required

Payment list items matching the supplied filters, ordered by payment identifier descending.

Show child attributes

Getting Started

Integration Guide

Account Management

SEPA Instant/SCT

SEPA Direct Debit

SWIFT Payments

Payment Information

Investigations (Preview)

Nostro Accounts

Bank Information

Webhooks

Query Parameters

Response