Transaction Lookup History
Returns filtered lookup records for a given merchant. Requires a valid JWT token. The merchantId in the path must match one of the associated merchants from the token.
Authorizations
Path parameters
merchantIdstringRequiredExample:
Merchant ID to query lookup history for
merchant123
Body
sortFieldstringOptionalExample:
lookupDate
orderstring · enumOptionalExample:
DESC
Possible values: valuestring[]OptionalExample:
Values to compare against each field
, matched by index.
For example, value[0] applies to field[0] using operator[0].
["123456","verifi"]
operatorstring[]OptionalExample:
Operators used for each filter condition. Must match the field
and value
array indexes.
["like","="]
dateFromstring · date-timeOptionalExample:
2024-01-01T00:00:00.000Z
dateTostring · date-timeOptionalExample:
2024-12-31T23:59:59.999Z
Responses
200
Successful response with list of lookups
application/json
400
Bad Request - Missing merchantId or invalid format
application/json
403
Forbidden - Token not authorized for this merchant
application/json
500
Internal Server Error
application/json
post
POST /merchant/{merchantId}/lookupHistory HTTP/1.1
Host: {baseurl}
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 340
"{\n \"field\": [ \"provider\", \"txShieldOICartReference\" ],\n \"value\": [ \"verify\", \"439bae96-8c52-49d7-9560-8a8e5db6714\" ],\n \"operator\": [ \"=\", \"LIKE\" ],\n \"dateFrom\": \"2025-02-28T02:03:39.852Z\",\n \"dateTo\": \"2025-05-30T02:03:39.852Z\",\n \"order\": \"DESC\",\n \"sortField\": \"txShieldOICartReference\"\n}\n"
{
"datalist": [
{
"_id": "text",
"txShieldOICartReference": "text",
"provider": "text",
"service": "text",
"lookupReference": "text",
"cardBin": "text",
"cardLast4": "text",
"transactionDate": "2025-06-23T19:11:42.092Z",
"lookupDate": "2025-06-23T19:11:42.092Z",
"receivedData": {
"source": "text",
"cardBin": "text",
"cardLast4": "text",
"transactionDate": "2025-06-23T19:11:42.092Z",
"transactionAmount": {
"amount": 1,
"currency": "text"
},
"authCode": "text",
"terminalId": "text",
"cardAcceptorId": "text",
"transactionId": "text",
"transactionType": "text",
"paymentDescriptor": "text",
"paymentDescriptorContact": "text",
"acquirerBin": "text",
"mcc": "text",
"verifiEntityInfo": {
"partnerId": 1,
"clientId": 1
},
"transactionRequestId": "text",
"paymentType": "text",
"insightId": "text",
"purchaseIdentifier": "text"
},
"returnData": {
"receipt": {
"paymentInformation": {
"paymentTotalAmount": {
"amount": 1,
"currency": "text"
}
},
"productsPurchasedList": [
{
"productDescription": "text",
"unitPriceAmount": {
"amount": 1,
"currency": "text"
},
"quantity": 1
}
]
},
"merchantInformation": {
"merchantName": "text",
"merchantUrl": "text",
"merchantContactPhone": "text",
"storeDetails": {
"storeName": "text"
}
},
"customerInformation": {
"accountId": "text"
},
"deliveryAddress": {
"address1": "text",
"address2": "text",
"city": "text",
"region": "text",
"postalCode": "text",
"country": "text"
},
"device": {
"ipAddress": "text"
}
},
"errorMessage": "text",
"merchantCart": [
{
"_id": "text",
"txShieldOICartReference": "text",
"transactionDate": "2025-06-23T19:11:42.092Z",
"cardBin": "text",
"cardLast4": "text",
"amount": 1,
"currency": "text",
"paymentDescriptor": "text",
"merchantId": "text",
"dateCreated": "2025-06-23T19:11:42.092Z",
"email": "text",
"alertHappened": true,
"alertReference": "text",
"chargebackHappened": true,
"chargebackReference": "text"
}
],
"merchantId": "text",
"merchantName": "text"
}
],
"total": 1
}
Last updated