Introduction
A Transaction represents a single transaction in relation to a Payment.
Endpoints
GET /transactions?pageNumber={x}&pageSize={y}&startDate={yyyy-mm-dd}&endDate={yyyy-mm-dd}
Get a list of Transactions at a given size by a given offset and date limitation.
Response
|
HTTP |
Description |
|---|---|
|
200 |
OK |
HTTP 200 Example
{
"pageNumber": 1,
"pageSize": 50,
"startDate": "yyyy-mm-dd",
"endDate": "yyyy-mm-dd",
"list": [
{
"transactionGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
"...": "..."
},
{
"transactionGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
"...": "..."
}
]
}
GET /transaction/{guid}
Get a single Transaction.
Response
|
HTTP |
Description |
|---|---|
|
200 |
OK |
|
404 |
Transaction not found |
HTTP 200 Example
{
"transactionGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
"createdTs": "2019-12-31 15:59:59 +0100",
"paymentGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
"amount": 100,
"paymentGatewayProvider": "ePay",
"paymentGatewayGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
"paymentGatewaySubscriptionReferenceId": "xxxxxxxxxxxx",
"paymentGatewayPaymentReferenceId": "xxxxxxxxxxxx",
"transactionTs": "2019-12-31 15:59:59 +0100",
"transactionType": "Charge",
"paymentMethodAccountingCode": "donation",
"chargeAttemptGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
"paymentMethodGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx"
}Schema
| Property | Format and Description |
| transactionGuid | string <uuid>
Unique Guid |
| createdTs | string <yyyy-MM-dd HH:mm:ss zzzz>
Timestamp of creation |
| paymentGuid | string <uuid>
Unique Guid |
| amount | number
Summarized amount excluding VAT |
| paymentGatewayProvider | string
Payment gateway provider
|
| paymentGatewayGuid | string <uuid> Unique Guid |
| paymentGatewaySubscriptionReferenceId | string Subscription token in gateway |
| paymentGatewayPaymentReferenceId | string Payment token at Payment Gateway |
| transactionTs | string <yyyy-MM-dd HH:mm:ss zzzz> Timestamp of transaction |
| transactionType | string Type of transaction Enum: "Charge", "Refund" |
| paymentMethodAccountingCode | string Accounting provided by Payment Method |
| chargeAttemptGuid | string <uuid> Unique Guid |
| paymentMethodGuid | string <uuid> Unique Guid |
Example
{
"transactionGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
"createdTs": "2019-12-31 15:59:59 +0100",
"paymentGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
"amount": 100,
"paymentGatewayProvider": "ePay",
"paymentGatewayGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
"paymentGatewaySubscriptionReferenceId": "xxxxxxxxxxxx",
"paymentGatewayPaymentReferenceId": "xxxxxxxxxxxx",
"transactionTs": "2019-12-31 15:59:59 +0100",
"transactionType": "Charge",
"paymentMethodAccountingCode": "donation",
"chargeAttemptGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx",
"paymentMethodGuid": "a863d62e-d53b-4651-9b7b-xxxxxxxxxxxx"
}