searchTransactionsV4
ApiScope: payment.transaction.list
API Scope Level: DealerScope
Path Parameters
Request Body required
userDetail object
tenderFilter object
Possible values: [SUCCESSFUL, FAILED]
paginationParams object
sortParams object
Possible values: [ASC, DESC]
Possible values: [ID, AMOUNT, TRANSDATE]
- 200
 
OK
Schema
- Array [
 - ]
 - Array [
 - ]
 - Array [
 - Array [
 - ]
 - ]
 - Array [
 - Array [
 - ]
 - ]
 
errors object[]
warnings object[]
successfulTransactions object[]
Possible values: [APPROVED, DECLINED, ERROR]
paymentGatewayResponse object
paymentUser object
Possible values: [CHARGE, REFUND, DEPOSIT, VOID, AUTH, CAPTURE, BLOCK]
invoice object
invoiceAttributes object
paymentDealer object
paymentDealerOrder object
paymentCustomer object
paymentUser object
tenderData object
tenderSubType object
tenderType object
paymentDealer object
paymentDealerOrder object
paymentDealer object
paymentCustomer object
paymentUser object
paymentCustomer object
Possible values: [MANUAL, SWIPER, IPAD_SWIPER, ONLINE, IPAD_MANUAL, MAGTEK_MANUAL, MAGTEK_SWIPE, MAGTEK_EMV, MIURA_CHIP, REPAIR_FINANCING, GUARANTOR_CHECK, MIURA_SWIPER, MIURA_CONTACTLESS, OPENEDGE_CHIP, OPENEDGE_SWIPER, OPENEDGE_MANUAL, OPENEDGE_MANAUL, OPENEDGE_WALKERBT_CHIP, OPENEDGE_CLOUD_CHIP, OPENEDGE_CLOUD_SWIPE, OPENEDGE_CLOUD_MANUAL, OPENEDGE_WALKERBT_SWIPE, OPENEDGE_CLOUD_ICMP_CHIP, OPENEDGE_CLOUD_ICMP_SWIPE, OPENEDGE_CLOUD_ICMP_MANUAL, OPENEDGE_CLOUD_ICMP_CONTACTLESS, OPENEDGE_CLOUD_CONTACTLESS, OPENEDGE_WALKERBT_CHIP_ANDROID, OPENEDGE_WALKERBT_SWIPE_ANDROID, OPENEDGE_MANUAL_IOS, OPENEDGE_MANUAL_ANDROID, TRIPOS_VERIFONE_CHIP, TRIPOS_VERIFONE_SWIPE, TRIPOS_VERIFONE_MANUAL, TRIPOS_VERIFONE_CONTACTLESS, TRIPOS_IPP320_CHIP, TRIPOS_IPP320_SWIPE, TRIPOS_IPP320_MANUAL, TRIPOS_IPP320_CONTACTLESS, TRIPOS_ISMP_CHIP, TRIPOS_ISMP_SWIPE, TRIPOS_ISMP_MANUAL, TRIPOS_ISMP_CONTACTLESS, CREDITCALL_CHIP, CREDITCALL_SWIPER, CREDITCALL_MANUAL, CREDITCALL_CONTACTLESS, NMI_LANE_CHIP, NMI_LANE_SWIPE, NMI_LANE_MANUAL, NMI_LANE_CONTACTLESS, NMI_VERIFONE_CHIP, NMI_VERIFONE_SWIPE, NMI_VERIFONE_MANUAL, NMI_VERIFONE_CONTACTLESS, NMI_BBPOS_CHIP_ANDROID, NMI_BBPOS_SWIPE_ANDROID, NMI_BBPOS_CHIP_IOS, NMI_BBPOS_SWIPE_IOS, STRIPE_BBPOS_WISEPOS_E_CHIP, STRIPE_BBPOS_WISEPOS_E_SWIPE, STRIPE_BBPOS_WISEPOS_E_CONTACTLESS, CARDCONNECT_ISMP_CHIP, CARDCONNECT_ISMP_SWIPE, CARDCONNECT_ISC250_CHIP, CARDCONNECT_ISC250_SWIPE, CARDCONNET_ISMP_MANUAL, CARDCONNECT_ISC250_MANUAL, CARDCONNECT_ISMP_CONTACTLESS, CARDCONNECT_ISC250_CONTACTLESS, CARDCONNECT_LANE_5000_MANUAL, CARDCONNECT_LANE_5000_CHIP, CARDCONNECT_LANE_5000_SWIPE, CARDCONNECT_LANE_5000_CONTACTLESS, CARDCONNECT_CLOVER_MANUAL, CARDCONNECT_CLOVER_CHIP, CARDCONNECT_CLOVER_SWIPE, CARDCONNECT_CLOVER_CONTACTLESS, STRIPE_APPLE_PAY, STRIPE_GOOGLE_PAY, STRIPE_M2, IPHONE_TAP_TO_PAY]
transactionAttributes object
parentTransaction object
transactionType object
transactionDetails object[]
roOwner object
department object
dealer object
role object
cashier object
department object
dealer object
role object
failedTransactions object[]
Possible values: [APPROVED, DECLINED, ERROR]
paymentGatewayResponse object
paymentUser object
Possible values: [CHARGE, REFUND, DEPOSIT, VOID, AUTH, CAPTURE, BLOCK]
invoice object
invoiceAttributes object
paymentDealer object
paymentDealerOrder object
paymentCustomer object
paymentUser object
tenderData object
tenderSubType object
tenderType object
paymentDealer object
paymentDealerOrder object
paymentDealer object
paymentCustomer object
paymentUser object
paymentCustomer object
Possible values: [MANUAL, SWIPER, IPAD_SWIPER, ONLINE, IPAD_MANUAL, MAGTEK_MANUAL, MAGTEK_SWIPE, MAGTEK_EMV, MIURA_CHIP, REPAIR_FINANCING, GUARANTOR_CHECK, MIURA_SWIPER, MIURA_CONTACTLESS, OPENEDGE_CHIP, OPENEDGE_SWIPER, OPENEDGE_MANUAL, OPENEDGE_MANAUL, OPENEDGE_WALKERBT_CHIP, OPENEDGE_CLOUD_CHIP, OPENEDGE_CLOUD_SWIPE, OPENEDGE_CLOUD_MANUAL, OPENEDGE_WALKERBT_SWIPE, OPENEDGE_CLOUD_ICMP_CHIP, OPENEDGE_CLOUD_ICMP_SWIPE, OPENEDGE_CLOUD_ICMP_MANUAL, OPENEDGE_CLOUD_ICMP_CONTACTLESS, OPENEDGE_CLOUD_CONTACTLESS, OPENEDGE_WALKERBT_CHIP_ANDROID, OPENEDGE_WALKERBT_SWIPE_ANDROID, OPENEDGE_MANUAL_IOS, OPENEDGE_MANUAL_ANDROID, TRIPOS_VERIFONE_CHIP, TRIPOS_VERIFONE_SWIPE, TRIPOS_VERIFONE_MANUAL, TRIPOS_VERIFONE_CONTACTLESS, TRIPOS_IPP320_CHIP, TRIPOS_IPP320_SWIPE, TRIPOS_IPP320_MANUAL, TRIPOS_IPP320_CONTACTLESS, TRIPOS_ISMP_CHIP, TRIPOS_ISMP_SWIPE, TRIPOS_ISMP_MANUAL, TRIPOS_ISMP_CONTACTLESS, CREDITCALL_CHIP, CREDITCALL_SWIPER, CREDITCALL_MANUAL, CREDITCALL_CONTACTLESS, NMI_LANE_CHIP, NMI_LANE_SWIPE, NMI_LANE_MANUAL, NMI_LANE_CONTACTLESS, NMI_VERIFONE_CHIP, NMI_VERIFONE_SWIPE, NMI_VERIFONE_MANUAL, NMI_VERIFONE_CONTACTLESS, NMI_BBPOS_CHIP_ANDROID, NMI_BBPOS_SWIPE_ANDROID, NMI_BBPOS_CHIP_IOS, NMI_BBPOS_SWIPE_IOS, STRIPE_BBPOS_WISEPOS_E_CHIP, STRIPE_BBPOS_WISEPOS_E_SWIPE, STRIPE_BBPOS_WISEPOS_E_CONTACTLESS, CARDCONNECT_ISMP_CHIP, CARDCONNECT_ISMP_SWIPE, CARDCONNECT_ISC250_CHIP, CARDCONNECT_ISC250_SWIPE, CARDCONNET_ISMP_MANUAL, CARDCONNECT_ISC250_MANUAL, CARDCONNECT_ISMP_CONTACTLESS, CARDCONNECT_ISC250_CONTACTLESS, CARDCONNECT_LANE_5000_MANUAL, CARDCONNECT_LANE_5000_CHIP, CARDCONNECT_LANE_5000_SWIPE, CARDCONNECT_LANE_5000_CONTACTLESS, CARDCONNECT_CLOVER_MANUAL, CARDCONNECT_CLOVER_CHIP, CARDCONNECT_CLOVER_SWIPE, CARDCONNECT_CLOVER_CONTACTLESS, STRIPE_APPLE_PAY, STRIPE_GOOGLE_PAY, STRIPE_M2, IPHONE_TAP_TO_PAY]
transactionAttributes object
parentTransaction object
transactionType object
transactionDetails object[]
roOwner object
department object
dealer object
role object
cashier object
department object
dealer object
role object
{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ],
  "successfulTransactions": [
    {
      "status": "APPROVED",
      "id": 0,
      "uuid": "string",
      "paymentGatewayResponse": {
        "id": 0,
        "version": 0,
        "responseCode": 0,
        "responseReasonCode": 0,
        "responseReasonText": "string",
        "authorizationCode": "string",
        "avsresponse": "string",
        "description": "string",
        "amount": 0,
        "cardCodeResponse": "string",
        "cardholderAuthenticationVerificationResponse": "string",
        "cardType": "string",
        "pgtransId": "string",
        "pgtransRefId": "string",
        "isApproved": true,
        "isDeclined": true,
        "isError": true,
        "isReview": true,
        "paymentProviderType": "string",
        "uuid": "string",
        "paymentAttemptUuid": "string"
      },
      "paymentUser": {
        "id": 0,
        "dealerAssociateUUID": "string",
        "userUUID": "string",
        "dealerDepartmentUUID": "string"
      },
      "transactionType": "CHARGE",
      "invoice": {
        "id": 0,
        "guid": "string",
        "invoiceStatus": "string",
        "amount": 0,
        "invoiceDate": "2025-10-30T17:04:38.505Z",
        "description": "string",
        "refundedAmount": 0,
        "paidDate": "2025-10-30T17:04:38.505Z",
        "fileName": "string",
        "reminderMileage": 0,
        "reminderDate": "2025-10-30T17:04:38.505Z",
        "signatureFileName": "string",
        "paymentDeclines": "string",
        "invoiceAttributes": {},
        "paymentDealer": {
          "dealerUuid": "string"
        },
        "paymentDealerOrder": {
          "orderNumber": "string",
          "orderType": "string",
          "departmentUuid": "string",
          "dealerOrderUuid": "string"
        },
        "paymentCustomer": {
          "customerUuid": "string"
        },
        "paymentUser": {
          "id": 0,
          "dealerAssociateUUID": "string",
          "userUUID": "string",
          "dealerDepartmentUUID": "string"
        }
      },
      "tenderData": {
        "id": 0,
        "data": "string",
        "hash": "string",
        "tenderSubType": {
          "id": 0,
          "subTenderName": "string",
          "tenderType": {
            "id": 0,
            "version": 0,
            "tenderName": "string",
            "availableOnMobile": true
          },
          "valid": true
        }
      },
      "description": "string",
      "transDate": "2025-10-30T17:04:38.505Z",
      "transAmount": 0,
      "source": "string",
      "paymentProvider": "string",
      "paymentDealer": {
        "dealerUuid": "string",
        "name": "string"
      },
      "paymentDealerOrder": {
        "orderNumber": "string",
        "orderType": "string",
        "orderDate": "2025-10-30T17:04:38.505Z",
        "paymentDealer": {
          "dealerUuid": "string",
          "name": "string"
        },
        "paymentCustomer": {
          "customerUuid": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "company": "string"
        },
        "paymentUser": {
          "id": 0,
          "dealerAssociateUUID": "string",
          "userUUID": "string",
          "dealerDepartmentUUID": "string"
        },
        "signatureRequestId": 0,
        "departmentUuid": "string",
        "dealerOrderUuid": "string",
        "numberOfInvoices": 0,
        "readyROData": "string",
        "paidAmount": 0,
        "amount": 0,
        "dealerOrderSyncDate": "2025-10-30T17:04:38.505Z",
        "suspicious": true,
        "paidInKaarma": true,
        "paid": true,
        "paymentRequestSent": true,
        "paidOnline": true
      },
      "paymentCustomer": {
        "customerUuid": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "company": "string"
      },
      "deviceType": "MANUAL",
      "transactionAttributes": {},
      "accountBalance": 0,
      "details": "string",
      "isSettled": true,
      "settledDate": "2025-10-30T17:04:38.505Z",
      "paymentGatewayTransId": "string",
      "isVoided": true,
      "ipAddress": "string",
      "parentTransaction": {
        "id": 0,
        "transactionType": {
          "id": 0,
          "shortCode": "string",
          "description": "string",
          "deposit": 0,
          "fee": 0
        },
        "description": "string",
        "transDate": "2025-10-30T17:04:38.505Z",
        "transAmount": 0,
        "accountBalance": 0,
        "transRefNum": "string",
        "details": "string",
        "category": "string",
        "source": "string",
        "isReconciled": true,
        "isSettled": true,
        "reconciledDate": "2025-10-30T17:04:38.505Z",
        "settledDate": "2025-10-30T17:04:38.505Z",
        "deviceId": 0,
        "paymentGatewayTransId": "string",
        "isVoided": true,
        "paymentProvider": "string",
        "uuid": "string"
      },
      "transactionDetails": [
        {
          "id": 0,
          "transactionId": 0,
          "transactionIncompleteId": 0,
          "type": "string",
          "amount": 0,
          "description": "string"
        }
      ],
      "roOwner": {
        "id": 0,
        "uuid": "string",
        "userUuid": "string",
        "firstName": "string",
        "lastName": "string",
        "userName": "string",
        "cellPhone": "string",
        "textNumber": "string",
        "isTextNumberVerified": true,
        "emailAddress": "string",
        "nickname": "string",
        "associateDmsID": "string",
        "imageUrl": "string",
        "isValid": true,
        "bio": "string",
        "userInviteStatus": "string",
        "defaultThreadOwnerUserUUID": "string",
        "outOfOffice": true,
        "outOfOfficeStartDate": "string",
        "ssoFeatureEnabled": true,
        "isDealerMappedToSsoPartner": true,
        "isSsoPartnerMapped": true,
        "department": {
          "id": 0,
          "name": "string",
          "uuid": "string",
          "calendarUuid": "string",
          "brokerNumber": "string",
          "communicationGroup": "string",
          "dealer": {
            "id": 0,
            "name": "string",
            "uuid": "string",
            "isValid": true
          }
        },
        "role": {
          "roleName": "string",
          "roleAcronym": "string"
        }
      },
      "cashier": {
        "id": 0,
        "uuid": "string",
        "userUuid": "string",
        "firstName": "string",
        "lastName": "string",
        "userName": "string",
        "cellPhone": "string",
        "textNumber": "string",
        "isTextNumberVerified": true,
        "emailAddress": "string",
        "nickname": "string",
        "associateDmsID": "string",
        "imageUrl": "string",
        "isValid": true,
        "bio": "string",
        "userInviteStatus": "string",
        "defaultThreadOwnerUserUUID": "string",
        "outOfOffice": true,
        "outOfOfficeStartDate": "string",
        "ssoFeatureEnabled": true,
        "isDealerMappedToSsoPartner": true,
        "isSsoPartnerMapped": true,
        "department": {
          "id": 0,
          "name": "string",
          "uuid": "string",
          "calendarUuid": "string",
          "brokerNumber": "string",
          "communicationGroup": "string",
          "dealer": {
            "id": 0,
            "name": "string",
            "uuid": "string",
            "isValid": true
          }
        },
        "role": {
          "roleName": "string",
          "roleAcronym": "string"
        }
      },
      "threeDSAuthenticationFailed": true
    }
  ],
  "failedTransactions": [
    {
      "status": "APPROVED",
      "id": 0,
      "uuid": "string",
      "paymentGatewayResponse": {
        "id": 0,
        "version": 0,
        "responseCode": 0,
        "responseReasonCode": 0,
        "responseReasonText": "string",
        "authorizationCode": "string",
        "avsresponse": "string",
        "description": "string",
        "amount": 0,
        "cardCodeResponse": "string",
        "cardholderAuthenticationVerificationResponse": "string",
        "cardType": "string",
        "pgtransId": "string",
        "pgtransRefId": "string",
        "isApproved": true,
        "isDeclined": true,
        "isError": true,
        "isReview": true,
        "paymentProviderType": "string",
        "uuid": "string",
        "paymentAttemptUuid": "string"
      },
      "paymentUser": {
        "id": 0,
        "dealerAssociateUUID": "string",
        "userUUID": "string",
        "dealerDepartmentUUID": "string"
      },
      "transactionType": "CHARGE",
      "invoice": {
        "id": 0,
        "guid": "string",
        "invoiceStatus": "string",
        "amount": 0,
        "invoiceDate": "2025-10-30T17:04:38.506Z",
        "description": "string",
        "refundedAmount": 0,
        "paidDate": "2025-10-30T17:04:38.506Z",
        "fileName": "string",
        "reminderMileage": 0,
        "reminderDate": "2025-10-30T17:04:38.506Z",
        "signatureFileName": "string",
        "paymentDeclines": "string",
        "invoiceAttributes": {},
        "paymentDealer": {
          "dealerUuid": "string"
        },
        "paymentDealerOrder": {
          "orderNumber": "string",
          "orderType": "string",
          "departmentUuid": "string",
          "dealerOrderUuid": "string"
        },
        "paymentCustomer": {
          "customerUuid": "string"
        },
        "paymentUser": {
          "id": 0,
          "dealerAssociateUUID": "string",
          "userUUID": "string",
          "dealerDepartmentUUID": "string"
        }
      },
      "tenderData": {
        "id": 0,
        "data": "string",
        "hash": "string",
        "tenderSubType": {
          "id": 0,
          "subTenderName": "string",
          "tenderType": {
            "id": 0,
            "version": 0,
            "tenderName": "string",
            "availableOnMobile": true
          },
          "valid": true
        }
      },
      "description": "string",
      "transDate": "2025-10-30T17:04:38.506Z",
      "transAmount": 0,
      "source": "string",
      "paymentProvider": "string",
      "paymentDealer": {
        "dealerUuid": "string",
        "name": "string"
      },
      "paymentDealerOrder": {
        "orderNumber": "string",
        "orderType": "string",
        "orderDate": "2025-10-30T17:04:38.506Z",
        "paymentDealer": {
          "dealerUuid": "string",
          "name": "string"
        },
        "paymentCustomer": {
          "customerUuid": "string",
          "firstName": "string",
          "middleName": "string",
          "lastName": "string",
          "company": "string"
        },
        "paymentUser": {
          "id": 0,
          "dealerAssociateUUID": "string",
          "userUUID": "string",
          "dealerDepartmentUUID": "string"
        },
        "signatureRequestId": 0,
        "departmentUuid": "string",
        "dealerOrderUuid": "string",
        "numberOfInvoices": 0,
        "readyROData": "string",
        "paidAmount": 0,
        "amount": 0,
        "dealerOrderSyncDate": "2025-10-30T17:04:38.506Z",
        "suspicious": true,
        "paidInKaarma": true,
        "paid": true,
        "paymentRequestSent": true,
        "paidOnline": true
      },
      "paymentCustomer": {
        "customerUuid": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "company": "string"
      },
      "deviceType": "MANUAL",
      "transactionAttributes": {},
      "accountBalance": 0,
      "details": "string",
      "isSettled": true,
      "settledDate": "2025-10-30T17:04:38.506Z",
      "paymentGatewayTransId": "string",
      "isVoided": true,
      "ipAddress": "string",
      "parentTransaction": {
        "id": 0,
        "transactionType": {
          "id": 0,
          "shortCode": "string",
          "description": "string",
          "deposit": 0,
          "fee": 0
        },
        "description": "string",
        "transDate": "2025-10-30T17:04:38.506Z",
        "transAmount": 0,
        "accountBalance": 0,
        "transRefNum": "string",
        "details": "string",
        "category": "string",
        "source": "string",
        "isReconciled": true,
        "isSettled": true,
        "reconciledDate": "2025-10-30T17:04:38.506Z",
        "settledDate": "2025-10-30T17:04:38.506Z",
        "deviceId": 0,
        "paymentGatewayTransId": "string",
        "isVoided": true,
        "paymentProvider": "string",
        "uuid": "string"
      },
      "transactionDetails": [
        {
          "id": 0,
          "transactionId": 0,
          "transactionIncompleteId": 0,
          "type": "string",
          "amount": 0,
          "description": "string"
        }
      ],
      "roOwner": {
        "id": 0,
        "uuid": "string",
        "userUuid": "string",
        "firstName": "string",
        "lastName": "string",
        "userName": "string",
        "cellPhone": "string",
        "textNumber": "string",
        "isTextNumberVerified": true,
        "emailAddress": "string",
        "nickname": "string",
        "associateDmsID": "string",
        "imageUrl": "string",
        "isValid": true,
        "bio": "string",
        "userInviteStatus": "string",
        "defaultThreadOwnerUserUUID": "string",
        "outOfOffice": true,
        "outOfOfficeStartDate": "string",
        "ssoFeatureEnabled": true,
        "isDealerMappedToSsoPartner": true,
        "isSsoPartnerMapped": true,
        "department": {
          "id": 0,
          "name": "string",
          "uuid": "string",
          "calendarUuid": "string",
          "brokerNumber": "string",
          "communicationGroup": "string",
          "dealer": {
            "id": 0,
            "name": "string",
            "uuid": "string",
            "isValid": true
          }
        },
        "role": {
          "roleName": "string",
          "roleAcronym": "string"
        }
      },
      "cashier": {
        "id": 0,
        "uuid": "string",
        "userUuid": "string",
        "firstName": "string",
        "lastName": "string",
        "userName": "string",
        "cellPhone": "string",
        "textNumber": "string",
        "isTextNumberVerified": true,
        "emailAddress": "string",
        "nickname": "string",
        "associateDmsID": "string",
        "imageUrl": "string",
        "isValid": true,
        "bio": "string",
        "userInviteStatus": "string",
        "defaultThreadOwnerUserUUID": "string",
        "outOfOffice": true,
        "outOfOfficeStartDate": "string",
        "ssoFeatureEnabled": true,
        "isDealerMappedToSsoPartner": true,
        "isSsoPartnerMapped": true,
        "department": {
          "id": 0,
          "name": "string",
          "uuid": "string",
          "calendarUuid": "string",
          "brokerNumber": "string",
          "communicationGroup": "string",
          "dealer": {
            "id": 0,
            "name": "string",
            "uuid": "string",
            "isValid": true
          }
        },
        "role": {
          "roleName": "string",
          "roleAcronym": "string"
        }
      },
      "threeDSAuthenticationFailed": true
    }
  ],
  "successfulTransactionsCount": 0,
  "failedTransactionsCount": 0
}