List All Transaction Events
- 19 Dec 2023
- 1 Minute to read
- Print
- DarkLight
List All Transaction Events
- Updated on 19 Dec 2023
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
This will return all the transaction events.
POST - /api/v1/query
query getVisibleTransactions
(
$startDate: String!, $endDate: String!, $sort: TransactionSort!,
$page: Int, $size: Int
)
{
events
(
from: $startDate,
to: $endDate,
visible: true,
sort: $sort,
excludeType: [
"DISPUTE_RECEIVED", "DISPUTE_APPLIED", "DISPUTE_REVERSED",
"DISPUTE_CANCELLED"
],
page: $page,
size: $size
)
{
transactionEventList {
id
eventId
ownerId
eventType
summary {
visible
type
status
}
customer {
name
}
paymentMethod
{
providerResponse {
methodUsed
}
card {
cardScheme
}
}
transaction {
transactionId
receivedDateTime
amount
description
merchantReference
currency
}
}
totalCount
}
}
{
"sort": {
"field": "receivedDateTime",
"direction": "DESC"
},
"startDate": "1899-12-31T22:15:36.000Z",
"endDate": "2022-11-05T03:16:26.274Z",
"page": 0,
"size": 10
}
Notes for Request Body: startDate and endDate in request body can be changed by adhering to format: YYYY-MM-DDTHH:MM:SS.sssZ
A HTTP 200 response body will return the following:
{
"errors": [],
"data": {
"events": {
"transactionEventList": [
{
"id": "10008691.2",
"eventId": "2",
"ownerId": "15724887",
"eventType": "REFUND",
"summary": {
"visible": true,
"type": "REFUND",
"status": "SUCCESSFUL"
},
"customer": {
"name": "A Payer",
"emailAddress": "a.customer@test.com",
"address": {
"line1": "Flat 1/A",
"line2": "Princess",
"city": "Manchester",
"postcode": "M1 1BT"
}
},
"paymentMethod": {
"maskedCredentials": "444433******1111",
"providerResponse": {
"methodUsed": "CARD",
"result": "AUTHORISED"
},
"card": {
"cardScheme": "VISA",
"cardType": "CREDIT",
"cardHolderName": "test john",
"expiryYear": "22",
"expiryMonth": "10",
"authCode": "12345"
}
},
"transaction": {
"transactionId": 10008691,
"receivedDateTime": "2022-09-26T04:54:43.550Z",
"amount": 700.0,
"description": "Payment",
"merchantReference": "reference-2809202002",
"channel": "WEB",
"recurring": "INITIAL"
}
}
],
"totalCount": 27
}
},
"extensions": {
"dataloader": {
"overall-statistics": {
"loadCount": 0,
"loadErrorCount": 0,
"loadErrorRatio": 0.0,
"batchInvokeCount": 0,
"batchLoadCount": 0,
"batchLoadRatio": 0.0,
"batchLoadExceptionCount": 0,
"batchLoadExceptionRatio": 0.0,
"cacheHitCount": 0,
"cacheHitRatio": 0.0
},
"individual-statistics": {}
}
},
"dataPresent": true
}
Was this article helpful?