Transaction Query APIs
Overview
Sticky Recovery provides three powerful read-only APIs for transaction observability. These endpoints allow you to query transaction data to support reporting, reconciliation, troubleshooting, and performance monitoring, without triggering any recovery actions.
| Endpoint | Description |
|---|---|
| Gateway Transaction | Retrieve details of a specific gateway-level payment attempt using gatewayTransactionId. Ideal for support teams reviewing declines, approvals, or chargebacks. |
| Transaction History | Fetch the full lifecycle of a Sticky Recovery transaction (retries, approvals, refunds) using stickyTransactionId. |
| List of Transactions | Retrieve a paginated, filterable list of transactions across timeframes or customers for analytics and operational oversight. |
| List of Gateway Transactions | Retrieve a list of gateway transactions (e.g., refund transactions including both successful and failed, along with detailed gateway response data). It provides additional visibility into each transaction by including gateway outcomes and failure reasons, which are not available in the standard List of Transactions API. |
| List of Recovery Activity | Retrieve the current recovery state for declined transactions (e.g., IN_RECOVERY, RECOVERED, or UNRECOVERED). This endpoint reflects the latest status of each recovery session rather than individual retry attempts. |
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, using the stickyTransactionId. 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
}
]
}
List of Gateway Transactions
Retrieve a list of gateway transactions (e.g., refund transactions including both successful and failed, along with detailed gateway response data.
Sample Response Body
{
"content": [
{
"stickyTransactionId": "STICKY_TXN_001",
"gatewayTransactionId": "GW_TXN_123456",
"transactionType": "REFUND",
"createdDate": "2025-04-26T13:42:49.281425Z",
"gatewayProfileId": "123456",
"gatewayProfile": "ROCKET GATE",
"stickyTransactionStatus": "SUCCEEDED",
"gatewayStatus": "APPROVED",
"gatewayResponse" : "",
"externalId": "ext-001",
"amount": 4999,
"currency": "USD"
},
{
"stickyTransactionId": "STICKY_TXN_002",
"gatewayTransactionId": "GW_TXN_123453",
"transactionType": "REFUND",
"createdDate": "2025-04-26T13:42:49.281425Z",
"gatewayProfileId": "string",
"gatewayProfile": "string",
"stickyTransactionStatus": "FAILED",
"gatewayStatus":"REJECTED",
"gatewayResponse" : "Invalid Auth Code",
"externalId": "ext-001",
"amount": 4999,
"currency": "USD"
},
{
"stickyTransactionId": "STICKY_TXN_002",
"gatewayTransactionId": "GW_TXN_123453",
"transactionType": "REFUND",
"createdDate": "2025-04-26T13:42:49.281425Z",
"gatewayProfileId": "string",
"gatewayProfile": "string",
"transactionState": "CAPTURED",
"stickyTransactionStatus": "FAILED",
"gatewayStatus":"REJECTED",
"gatewayResponse" : "Invalid Auth Code",
"externalId": "ext-001",
"amount": 4999,
"currency": "USD"
},
{
"stickyTransactionId": "STICKY_TXN_002",
"gatewayTransactionId": "GW_TXN_1234qw53",
"transactionType": "PURCHASE",
"createdDate": "2025-04-26T13:42:49.281425Z",
"gatewayProfileId": "string",
"gatewayProfile": "string",
"transactionState": "REFUNDED",
"stickyTransactionStatus": "SUCCEEDED",
"gatewayStatus":"SUCCEEDED",
"gatewayResponse" : "",
"externalId": "ext-001",
"amount": 4999,
"currency": "USD"
}
],
"totalElements":754,
"totalPages":76,
"page":0,
"size":10,
}List of Recovery Activity
Retrieve the list of recovery attempts associated with a specific transaction. This offers insight into the status and final outcome of each initiated recovery effort.
"content": [
{
"stickyTransactionId": "STICKY_TXN_001",
"recoveryState": "IN_RECOVERY",
"recoveryStatus": null,
"dunningProfileId": "DP_123",
"createdDate": "2025-05-01T09:00:00Z",
},
{
"stickyTransactionId": "STICKY_TXN_002",
"recoveryState": "RECOVERED",
"recoveryStatus": "APPROVED",
"dunningProfileId": "DP_789",
"createdDate": "2025-04-29T12:30:00Z",
},
{
"stickyTransactionId": "STICKY_TXN_003",
"recoveryState": "UNRECOVERED",
"recoveryStatus": "CANCELED",
"dunningProfileId": "DP_456",
"createdDate": "2025-04-27T15:45:00Z",
}
],
"totalElements":754,
"totalPages":76,
"page":0,
"size":10,
}