Reports
TransactionList
Description: The TransactionList endpoint allows you to retrieve a paginated list of transactions associated with your producer account. Results can be filtered by date range and transaction status, and are returned in pages to support large result sets.
-
Request
-
Samples
-
Response
-
Samples
Fieldname | Required | Type | Description | Validate | Xpath |
|---|---|---|---|---|---|
TransactionType | Yes | String | Transaction type to process. (TransactionList) | TransactionList | TranzPayRequest.TransactionType |
UserName | Yes | String | Tranzpay username. | Username supplied by Tranzpay | TranzPayRequest.UserName |
Password | Yes | String | Tranzpay password. | Password supplied by Tranzpay | TranzPayRequest.Password |
ProducerID | Yes | Number | Tranzpay ProducerID assigned to your merchant account. | Integer supplied by Tranzpay | TranzPayRequest.ProducerID |
StartDate | Yes | String | Start of the date range to query. | Any parseable Date/time formatted string. ISO 8601 with timezone offset recommended. | TranzPayRequest.StartDate |
EndDate | Yes | String | End of the date range to query. | Any parseable Date/time formatted string. ISO 8601 with timezone offset recommended. | TranzPayRequest.EndDate |
PageSize | No | Number | Number of results to return per page. | Integer between 1 and 1000. Default: 100. | TranzPayRequest.PageSize |
Page | No | Number | Page number to retrieve. | Integer greater than or equal to 1. Default: 1. | TranzPayRequest.Page |
Status | No | String or Array | Filter results by transaction status. Accepts a single value or a list of values. | all, sales, declines, credits, voids, achreturns. Default: all. | TranzPayRequest.Status |
-
xML
-
JSON
<TranzPayRequest>
<TransactionType>TransactionList</TransactionType>
<UserName>{{USERNAME}}</UserName>
<Password>{{API_PASSWORD}}</Password>
<ProducerID>{{PRODUCERID}}</ProducerID>
<StartDate>2026-01-09T13:00:00-05:00</StartDate>
<EndDate>2026-01-09T23:59:59-05:00</EndDate>
</TranzPayRequest>
With Pagination and Status Filter (XML)
<TranzPayRequest>
<TransactionType>TransactionList</TransactionType>
<UserName>{{USERNAME}}</UserName>
<Password>{{API_PASSWORD}}</Password>
<ProducerID>{{PRODUCERID}}</ProducerID>
<StartDate>2026-01-09T13:00:00-05:00</StartDate>
<EndDate>2026-01-09T23:59:59-05:00</EndDate>
<PageSize>25</PageSize>
<Page>1</Page>
<Status>
<item>sales</item>
<item>declines</item>
</Status>
</TranzPayRequest>
{
"TransactionType": "TransactionList",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"StartDate": "2026-01-09T13:00:00-05:00",
"EndDate": "2026-01-09T23:59:59-05:00"
}
With Pagination and Status Filter (JSON)
{
"TransactionType": "TransactionList",
"UserName": "{{USERNAME}}",
"Password": "{{API_PASSWORD}}",
"ProducerID": "{{PRODUCERID}}",
"StartDate": "2026-01-09T13:00:00-05:00",
"EndDate": "2026-01-09T23:59:59-05:00",
"PageSize": 25,
"Page": 1,
"Status": ["sales", "declines"]
}
Fieldname | Description | Validate | Xpath | Note |
|---|---|---|---|---|
ProducerID | TranzPay ProducerID assigned to your merchant account. | Integer supplied by TranzPay. | TranzPayResponse.ProducerID | |
GatewayConnect | Connection to gateway was established. | "Y" or "N" | TranzPayResponse.GatewayConnect | |
transactionId | Merchant gateway returned unique transactionID. | Any alphanumeric | TranzPayResponse.Transactions.Transaction.transactionId | |
producerId | ProducerID associated with the transaction. | Integer | TranzPayResponse.Transactions.Transaction.producerId | |
systemPaymentDate | Datetime the payment was processed by the system. | ISO 8601 UTC Date/time formatted string | TranzPayResponse.Transactions.Transaction.systemPaymentDate | |
producerPaymentDate | Recurring payment note. | ISO 8601 UTC Date/time formatted string | TranzPayResponse.Transactions.Transaction.producerPaymentDate | |
payerName | Full name of the payer. | Any alphanumeric | TranzPayResponse.Transactions.Transaction.payerName | |
policyNumber | Amount of payment plane in decimal format (ie. 99.99) | Any alphanumeric | TranzPayResponse.Transactions.Transaction.businessName | |
creditCardType | Card network name. | VISA, MASTERCARD, AMEX, DISCOVER, MASTERCARD_2, NONE | TranzPayResponse.Transactions.Transaction.creditCardType | NONE if payment method is ACH. |
paymentMethod | Payment method used. | CC or ACH | TranzPayResponse.Transactions.Transaction.paymentMethod | |
lastFourAccount | Next date when the payment occurance will be proccesed. | Date/time formatted string. | TranzPayResponse.Transactions.Transaction.lastFourAccount | |
amount | Recurring payment plan creation date | Decimal number, 4 decimal places | TranzPayResponse.Transactions.Transaction.amount | |
baseAmount | Recurring payment plan type | Decimal number, 4 decimal places | TranzPayResponse.Transactions.Transaction.baseAmount | |
feeAmount | Recurring payment plan type. | Decimal number, 4 decimal places | TranzPayResponse.Transactions.Transaction.feeAmount | |
paymentApproved | Indicates whether the payment was approved. | 1 = Approved, 0 = Not Approved | TranzPayResponse.Transactions.Transaction.paymentApproved | |
type | Transaction type. | Sale or Declined | TranzPayResponse.Transactions.Transaction.type | |
sourceName | Source through which the transaction was submitted. | API, Hosted, IVR, Paylink, Invoice, Subscription, VT, Unknown | TranzPayResponse.Transactions.Transaction.sourceName | |
responseCode | Gateway response code. | Any alphanumeric | TranzPayResponse.Transactions.Transaction.responseCode | |
responseMessage | Gateway response message. | Any alphanumeric | TranzPayResponse.Transactions.Transaction.responseMessage | |
authCode | Authorization code returned by the card network. | Any alphanumeric | TranzPayResponse.Transactions.Transaction.authCode | Present on approved sale transactions only. |
lastSystemPaymentDate | Most recent system-side payment datetime for this transaction. | ISO 8601 UTC Date/time formatted string | TranzPayResponse.Transactions.Transaction.lastSystemPaymentDate | |
lastProducerPaymentDate | Most recent producer-side payment datetime for this transaction. | ISO 8601 UTC Date/time formatted string | TranzPayResponse.Transactions.Transaction.lastProducerPaymentDate | |
totalRefunded | Cumulative amount refunded against this transaction. | Decimal number, 4 decimal places | TranzPayResponse.Transactions.Transaction.totalRefunded | |
totalVoided | Cumulative amount voided against this transaction. | Decimal number, 4 decimal places | TranzPayResponse.Transactions.Transaction.totalVoided | |
totalACHReturned | Cumulative ACH returned amount for this transaction. | Decimal number, 4 decimal places | TranzPayResponse.Transactions.Transaction.totalACHReturned | |
totalBindCredited | Cumulative blind credit amount for this transaction. | Decimal number, 4 decimal places | TranzPayResponse.Transactions.Transaction.totalBlindCredited | |
status | Display status of the transaction. | Approved, Declined, etc. | TranzPayResponse.Transactions.Transaction.status | |
Page | Current page number. | Integer | TranzPayResponse.Pagination.Page | |
PageSize | Number of results per page. | Integer | TranzPayResponse.Pagination.PageSize | |
TotalCount | Total number of transactions matching the query. | Integer | TranzPayResponse.Pagination.TotalCount | |
TotalPages | Total number of pages available. | Integer | TranzPayResponse.Pagination.TotalPages |
-
xML
-
JSON
<?xml version="1.0" encoding="UTF-8"?> <TranzPayResponse> <ProducerID>145</ProducerID> <GatewayConnect>N</GatewayConnect> <Transactions> <Transaction> <transactionId>366846523</transactionId> <producerId>145</producerId> <systemPaymentDate>2026-01-09T18:24:19Z</systemPaymentDate> <producerPaymentDate>2026-01-09T19:24:19Z</producerPaymentDate> <payerName>Jane Smith</payerName> <businessName>Acme Corp</businessName> <policyNumber>POL-00001</policyNumber> <creditCardType>VISA</creditCardType> <paymentMethod>CC</paymentMethod> <lastFourAccount>5439</lastFourAccount> <amount>829.7800</amount> <baseAmount>801.7300</baseAmount> <feeAmount>28.0500</feeAmount> <paymentApproved>1</paymentApproved> <type>Sale</type> <sourceName>API</sourceName> <responseCode>00</responseCode> <responseMessage>APPROVED</responseMessage> <authCode>279043</authCode> <lastSystemPaymentDate>2026-01-09T18:24:19Z</lastSystemPaymentDate> <lastProducerPaymentDate>2026-01-09T19:24:19Z</lastProducerPaymentDate> <totalRefunded>0.0000</totalRefunded> <totalVoided>0.0000</totalVoided> <totalACHReturned>0.0000</totalACHReturned> <totalBlindCredited>0.0000</totalBlindCredited> <status>Approved</status> </Transaction> <Transaction> <transactionId>366846493</transactionId> <producerId>145</producerId> <systemPaymentDate>2026-01-09T18:23:45Z</systemPaymentDate> <producerPaymentDate>2026-01-09T19:23:45Z</producerPaymentDate> <payerName>Mark Jones</payerName> <businessName>Beta LLC</businessName> <policyNumber>POL-00002</policyNumber> <creditCardType>VISA</creditCardType> <paymentMethod>CC</paymentMethod> <lastFourAccount>5439</lastFourAccount> <amount>0.1000</amount> <baseAmount>0.1000</baseAmount> <feeAmount>0.0000</feeAmount> <paymentApproved>0</paymentApproved> <type>Declined</type> <sourceName>API</sourceName> <responseCode>05</responseCode> <responseMessage>DECLINED</responseMessage> <lastSystemPaymentDate>2026-01-09T18:23:45Z</lastSystemPaymentDate> <lastProducerPaymentDate>2026-01-09T19:23:45Z</lastProducerPaymentDate> <totalRefunded>0.0000</totalRefunded> <totalVoided>0.0000</totalVoided> <totalACHReturned>0.0000</totalACHReturned> <totalBlindCredited>0.0000</totalBlindCredited> <status>Declined</status> </Transaction> </Transactions> <Pagination> <Page>1</Page> <PageSize>100</PageSize> <TotalCount>2</TotalCount> <TotalPages>1</TotalPages> </Pagination> </TranzPayResponse>
{
"ProducerID": "145",
"GatewayConnect": "N",
"Transactions": {
"Transaction": [
{
"transactionId": "366846523",
"producerId": "145",
"systemPaymentDate": "2026-01-09T18:24:19Z",
"producerPaymentDate": "2026-01-09T19:24:19Z",
"payerName": "Jane Smith",
"businessName": "Acme Corp",
"policyNumber": "POL-00001",
"creditCardType": "VISA",
"paymentMethod": "CC",
"lastFourAccount": "5439",
"amount": "829.7800",
"baseAmount": "801.7300",
"feeAmount": "28.0500",
"paymentApproved": "1",
"type": "Sale",
"sourceName": "API",
"responseCode": "00",
"responseMessage": "APPROVED",
"authCode": "279043",
"lastSystemPaymentDate": "2026-01-09T18:24:19Z",
"lastProducerPaymentDate": "2026-01-09T19:24:19Z",
"totalRefunded": "0.0000",
"totalVoided": "0.0000",
"totalACHReturned": "0.0000",
"totalBlindCredited": "0.0000",
"status": "Approved"
},
{
"transactionId": "366846493",
"producerId": "145",
"systemPaymentDate": "2026-01-09T18:23:45Z",
"producerPaymentDate": "2026-01-09T19:23:45Z",
"payerName": "Mark Jones",
"businessName": "Beta LLC",
"policyNumber": "POL-00002",
"creditCardType": "VISA",
"paymentMethod": "CC",
"lastFourAccount": "5439",
"amount": "0.1000",
"baseAmount": "0.1000",
"feeAmount": "0.0000",
"paymentApproved": "0",
"type": "Declined",
"sourceName": "API",
"responseCode": "05",
"responseMessage": "DECLINED",
"lastSystemPaymentDate": "2026-01-09T18:23:45Z",
"lastProducerPaymentDate": "2026-01-09T19:23:45Z",
"totalRefunded": "0.0000",
"totalVoided": "0.0000",
"totalACHReturned": "0.0000",
"totalBlindCredited": "0.0000",
"status": "Declined"
}
]
},
"Pagination": {
"Page": "1",
"PageSize": "100",
"TotalCount": "2",
"TotalPages": "1"
}
}