Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Settlement Accounts

Get settlement account transactions

The GET /virtual-accounts/{accountId}/transactions endpoint retrieves transcation information in a given settlement account.

get/virtual-accounts/{accountId}/transactions

Path parameters

accountIdstring required

The system-generated, unique id which specifies the settlement account.

Query parameters

limitinteger

The maximum number of records to return. <br/>The maximum allowed limit is 200. If the passed limit is bigger than this, it will be set to 200.

offsetstring

The offset for the current page. The offset is not required to fetch the first page. To fetch subsequent pages, use the 'nextOffset' value from the previous page response. <br/>The offset value should not be parsed and/or understood in any way.

refIdstring

Filters transactions by their refId value - returns only transactions with refId mentioned in the reference.

startDatestring

Returns transactions created on or after this date, inclusive (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).

endDatestring

Returns transactions created on or before this date, inclusive (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).

amountstring

Filters transactions by their transaction amount.

providerPaymentIdstring

Filters transactions by the provider-payment-id.

transactionType'INVALID_TYPE' | 'DEBIT' | 'CREDIT'

Specifies the type of transaction.

Filters transactions by type to include only CREDIT or DEBIT transactions.

onBehalfOfIdstring

Filters payments by the onBehalfOfId value - returns only payments with onBehalfOfId specified in this parameter. This field is mandatory for unregulated TPPs.

Response

Successful response

Example response

{
  "pageInfo": {
    "limit": 20,
    "offset": "LerV6Jmex",
    "nextOffset": "KgwG8Qkat"
  },
  "transactions": [
    {
      "amount": {
        "currency": "EUR",
        "value": "10.23"
      },
      "providerPaymentId": "83KiRJuXm",
      "createdDateTime": "2017-04-05T10:43:07.000+00:00",
      "description": "Payment",
      "localInstrument": "SEPA_INSTANT",
      "debtor": {
        "iban": "GB29NWBK60161331926819",
        "bic": "BOFIIE2D",
        "address": {
          "addressLine": [
            "The Coach House"
          ],
          "streetName": "221B",
          "buildingNumber": "2C",
          "postCode": "TR26 1EZ",
          "townName": "Saint Ives",
          "state": "Cornwall",
          "country": "GB"
        }
      },
      "creditor": {
        "iban": "GB29NWBK60161331926819",
        "bic": "BOFIIE2D",
        "name": "Customer Inc.",
        "ultimateCreditorName": "Customer Inc.",
        "address": {
          "addressLine": [
            "The Coach House"
          ],
          "streetName": "221B",
          "buildingNumber": "2C",
          "postCode": "TR26 1EZ",
          "townName": "Saint Ives",
          "state": "Cornwall",
          "country": "GB"
        }
      },
      "refId": "9htio4a1sp2akdr1aa"
    }
  ]
}