GetTransactionsResponse

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

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

shopper objectnullable

Information about the shopper or payee.

namestringnullable

Name of the buyer.

Example: Marvin Acme

emailstringnullable

E-mail address of the buyer.

Example: marvin@example.com

usernamestringnullable

E-mail address of the buyer.

Example: macme123

identifierstringnullable

Identifier/customer number of the buyer.

Example: c00001

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

reportIdstringnullable

Report ID

Example: 8fkjh5hr

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

GetTransactionsResponse

{
  "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",
      "shopper": {
        "name": "Marvin Acme",
        "email": "marvin@example.com",
        "username": "macme123",
        "identifier": "c00001"
      },
      "createdAt": "2021-10-01T05:15:15.111",
      "lastModifiedAt": "2021-10-01T05:15:15.111",
      "reportId": "8fkjh5hr",
      "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
  }
}