Transaction Query APIs

Gateway Transaction

Retrieve a specific gateway-level payment attempt using gatewayTransactionId, typically used by support or finance teams for payment troubleshooting, reconciliation, or chargeback investigations.

Sample Response Body

{
  "stickyTransactionId": "8a9d6955b64easdse8d6c643142a48894f539b7c6199150asa",
  "gatewayTransactionId": "110001975F76C222",
  "gatewayProfileId": "4413",
  "gatewayProfile": "Rocket Gate",
  "transactionType": "PURCHASE",
  "externalId": "123456",
  "billingAddress": {
    "address1": "999 SW 1st ave",
    "address2": "",
    "city": "Miami",
    "state": "FL",
    "zip": "33130",
    "country": "US"
  },
  "customer": {
    "id": "116",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phone": "string"
  },
  "paymentMethod": {
    "card": {      
      "cardHolderName": "John Doe",
      "firstSixDigits": "544937",
      "lastFourDigits": "6768",
      "cardNetworkName": "MasterCard"
    }
  },
  "gatewayResponseCode": "",
  "dunningSessionId": "",
  "stickyTransactionStatus": "SUCCESS",
  "gatewayStatus": "SUCCESS",
  "recoveryTransactionStatus": "RECOVERY_DRAFT",
  "createdDate": "2025-05-23T19:48:17.097Z",
  "lastModifiedDate": "2025-05-23T19:48:17.097Z", 
  "processorName": "string",
  "amount": 100
}

Transaction History

Fetch the full lifecycle of a transaction — including retries, approvals, and refunds. stickyTransactionId is returned to the merchant by the recover API Endpoint, which merchants can use to track recovery outcomes and payment flows.

Sample Response Body

{
  "stickyTransactionId": "8a9d6955b64e8d6c643142a48894f539b7c6199150a123456",
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phone": "+15555555555"
  },
  "billingAddress": {
    "address1": "999 SW 1st Ave",
    "address2": "",
    "city": "Miami",
    "state": "FL",
    "zip": "33130",
    "country": "US"
  },
  "paymentMethod": {
    "card": {
      "cardHolderName": "John Doe",
      "firstSixDigits": "544937",
      "lastFourDigits": "6768",
      "cardNetworkName": "MasterCard"
    }
  },
  "stickySubTransactions": [
    {
      "stickySubTransactionId": "subTxn1",
      "gatewayProfileId": "4413",
      "gatewayProfile": "Rocket Gate",
      "transactionState": "DECLINED",
      "createdDate": "2025-04-26T13:42:49.281425Z",
      "lastModifiedDate": "2025-04-26T13:42:49.281433Z",
      "amount": 5198,
      "gatewayTransactions": [
        {
          "gatewayTransactionId": "110001975F76C111",
          "transactionType": "PURCHASE",
          "gatewayStatus": "DECLINED",
          "stickyTransactionStatus": "DECLINED",
          "createdDate": "2025-04-26T13:42:49.281425Z",
          "amount": 5198
        }
      ]
    },
    {
      "stickySubTransactionId": "subTxn2",
      "gatewayProfileId": "4413",
      "gatewayProfile": "Rocket Gate",
      "transactionState": "PARTIALLY_REFUNDED",
      "createdDate": "2025-04-27T13:42:49.281425Z",
      "lastModifiedDate": "2025-04-27T13:42:49.281433Z",
      "amount": 5198,
      "gatewayTransactions": [
        {
          "gatewayTransactionId": "110001975F76C222",
          "transactionType": "PURCHASE",
          "gatewayStatus": "SUCCESS",
          "stickyTransactionStatus": "SUCCESS",
          "createdDate": "2025-04-27T13:42:49.281425Z",
          "amount": 5198
        },
        {
          "gatewayTransactionId": "110001975F76C333",
          "transactionType": "REFUND",
          "gatewayStatus": "APPROVED",
          "stickyTransactionStatus": "SUCCESS",
          "createdDate": "2025-04-27T13:42:49.281425Z",
          "amount": 1000
        }
      ]
    }
  ]
}

List of Transactions

Retrieve a filtered, paginated list of transactions across customers or timeframes to support reporting, analytics, or operational monitoring.

Sample Response Body

{
  "totalElements": 754,
  "totalPages": 76,
  "page": 0,
  "size": 10,
  "content": [
    {
      "stickyTransactionId": "8a9d6955b64e8d6c643142a48894f539b7c6199150a123456",
      "stickySubTransactionId": "subTxn1",
      "gatewayProfileId": "4413",
      "gatewayProfile": "Rocket Gate",
      "transactionState": "DECLINED",
      "createdDate": "2025-04-26T13:42:49.281425Z",
      "lastModifiedDate": "2025-04-26T13:42:49.281433Z",
      "amount": 5198
    },
    {
      "stickyTransactionId": "8a9d6955b64e8d6c643142a48894f539b7c6199150a123456",
      "stickySubTransactionId": "subTxn2",
      "gatewayProfileId": "4413",
      "gatewayProfile": "Rocket Gate",
      "transactionState": "PARTIALLY_REFUNDED",
      "createdDate": "2025-04-27T13:42:49.281425Z",
      "lastModifiedDate": "2025-04-27T13:42:49.281433Z",
      "amount": 4198
    }
  ]
}