GET reports/paymenthistory?StartIndex={StartIndex}&MaxRecords={MaxRecords}&RangeBeginUtc={RangeBeginUtc}&RangeEndUtc={RangeEndUtc}&AmountTotal={AmountTotal}&CardLastFour={CardLastFour}&RelatedTransactionId={RelatedTransactionId}&AuthCode={AuthCode}&Rrn={Rrn}&Stan={Stan}&PaymentCardType={PaymentCardType}&DeviceAddress={DeviceAddress}&InvoiceNumber={InvoiceNumber}&ReceiptId={ReceiptId}&ClientTransactionIdentifier={ClientTransactionIdentifier}

Returns a collection of payments records from a search of an account's transaction history using a given filter (e.g., by date, by amount, or by last four digits of the payment card).

Request Information

URI Parameters

Name	Description	Type	Additional information
StartIndex	Zero based start index of the result set.	integer	Required Range: inclusive between 0 and 2147483647
MaxRecords	Maximum number records to return.	integer	Required Range: inclusive between 1 and 100
RangeBeginUtc	Transaction timeframe representing the oldest/least recent end of a filtered date range.	date	None.
RangeEndUtc	Transaction timeframe representing the newest/most recent end of a filtered date range.	date	None.
AmountTotal	Exact transaction total amount.	decimal number	Range: inclusive between 0 and 999999
CardLastFour	The last four digits of the payment card number (PAN).	string	String length: inclusive between 4 and 4
RelatedTransactionId	Set of transactions that share the same parent transaction ID as a given transaction.	integer	Range: inclusive between 1 and 2147483647
AuthCode	Authorization code that is assigned by the issuing institution.	string	String length: inclusive between 1 and 10
Rrn	Retrieval Reference Number (RRN) optionally assigned by the processor.	string	String length: inclusive between 1 and 16
Stan	Payment gateway assigned identification number for a given transaction.	integer	Range: inclusive between 1 and 2147483647
PaymentCardType	Payment card type that was used for the transaction, entitlement or otherwise.	PaymentCardType	None.
DeviceAddress	Payment gateway specific identifier required to process the payment. This value may be auto assigned depending on the configuration.	string	String length: inclusive between 5 and 25
InvoiceNumber	The invoice number optionally assigned to the transaction.	string	Matching regular expression pattern: ^^(?!\s)[a-zA-Z0-9]{0,9}\S$
ReceiptId	Payment gateway assigned value for the receipt record.	integer	Range: inclusive between 1 and 2147483647
ClientTransactionIdentifier	Optional client assigned value to identify the transaction.	string	String length: inclusive between 1 and 50

Body Parameters

None.

Response Information

Resource Description

Returns a collection of payments records from a search of an account's transaction history using a given filter (e.g., by date, by amount, or by last four digits of the payment card).

PaymentHistoryResponse

Name	Description	Type	Additional information
ResultCount	The number (count) of results found, not results returned.	integer	Required
Payments	The payment history record collection.	Collection of PaymentHistoryRecord	Required

Response Formats

application/json, text/json

Sample:

{
  "ResultCount": 1,
  "Payments": [
    {
      "BatchNumber": 1,
      "IsRefund": true,
      "ParentHostTransactionId": 3,
      "RelatedTransactionCount": 4,
      "TransactionType": "sample string 5",
      "PaymentRequestData": {
        "UniqueIdentifier": "sample string 1",
        "TimeStamp": "2024-04-19T23:50:04.634Z",
        "Description": "sample string 3",
        "InvoiceNumber": "sample string 4",
        "CheckNumber": "sample string 5",
        "GeotagInfo": {
          "Longitude": 1.1,
          "Latitude": 2.1
        },
        "Amounts": {
          "SubTotal": 1.0,
          "Tax": 2.0,
          "Tip": 3.0,
          "Surcharge": 4.0,
          "OriginalAmount": 5.0,
          "Total": 6.0
        },
        "CardLastFour": "sample string 6",
        "EntryMethod": "sample string 7",
        "CardType": "sample string 8",
        "Operator": "sample string 9",
        "CardPresent": true,
        "Stan": 11,
        "CustomerCode": "sample string 12"
      },
      "PaymentResponseData": {
        "AuthCode": "sample string 1",
        "AvsResponseCode": "sample string 2",
        "AvsResponseText": "sample string 3",
        "CardType": "sample string 4",
        "CardSubType": "sample string 5",
        "CardHolderName": "sample string 6",
        "CardReaderName": "sample string 7",
        "CardReaderEMVCapable": true,
        "CVMType": "sample string 9",
        "CvvResponseCode": "sample string 10",
        "CvvResponseText": "sample string 11",
        "EmvReceiptTlv": "sample string 12",
        "TransactionReferenceNumber": "sample string 13",
        "ValidationCode": "sample string 14",
        "VisaRewardsProgramIdentifier": "sample string 15",
        "EntryMode": "sample string 16",
        "EntryModeType": "sample string 17",
        "ReceiptId": 1,
        "RRN": "sample string 18",
        "HostTransactionId": 19,
        "ResponseCode": "sample string 20",
        "ResponseText": "sample string 21"
      },
      "GatewayProcessingData": {
        "DeviceAddress": "sample string 1",
        "NetworkId": 2,
        "MerchantName": "sample string 3",
        "TerminalName": "sample string 4"
      }
    },
    {
      "BatchNumber": 1,
      "IsRefund": true,
      "ParentHostTransactionId": 3,
      "RelatedTransactionCount": 4,
      "TransactionType": "sample string 5",
      "PaymentRequestData": {
        "UniqueIdentifier": "sample string 1",
        "TimeStamp": "2024-04-19T23:50:04.634Z",
        "Description": "sample string 3",
        "InvoiceNumber": "sample string 4",
        "CheckNumber": "sample string 5",
        "GeotagInfo": {
          "Longitude": 1.1,
          "Latitude": 2.1
        },
        "Amounts": {
          "SubTotal": 1.0,
          "Tax": 2.0,
          "Tip": 3.0,
          "Surcharge": 4.0,
          "OriginalAmount": 5.0,
          "Total": 6.0
        },
        "CardLastFour": "sample string 6",
        "EntryMethod": "sample string 7",
        "CardType": "sample string 8",
        "Operator": "sample string 9",
        "CardPresent": true,
        "Stan": 11,
        "CustomerCode": "sample string 12"
      },
      "PaymentResponseData": {
        "AuthCode": "sample string 1",
        "AvsResponseCode": "sample string 2",
        "AvsResponseText": "sample string 3",
        "CardType": "sample string 4",
        "CardSubType": "sample string 5",
        "CardHolderName": "sample string 6",
        "CardReaderName": "sample string 7",
        "CardReaderEMVCapable": true,
        "CVMType": "sample string 9",
        "CvvResponseCode": "sample string 10",
        "CvvResponseText": "sample string 11",
        "EmvReceiptTlv": "sample string 12",
        "TransactionReferenceNumber": "sample string 13",
        "ValidationCode": "sample string 14",
        "VisaRewardsProgramIdentifier": "sample string 15",
        "EntryMode": "sample string 16",
        "EntryModeType": "sample string 17",
        "ReceiptId": 1,
        "RRN": "sample string 18",
        "HostTransactionId": 19,
        "ResponseCode": "sample string 20",
        "ResponseText": "sample string 21"
      },
      "GatewayProcessingData": {
        "DeviceAddress": "sample string 1",
        "NetworkId": 2,
        "MerchantName": "sample string 3",
        "TerminalName": "sample string 4"
      }
    }
  ]
}