Retrieve a Transaction Event

GET

/events/transaction/:eventId

GET

/events/transaction/:eventId

1 curl https://sandbox.api.flagright.com/events/transaction/eventId \
2      -H "x-api-key: <apiKey>"

Try it

200example-1

1 {
2   "transactionState": "SUCCESSFUL",
3   "timestamp": 1641654664000,
4   "transactionId": "443dea26147a406b957d9ee3a1247b11",
5   "eventId": "eventId",
6   "reason": "reason",
7   "eventDescription": "eventDescription",
8   "updatedTransactionAttributes": {
9     "transactionState": "CREATED",
10     "originAmountDetails": {
11       "transactionAmount": 800,
12       "transactionCurrency": "EUR",
13       "country": "DE"
14     },
15     "destinationAmountDetails": {
16       "transactionAmount": 800,
17       "transactionCurrency": "EUR",
18       "country": "DE"
19     },
20     "originPaymentDetails": {
21       "method": "CARD",
22       "3dsDone": true,
23       "cardAuthenticated": true,
24       "cardBalance": {
25         "amountValue": 800,
26         "amountCurrency": "GBP"
27       },
28       "cardBrand": "VISA",
29       "cardFingerprint": "20ac00fed8ef913aefb17cfae1097cce",
30       "cardFunding": "CREDIT",
31       "cardIssuedCountry": "TR",
32       "cardLast4Digits": "cardLast4Digits",
33       "cardPresent": true,
34       "cardStatus": "ACTIVE",
35       "cardTokenized": true,
36       "cardType": "VIRTUAL",
37       "emailId": "emailId",
38       "nameOnCard": {
39         "firstName": "Baran",
40         "middleName": "Realblood",
41         "lastName": "Ozkan"
42       },
43       "networkProviderRiskScore": 1.1,
44       "paymentChannel": "paymentChannel",
45       "tags": [
46         {
47           "key": "customKey",
48           "value": "customValue"
49         }
50       ],
51       "transactionReferenceField": "Deposit"
52     },
53     "destinationPaymentDetails": {
54       "method": "CARD",
55       "3dsDone": true,
56       "cardAuthenticated": true,
57       "cardBalance": {
58         "amountValue": 800,
59         "amountCurrency": "GBP"
60       },
61       "cardBrand": "VISA",
62       "cardFingerprint": "20ac00fed8ef913aefb17cfae1097cce",
63       "cardFunding": "CREDIT",
64       "cardIssuedCountry": "TR",
65       "cardLast4Digits": "cardLast4Digits",
66       "cardPresent": true,
67       "cardStatus": "ACTIVE",
68       "cardTokenized": true,
69       "cardType": "VIRTUAL",
70       "emailId": "emailId",
71       "nameOnCard": {
72         "firstName": "Baran",
73         "middleName": "Realblood",
74         "lastName": "Ozkan"
75       },
76       "networkProviderRiskScore": 1.1,
77       "paymentChannel": "paymentChannel",
78       "tags": [
79         {
80           "key": "customKey",
81           "value": "customValue"
82         }
83       ],
84       "transactionReferenceField": "Deposit"
85     },
86     "originFundsInfo": {
87       "sourceOfFunds": "sourceOfFunds",
88       "sourceOfWealth": "sourceOfWealth"
89     },
90     "relatedTransactionIds": [
91       "relatedTransactionIds"
92     ],
93     "productType": "productType",
94     "promotionCodeUsed": true,
95     "reference": "reference",
96     "originDeviceData": {
97       "batteryLevel": 1.1,
98       "deviceLatitude": 1.1,
99       "deviceLongitude": 1.1,
100       "ipAddress": "ipAddress",
101       "ipCountry": "AF",
102       "deviceIdentifier": "deviceIdentifier",
103       "vpnUsed": true,
104       "operatingSystem": "operatingSystem",
105       "deviceMaker": "deviceMaker",
106       "deviceModel": "deviceModel",
107       "deviceYear": "deviceYear",
108       "appVersion": "appVersion"
109     },
110     "destinationDeviceData": {
111       "batteryLevel": 1.1,
112       "deviceLatitude": 1.1,
113       "deviceLongitude": 1.1,
114       "ipAddress": "ipAddress",
115       "ipCountry": "AF",
116       "deviceIdentifier": "deviceIdentifier",
117       "vpnUsed": true,
118       "operatingSystem": "operatingSystem",
119       "deviceMaker": "deviceMaker",
120       "deviceModel": "deviceModel",
121       "deviceYear": "deviceYear",
122       "appVersion": "appVersion"
123     },
124     "tags": [
125       {
126         "key": "customKey",
127         "value": "customValue"
128       }
129     ]
130   },
131   "metaData": {
132     "batteryLevel": 1.1,
133     "deviceLatitude": 1.1,
134     "deviceLongitude": 1.1,
135     "ipAddress": "144.13.22.19",
136     "ipCountry": "AF",
137     "deviceIdentifier": "deviceIdentifier",
138     "vpnUsed": true,
139     "operatingSystem": "operatingSystem",
140     "deviceMaker": "deviceMaker",
141     "deviceModel": "deviceModel",
142     "deviceYear": "deviceYear",
143     "appVersion": "appVersion"
144   },
145   "executedRules": [
146     {
147       "ruleInstanceId": "ruleInstanceId",
148       "ruleName": "Proof of funds for high value transactions",
149       "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
150       "ruleAction": "BLOCK",
151       "ruleHit": true,
152       "ruleId": "R-1a",
153       "executedAt": 1.1,
154       "vars": [
155         {
156           "value": {
157             "key": "value"
158           }
159         }
160       ],
161       "labels": [
162         "UNEXPECTED_BEHAVIOR"
163       ],
164       "nature": "AML",
165       "isShadow": true
166     }
167   ],
168   "hitRules": [
169     {
170       "ruleInstanceId": "ruleInstanceId",
171       "ruleName": "Proof of funds for high value transactions",
172       "ruleDescription": "If a user makes a remittance transaction >= 1800 in EUR - ask for proof of funds",
173       "ruleAction": "BLOCK",
174       "ruleId": "R-1a",
175       "executedAt": 1.1,
176       "labels": [
177         "UNEXPECTED_BEHAVIOR"
178       ],
179       "nature": "FRAUD",
180       "isShadow": true
181     }
182   ],
183   "status": "ALLOW",
184   "riskScoreDetails": {
185     "trsScore": 1.1,
186     "trsRiskLevel": "VERY_HIGH",
187     "originUserCraRiskScore": 1.1,
188     "destinationUserCraRiskScore": 1.1,
189     "originUserCraRiskLevel": "VERY_HIGH",
190     "destinationUserCraRiskLevel": "VERY_HIGH"
191   }
192 }

GET Transaction Events

/events/transaction endpoint allows you to operate on the Transaction Events entity..

You can retrieve any transaction event you created using the POST Transaction Events call.

Path parameters

eventIdstringRequired

Unique Transaction Identifier

Response

transactionStateenum

Model for transaction states. E.g. Processing, Refunded, Successful etc.

timestampdouble>=315529200000<=4133890801000

Timestamp of the event

transactionIdstring>=1 character

Transaction ID the event pertains to

eventIdstringOptional

Unique event ID

reasonstringOptional

Reason for the event or a state change

eventDescriptionstringOptional

Event description

updatedTransactionAttributesobjectOptional

Model for transaction additional payload

metaDataobjectOptional

Model for device data

executedRuleslist of objectsOptional

hitRuleslist of objectsOptional

statusenumOptional

Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst

Allowed values:

riskScoreDetailsobjectOptional

Retrieve a Transaction Event

GET Transaction Events

Path parameters

Headers

Response

Errors