Skip to main content

GetTransactionsDeprecatedResponse

transactions object[]nullable

Array of transactions

  • Array [
  • idstringnullable

    Transaction ID

    Example: 7hrt3c
    bookingDatestring<date-time>

    Booking date

    Example: 2021-10-01
    valueDatestring<date-time>nullable

    Value date

    Example: 2021-10-01
    gross objectnullable

    Gross amount

    currencystringrequired

    Currency

    Possible values: >= 3 characters and <= 3 characters

    Example: EUR
    valuenumber<double>required

    Amount value

    Example: 15.12
    net objectnullable

    Net amount

    currencystringrequired

    Currency

    Possible values: >= 3 characters and <= 3 characters

    Example: EUR
    valuenumber<double>required

    Amount value

    Example: 15.12
    fee objectnullable

    Fee

    currencystringrequired

    Currency

    Possible values: >= 3 characters and <= 3 characters

    Example: EUR
    valuenumber<double>required

    Amount value

    Example: 15.12
    isBalanceRelevantboolean

    Whether the transaction is balance relevant or not

    Example: true
    paymentClassificationPaymentClassification (string)

    Payment classification - is similar to Payment type, probably only one of them should remain

    Possible values: [Unknown, Payment, Refund, Chargeback, Purchase, PurchaseRefund, ServiceFee, ServiceFeeRefund, Transfer, Payout, TemporaryHold, Review, Reserve, CurrencyConversion, CreditRepayment, Tax, Adjustment, Donation, Unclassified]

    Example: Payment
    transactionIdstringnullable

    Transaction ID from the payment provider

    Example: 75123478-d4ab-4fab-a177-53fbbe1b1234
    orderNumberstringnullable

    Order number

    Example: 123e4d56
    receiptNumberstringnullable

    Receipt number

    Example: AB86C03D-0379
    bookingTextstringnullable

    Booking text

    Possible values: <= 500 characters

    Example: Description of the booking
    createdAtstring<date-time>

    Transaction creation date and time

    Example: 2021-10-01T05:15:15.111
    lastModifiedAtstring<date-time>

    Last transaction modification date and time

    Example: 2021-10-01T05:15:15.111
    report objectnullable

    Report info

    idstringnullable

    Report ID

    Example: 8fkjh5hr
    namestringnullable

    Report name

    Example: Payment report
    firstElementDatestring<date-time>

    First element date

    Example: 2022-03-24T10:01:01.000
    lastElementDatestring<date-time>nullable

    Last element date

    Example: 2022-03-24T10:01:01.000
    periodStartDatestring<date-time>nullable

    Period start date

    Example: 2022-03-24T10:01:01.000
    periodEndDatestring<date-time>nullable

    Period end date

    Example: 2022-03-24T10:01:01.000
    depositDatestring<date-time>nullabledeprecated

    Deposit date

    Obsolete. Use Reports Controller instead

    Example: 2022-03-24T00:00:00.000
    amount objectnullabledeprecated

    Report amount

    Obsolete. Use Reports Controller instead

    currencystringrequired

    Currency

    Possible values: >= 3 characters and <= 3 characters

    Example: EUR
    valuenumber<double>required

    Amount value

    Example: 15.12
    fields objectnullable

    Additional transaction fields.

  • ]
  • pagination objectnullable

    Pagination info

    pageNumberinteger<int32>

    Returned page number

    Example: 1
    previousPageReferencestringnullable

    Reference to get the previous page

    nextPageReferencestringnullable

    Reference to get the next page

    previousPagestring<uri>nullable

    URL of the previous page

    nextPagestring<uri>nullable

    URL of the next page

    pageSizeinteger<int32>

    Number of items per page

    Example: 25
    pagesCountinteger<int32>nullable

    Total number of pages

    Example: 5
    totalCountinteger<int32>

    Total number of items

    Example: 125
    GetTransactionsDeprecatedResponse
    {
    "transactions": [
    {
    "id": "7hrt3c",
    "bookingDate": "2021-10-01",
    "valueDate": "2021-10-01",
    "gross": {
    "currency": "EUR",
    "value": 15.12
    },
    "net": {
    "currency": "EUR",
    "value": 15.12
    },
    "fee": {
    "currency": "EUR",
    "value": 15.12
    },
    "isBalanceRelevant": true,
    "paymentClassification": "Payment",
    "transactionId": "75123478-d4ab-4fab-a177-53fbbe1b1234",
    "orderNumber": "123e4d56",
    "receiptNumber": "AB86C03D-0379",
    "bookingText": "Description of the booking",
    "createdAt": "2021-10-01T05:15:15.111",
    "lastModifiedAt": "2021-10-01T05:15:15.111",
    "report": {
    "id": "8fkjh5hr",
    "name": "Payment report",
    "firstElementDate": "2022-03-24T10:01:01.000",
    "lastElementDate": "2022-03-24T10:01:01.000",
    "periodStartDate": "2022-03-24T10:01:01.000",
    "periodEndDate": "2022-03-24T10:01:01.000"
    },
    "fields": {
    "uniqueId": "PO0002TDV7Y0TM-PM001A5N178VDS-PaymentPaidOut-0",
    "reference2": "298347562384756298743"
    }
    }
    ],
    "pagination": {
    "pageNumber": 1,
    "previousPageReference": "string",
    "nextPageReference": "string",
    "previousPage": "string",
    "nextPage": "string",
    "pageSize": 25,
    "pagesCount": 5,
    "totalCount": 125
    }
    }