Transaction Lookup History

Get merchant lookup history

post

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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

merchantIdstringRequired

Merchant ID to query lookup history for

Example: merchant123

Body

application/json

sortFieldstringOptionalExample: lookupDate

orderstring · enumOptionalExample: DESCPossible values:

valuestring[]Optional

Values to compare against each field, matched by index. For example, value[0] applies to field[0] using operator[0].

Example: ["123456","verifi"]

operatorstring[]Optional

Operators used for each filter condition. Must match the field and value array indexes.

Example: ["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

/merchant/{merchantId}/lookupHistory

HTTPcURLJavaScriptPython

POST /merchant/{merchantId}/lookupHistory HTTP/1.1
Host: {baseUrl}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "field": [
    "provider",
    "txShieldOICartReference"
  ],
  "value": [
    "verify",
    "439bae96-8c52-49d7-9560-8a8e5db6714"
  ],
  "operator": [
    "=",
    "LIKE"
  ],
  "dateFrom": "2025-02-28T02:03:39.852Z",
  "dateTo": "2025-05-30T02:03:39.852Z",
  "order": "DESC",
  "sortField": "txShieldOICartReference"
}

{
  "datalist": [
    {
      "_id": "text",
      "txShieldOICartReference": "text",
      "provider": "text",
      "service": "text",
      "lookupReference": "text",
      "cardBin": "text",
      "cardLast4": "text",
      "transactionDate": "2025-12-13T01:12:31.149Z",
      "lookupDate": "2025-12-13T01:12:31.149Z",
      "receivedData": {
        "source": "text",
        "cardBin": "text",
        "cardLast4": "text",
        "transactionDate": "2025-12-13T01:12:31.149Z",
        "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-12-13T01:12:31.149Z",
          "cardBin": "text",
          "cardLast4": "text",
          "amount": 1,
          "currency": "text",
          "paymentDescriptor": "text",
          "merchantId": "text",
          "dateCreated": "2025-12-13T01:12:31.149Z",
          "email": "text",
          "alertHappened": true,
          "alertReference": "text",
          "chargebackHappened": true,
          "chargebackReference": "text"
        }
      ],
      "merchantId": "text",
      "merchantName": "text"
    }
  ],
  "total": 1
}