Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB
Transactions

List transactions

Returns a list of transactions. For further details on Pagination, see general section above.

get/financial-data/v2/transactions

Query parameters

accountIdstring
Example:31d593d7-fff9-4783-aa1d-92acb7b21a19

Include only transactions associated with a given account.

reconciliationStatus'RECONCILED' | 'PARTIALLY_RECONCILED' | 'NOT_RECONCILED'

Specifies whether the transaction have been reconciled against a payment or an expected transaction.

Example:RECONCILED

Include only transactions with the given reconciliation status.

string date

Include only transactions with date equal to the given value.

OR
Example:2022-01-15

Include only transactions with property date matching the given value. The parameter value may be either a string for equality matching, or an object for range-like matching criteria.

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Response

List of transactions.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "accountId": "31d593d7-fff9-4783-aa1d-92acb7b21a19",
      "date": "2022-05-07",
      "amount": {
        "currency": "EUR",
        "stringValue": "15.02",
        "value": 1502
      },
      "reference": "invoice-2022-05-03-012345",
      "references": {
        "mandateReference": "123456",
        "endToEndId": "123456",
        "bankTransactionReference": "123456"
      },
      "reconciliationStatus": "RECONCILED",
      "counterparty": {
        "partyType": "INDIVIDUAL",
        "name": "Customer #312",
        "nationalIdentifier": {
          "type": "CIVIC",
          "market": "DE",
          "number": "2012121212"
        },
        "address": {
          "country": "DE",
          "countrySubdivision": "US-CA",
          "city": "Stockholm",
          "postalCode": "11111",
          "streetName": "Example street",
          "streetNumber": "47"
        },
        "account": {
          "market": "DE",
          "identifiers": [
            {
              "type": "IBAN",
              "market": "DE",
              "number": "DE75512108001245126199"
            }
          ],
          "routing": [
            {
              "type": "BIC",
              "number": "BUKBGB22"
            }
          ]
        }
      },
      "description": "Invoice #123",
      "instructedAmount": {
        "currency": "EUR",
        "stringValue": "15.02",
        "value": 1502
      },
      "bankTransactionCode": {
        "domain": "PMNT",
        "family": "IDDT",
        "subfamily": "ESCT",
        "description": "SEPA Credit Transfer"
      },
      "valueDate": "2022-05-07",
      "returnReason": {
        "originalBankTransactionCode": {
          "domain": "PMNT",
          "family": "IDDT",
          "subfamily": "ESCT",
          "description": "SEPA Credit Transfer"
        }
      },
      "currencyExchange": {
        "sourceCurrency": "EUR",
        "targetCurrency": "SEK",
        "unitCurrency": "EUR",
        "exchangeRate": "11.21320"
      },
      "charges": [
        {
          "amount": {
            "currency": "EUR",
            "stringValue": "15.02",
            "value": 1502
          },
          "type": "BATCH",
          "chargeBearer": "SHARED",
          "included": "INCLUDED"
        }
      ],
      "virtualAccount": {
        "market": "DE",
        "identifiers": [
          {
            "type": "IBAN",
            "market": "DE",
            "number": "DE75512108001245126199"
          }
        ],
        "routing": [
          {
            "type": "BIC",
            "number": "BUKBGB22"
          }
        ]
      },
      "batchInformation": {
        "transactionCount": 10,
        "totalAmount": {
          "value": 100000,
          "stringValue": "1000.00",
          "currency": "EUR"
        }
      },
      "attachedTransactables": [
        {
          "type": "CREDIT_TRANSFER",
          "id": "1828d825-3f40-48c2-9b3b-07017ff887cc"
        }
      ],
      "internalTransfer": {
        "internalTransferId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
        "counterpartTransactionId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
        "counterpartAccountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
      },
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z",
      "version": 1,
      "etag": "version:3",
      "metadata": {
        "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
      }
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}