For AI agents: the complete documentation index is at
/llms.txt , and the full text of every page is at
/llms-full.txt . Most pages are also available as Markdown by adding
.md to the URL.
Heartland Bill Pay Documentation (AKA Bolletta) V3.151 July 31, 2024
ExportTransactions (Method) Summary
Obtain a list transactions.
Description
This method can return large data sets so if the result set is too large, it will return the data in blocks. If the response had a "NextRecordOffset" > 0, then an additional request needs to be sent with the request object "RecordOffset" set to the previous "NextRecordOffset" last returned. Continue to send requests until the "NextRecordOffset" is zero "0".
The request body is of type ExportTransactions .
Request Body Parameters
Overview The request structure is as follows:
BollettaVersion that is being integrated to
The Credentials to use for the method call
The password that corresponds to the username provided
The username portion of the credentials
The EndDate for the search (Start Date and End Date are used to limit the results to a certain time period).
The list of merchants to perform the export for
The RecordOffset specifies which set of the results should be returned. The response object will include the RecordOffset that should be provided to receive the next set of data. The Export API only returns 1000 records at a time, so multiple calls will be required to return gather all the records if there are more than 1000 for a given set of criteria.
The Start Date for the search (Start Date and End Date are used to limit the results to a certain time period).
The TimeZone that Start Date and End Date are being provided in
The type of transactions (Payment, Payment Return, Payment Reversal, Void of Payment Refund, Disbursement, Disbursement Return, Disbursement Reversal) to return in the results. Blank means ALL.
200 Response (IExportService_ExportTransactions_OutputMessage)
The response body is of type ExportTransactionsResponse .
Response Body Parameters Overview
The response structure is as follows:
Indicates if the request was successful or failed
A list of messages that describe any errors, failures, or warnings that occurred during the processing of a request
The error/warning code
The Level of the message (Warning or Error)
The text description of the error, failure, or warning.
The export data
The base amount that was paid
The IP address of the device that accessed the application used to process the transaction.
The name of the application used to process the transaction.
The result code returned from the card issuer for AVS
The result code action returned from the card issuer for AVS
The result text description returned from the card issuer for AVS
The ID of the batch in which the authorization was processed.
The BIll Type of the bill(s) processed with this transaction
The card entry method of the transaction for card-present transactions (Swipe, Insert, Tap, Manual)
The name of the user/cashier that took/initiated the transaction.
The phone number that called the IVR to process the transaction. (No value if not IVR transaction).
The CVV result code returned by the card issuer.
The CVV result code action returned by the card issuer.
The CVV result text description returned by the card issuer.
The fee amount of the authorization.
The Identifier1 value for the bill(s) associated with this transaction
The Identifier1 value for the bill(s) associated with this transaction
The Identifier3 value for the bill(s) associated with this transaction
The Identifier4 value for the bill(s) associated with this transaction
The MerchantName for this record
The obligor address of the bill(s) associated with this transaction
The obligor city of the bill(s) associated with this transaction
The obligor city of the bill(s) associated with this transaction
The obligor email address of the bill(s) associated with this transaction
The obligor first name of the bill(s) associated with this transaction
The obligor last name of the bill(s) associated with this transaction
The obligor middle name of the bill(s) associated with this transaction
The obligor phone number of the bill(s) associated with this transaction
The obligor phone number region code of the bill(s) associated with this transaction
The obligor state of the bill(s) associated with this transaction
The merchant provided unique OrderID for this transaction
The ID of the original transaction that this transaction is acting against - used for voids/refunds/returns. For example, if this transaction is an ACH return, the OriginalTransactionID field would be populated with the ID of Transaction that was being returned.
The last 4 digits of the payment account
The payment method used for this transaction. (ACH, American Express Credit, American Express Debit, Discover Credit, Discover Debit, eCheck, Mastercard Credit, Mastercard Debit, VISA Credit, Visa Debit).
The address of the payor for this transaction.
The business name of the payor for this transaction.
The city of the payor for this transaction.
The email address of the payor for this transaction.
The last name of the payor for this transaction.
The middle name of the payor for this transaction.
The phone number of the payor for this transaction.
The phone number region code of the payor for this transaction.
The postal code of the payor for this transaction.
The payor state of the payor for this transaction.
The ID of the reference transaction being acted against by this transaction. The ReferenceTransactionID would only be different from the OriginalTransactionID in cases where this is the third or greater action against the original. For example, if this transaction was a cancellation of a refund, the OriginalTransactionID of this authorization would be the ID of the original payment transaction and the ReferenceTransactionID would be the ID of the refund transaction because the refund is what is being cancelled by this transaction.
The code for the type of reversal that this authorization represents (no value if authorization is not a reversal)
The text description of the reversal type
The reason provided by the user that initiated the reversal.
The date this transaction was processed.
The type of transaction (Payment, Payment Return, Payment Reversal, Void of Payment Refund, Disbursement, Disbursement Return, Disbursement Reversal)
The value that should be used in the next call to continue gathering the rest of the export data. This field will be null or 0 if there are no more records after the current response.
The number of records returned with this response (not the number of records that match the criteria)
Example Transactions Request: Example ExportTransactions Request
< soapenv:Envelope xmlns:soapenv = "[http://schemas.xmlsoap.org/soap/envelope/](http://schemas.xmlsoap.org/soap/envelope/)" xmlns:exp = "heartlandpaymentservices/ReportService/ExportService" xmlns:hps = "[http://schemas.datacontract.org/2004/07/HPS.BillerDirect.Common.Data](http://schemas.datacontract.org/2004/07/HPS.BillerDirect.Common.Data)" xmlns:arr = "[http://schemas.microsoft.com/2003/10/Serialization/Arrays](http://schemas.microsoft.com/2003/10/Serialization/Arrays)" > < soapenv:Header /> < soapenv:Body > < exp:ExportTransactions > < exp:request > < hps:Credential > < hps:Password >password</ hps:Password > < hps:UserName >DocsAPIuser</ hps:UserName > </ hps:Credential > < hps:EndDate >2016-08-31T00:00:00.000</ hps:EndDate > < hps:Merchants > < arr:string >MerchantBL</ arr:string
>
</ hps:Merchants >
< hps:RecordOffset >0</ hps:RecordOffset >
< hps:StartDate >2016-01-31T00:00:00.000</ hps:StartDate >
< hps:TimeZone >Central</ hps:TimeZone >
</ exp:request >
</ exp:ExportTransactions >
</ soapenv:Body >
</ soapenv:Envelope >
## Example ExportTransactions Response
< s:Envelope xmlns:s = "[http://schemas.xmlsoap.org/soap/envelope/](http://schemas.xmlsoap.org/soap/envelope/)" >
< s:Body >
< ExportTransactionsResponse xmlns = "heartlandpaymentservices/ReportService/ExportService" >
< ExportTransactionsResult xmlns:a = "[http://schemas.datacontract.org/2004/07/HPS.BillerDirect.Common.Data](http://schemas.datacontract.org/2004/07/HPS.BillerDirect.Common.Data)" xmlns:i = "[http://www.w3.org/2001/XMLSchema-instance](http://www.w3.org/2001/XMLSchema-instance)" >
< a:IsSuccessful >true</ a:IsSuccessful >
< a:Messages />
< a:Data >
< a:TransactionData >
< a:Amount >100.0000</ a:Amount >
< a:ApplicationAccessIP >63.241.252.2</ a:ApplicationAccessIP >
< a:ApplicationName >External-API</ a:ApplicationName >
< a:AvsResultCode i:nil = "true" />
< a:AvsResultCodeAction i:nil = "true" />
< a:AvsResultText i:nil = "true" />
< a:BatchID >378994</ a:BatchID >
< a:BillType >Bill Payment</ a:BillType >
< a:CashierName >DocsAPIuser</ a:CashierName >
< a:CustomerANI i:nil = "true" />
< a:CustomerEnteredElement1 i:nil = "true" />
< a:CustomerEnteredElement2 i:nil = "true" />
< a:CustomerEnteredElement3 i:nil = "true" />
< a:CustomerEnteredElement4 i:nil = "true" />
< a:CustomerEnteredElement5 i:nil = "true" />
< a:CustomerEnteredElement6 i:nil = "true" />
< a:CustomerEnteredElement7 i:nil = "true" />
< a:CustomerEnteredElement8 i:nil = "true" />
< a:CustomerEnteredElement9 i:nil = "true" />
< a:CvvResultCode i:nil = "true" />
< a:CvvResultCodeAction i:nil = "true" />
< a:CvvResultText i:nil = "true" />
< a:FeeAmount >3.0000</ a:FeeAmount >
< a:ID1 >100777</ a:ID1 >
< a:ID2 />
< a:ID3 />
< a:ID4 />
< a:MerchantName >MerchantBL</ a:MerchantName >
< a:ObligorAddress >123 Main St</ a:ObligorAddress >
< a:ObligorCity >Washington</ a:ObligorCity >
< a:ObligorCountry >US</ a:ObligorCountry >
< a:ObligorEmailAddress >test@test.com</ a:ObligorEmailAddress >
< a:ObligorFirstName >John</ a:ObligorFirstName >
< a:ObligorLastName >Adams</ a:ObligorLastName >
< a:ObligorMiddleName >Q</ a:ObligorMiddleName >
< a:ObligorPhoneNumber >3341112222</ a:ObligorPhoneNumber >
< a:ObligorPhoneNumberRegionCode i:nil = "true" />
< a:ObligorPostalCode >12345</ a:ObligorPostalCode >
< a:ObligorState >DC</ a:ObligorState >
< a:OrderID i:nil = "true" />
< a:OriginalTransactionID i:nil = "true" />
< a:PaymentAccount >5454</ a:PaymentAccount >
< a:PaymentMethod >Mastercard Credit</ a:PaymentMethod >
< a:PayorAddress >123 Test Street</ a:PayorAddress >
< a:PayorBusinessName i:nil = "true" />
< a:PayorCity >City</ a:PayorCity >
< a:PayorEmailAddress >test@test.com</ a:PayorEmailAddress >
< a:PayorFirstName >Test</ a:PayorFirstName >
< a:PayorLastName >Person</ a:PayorLastName >
< a:PayorMiddleName >X</ a:PayorMiddleName >
< a:PayorPhoneNumber >3345540909</ a:PayorPhoneNumber >
< a:PayorPhoneNumberRegionCode i:nil = "true" />
< a:PayorPostalCode >28540</ a:PayorPostalCode >
< a:PayorState >ST</ a:PayorState >
< a:ReferenceTransactionID i:nil = "true" />
< a:ReversalCode />
< a:ReversalCodeDescription />
< a:ReversalReason i:nil = "true" />
< a:TransactionDate >2016-04-18T14:58:06.927</ a:TransactionDate >
< a:TransactionID >326930</ a:TransactionID >
< a:TransactionType >Payment</ a:TransactionType >
</ a:TransactionData >
< a:TransactionData >
< a:Amount >100.0000</ a:Amount >
< a:ApplicationAccessIP >63.241.252.2</ a:ApplicationAccessIP >
< a:ApplicationName >External-API</ a:ApplicationName >
< a:AvsResultCode i:nil = "true" />
< a:AvsResultCodeAction i:nil = "true" />
< a:AvsResultText i:nil = "true" />
< a:BatchID >378994</ a:BatchID >
< a:BillType >Bill Payment</ a:BillType >
< a:CashierName >DocsAPIuser</ a:CashierName >
< a:CustomerANI i:nil = "true" />
< a:CustomerEnteredElement1 i:nil = "true" />
< a:CustomerEnteredElement2 i:nil = "true" />
< a:CustomerEnteredElement3 i:nil = "true" />
< a:CustomerEnteredElement4 i:nil = "true" />
< a:CustomerEnteredElement5 i:nil = "true" />
< a:CustomerEnteredElement6 i:nil = "true" />
< a:CustomerEnteredElement7 i:nil = "true" />
< a:CustomerEnteredElement8 i:nil = "true" />
< a:CustomerEnteredElement9 i:nil = "true" />
< a:CvvResultCode i:nil = "true" />
< a:CvvResultCodeAction i:nil = "true" />
< a:CvvResultText i:nil = "true" />
< a:FeeAmount >3.0000</ a:FeeAmount >
< a:ID1 >100777</ a:ID1 >
< a:ID2 />
< a:ID3 />
< a:ID4 />
< a:MerchantName >MerchantBL</ a:MerchantName >
< a:ObligorAddress >123 Main St</ a:ObligorAddress >
< a:ObligorCity >Washington</ a:ObligorCity >
< a:ObligorCountry >US</ a:ObligorCountry >
< a:ObligorEmailAddress >test@test.com</ a:ObligorEmailAddress >
< a:ObligorFirstName >John</ a:ObligorFirstName >
< a:ObligorLastName >Adams</ a:ObligorLastName >
< a:ObligorMiddleName >Q</ a:ObligorMiddleName >
< a:ObligorPhoneNumber >3341112222</ a:ObligorPhoneNumber >
< a:ObligorPhoneNumberRegionCode i:nil = "true" />
< a:ObligorPostalCode >12345</ a:ObligorPostalCode >
< a:ObligorState >DC</ a:ObligorState >
< a:OrderID i:nil = "true" />
< a:OriginalTransactionID i:nil = "true" />
< a:PaymentAccount >5454</ a:PaymentAccount >
< a:PaymentMethod >Mastercard Credit</ a:PaymentMethod >
< a:PayorAddress >123 Test Street</ a:PayorAddress >
< a:PayorBusinessName i:nil = "true" />
< a:PayorCity >City</ a:PayorCity >
< a:PayorEmailAddress >test@test.com</ a:PayorEmailAddress >
< a:PayorFirstName >Test</ a:PayorFirstName >
< a:PayorLastName >Person</ a:PayorLastName >
< a:PayorMiddleName >X</ a:PayorMiddleName >
< a:PayorPhoneNumber >3345540909</ a:PayorPhoneNumber >
< a:PayorPhoneNumberRegionCode i:nil = "true" />
< a:PayorPostalCode >28540</ a:PayorPostalCode >
< a:PayorState >ST</ a:PayorState >
< a:ReferenceTransactionID i:nil = "true" />
< a:ReversalCode />
< a:ReversalCodeDescription />
< a:ReversalReason i:nil = "true" />
< a:TransactionDate >2016-04-18T14:59:46.07</ a:TransactionDate >
< a:TransactionID >326931</ a:TransactionID >
< a:TransactionType >Payment</ a:TransactionType >
</ a:TransactionData >
< a:TransactionData >
< a:Amount >100.0000</ a:Amount >
< a:ApplicationAccessIP >63.241.252.2</ a:ApplicationAccessIP >
< a:ApplicationName >External-API</ a:ApplicationName >
< a:AvsResultCode i:nil = "true" />
< a:AvsResultCodeAction i:nil = "true" />
< a:AvsResultText i:nil = "true" />
< a:BatchID >378994</ a:BatchID >
< a:BillType >Bill Payment</ a:BillType >
< a:CashierName >DocsAPIuser</ a:CashierName >
< a:CustomerANI i:nil = "true" />
< a:CustomerEnteredElement1 i:nil = "true" />
< a:CustomerEnteredElement2 i:nil = "true" />
< a:CustomerEnteredElement3 i:nil = "true" />
< a:CustomerEnteredElement4 i:nil = "true" />
< a:CustomerEnteredElement5 i:nil = "true" />
< a:CustomerEnteredElement6 i:nil = "true" />
< a:CustomerEnteredElement7 i:nil = "true" />
< a:CustomerEnteredElement8 i:nil = "true" />
< a:CustomerEnteredElement9 i:nil = "true" />
< a:CvvResultCode i:nil = "true" />
< a:CvvResultCodeAction i:nil = "true" />
< a:CvvResultText i:nil = "true" />
< a:FeeAmount >3.0000</ a:FeeAmount >
< a:ID1 >100777</ a:ID1 >
< a:ID2 />
< a:ID3 />
< a:ID4 />
< a:MerchantName >MerchantBL</ a:MerchantName >
< a:ObligorAddress >123 Main St</ a:ObligorAddress >
< a:ObligorCity >Washington</ a:ObligorCity >
< a:ObligorCountry >US</ a:ObligorCountry >
< a:ObligorEmailAddress >test@test.com</ a:ObligorEmailAddress >
< a:ObligorFirstName >John</ a:ObligorFirstName >
< a:ObligorLastName >Adams</ a:ObligorLastName >
< a:ObligorMiddleName >Q</ a:ObligorMiddleName >
< a:ObligorPhoneNumber >3341112222</ a:ObligorPhoneNumber >
< a:ObligorPhoneNumberRegionCode i:nil = "true" />
< a:ObligorPostalCode >12345</ a:ObligorPostalCode >
< a:ObligorState >DC</ a:ObligorState >
< a:OrderID i:nil = "true" />
< a:OriginalTransactionID i:nil = "true" />
< a:PaymentAccount >5454</ a:PaymentAccount >
< a:PaymentMethod >Mastercard Credit</ a:PaymentMethod >
< a:PayorAddress >123 Test Street</ a:PayorAddress >
< a:PayorBusinessName i:nil = "true" />
< a:PayorCity >City</ a:PayorCity >
< a:PayorEmailAddress >test@test.com</ a:PayorEmailAddress >
< a:PayorFirstName >Test</ a:PayorFirstName >
< a:PayorLastName >Person</ a:PayorLastName >
< a:PayorMiddleName >X</ a:PayorMiddleName >
< a:PayorPhoneNumber >3345540909</ a:PayorPhoneNumber >
< a:PayorPhoneNumberRegionCode i:nil = "true" />
< a:PayorPostalCode >28540</ a:PayorPostalCode >
< a:PayorState >ST</ a:PayorState >
< a:ReferenceTransactionID i:nil = "true" />
< a:ReversalCode />
< a:ReversalCodeDescription />
< a:ReversalReason i:nil = "true" />
< a:TransactionDate >2016-04-18T14:59:54.723</ a:TransactionDate >
< a:TransactionID >326932</ a:TransactionID >
< a:TransactionType >Payment</ a:TransactionType >
</ a:TransactionData >
</ a:Data >
< a:NextRecordOffset >0</ a:NextRecordOffset >
< a:RecordsReturned >3</ a:RecordsReturned >
</ ExportTransactionsResult >
</ ExportTransactionsResponse >
</ s:Body >
</ s:Envelope >
