Skip to main content

TransactionDeprecated

idstringnullable

Transaction ID

Example: 7hrt3c
bookingDatedate-time

Booking date

Example: 2021-10-01
valueDatedate-timenullable

Value date

Example: 2021-10-01
gross objectnullable

Gross amount

currencystringrequired

Currency

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

Example: EUR
valuedoublerequired

Amount value

Example: 15.12
net objectnullable

Net amount

currencystringrequired

Currency

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

Example: EUR
valuedoublerequired

Amount value

Example: 15.12
fee objectnullable

Fee

currencystringrequired

Currency

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

Example: EUR
valuedoublerequired

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
createdAtdate-time

Transaction creation date and time

Example: 2021-10-01T05:15:15.111
lastModifiedAtdate-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
firstElementDatedate-time

First element date

Example: 2022-03-24T10:01:01.000
lastElementDatedate-timenullable

Last element date

Example: 2022-03-24T10:01:01.000
periodStartDatedate-timenullable

Period start date

Example: 2022-03-24T10:01:01.000
periodEndDatedate-timenullable

Period end date

Example: 2022-03-24T10:01:01.000
depositDatedate-timenullabledeprecated

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
valuedoublerequired

Amount value

Example: 15.12
fields objectnullable

Additional transaction fields.

TransactionDeprecated
{
"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"
}
}