POST v1/Generic/PaymentHistoryList

Get payment history list based on customerId or all customers

This is secure method and requires below attributes in header

Authorization: PRC Authorize Token
Authorization: Midnight Authorize Token
MISKEY: MIS Key

Request Information

URI Parameters

None.

Body Parameters

PaymentHistoryRequestLazyLoading
NameDescriptionTypeAdditional information
TableFilterModel

TableFilterModel

None.

StartDate

Provide the Start Date for Date Limit in MM/dd/YYYY Format

string

None.

EndDate

Provide the End Date for Date Limit in MM/dd/YYYY Format

string

None.

CustomerID

Provide Customer ID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "TableFilterModel": {
    "Filters": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "First": 1,
    "Rows": 2,
    "SortField": "sample string 3",
    "SortOrder": 4,
    "MultiSortMeta": [
      {
        "Field": "sample string 1",
        "Order": 2
      },
      {
        "Field": "sample string 1",
        "Order": 2
      }
    ]
  },
  "StartDate": "sample string 1",
  "EndDate": "sample string 2",
  "CustomerID": 3
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PaymentHistoryRequestLazyLoading'.

Response Information

Response Formats

application/json, text/json

Sample:
[
  {
    "CustomerPaymentID": 1,
    "CustomerPaymentNumber": "sample string 2",
    "transactionID": "sample string 3",
    "createDate": "2024-04-23T08:09:34.431037-04:00",
    "customerName": "sample string 5",
    "customerCode": "sample string 6",
    "amountDetails": {
      "paymentAmount": 1.0,
      "surchargeAmount": 2.0
    },
    "invoicesPaid": [
      {
        "InvoiceId": "sample string 1",
        "InvoiceNumber": "sample string 2",
        "paymentAmount": 3.0,
        "OrderNumber": "sample string 4"
      },
      {
        "InvoiceId": "sample string 1",
        "InvoiceNumber": "sample string 2",
        "paymentAmount": 3.0,
        "OrderNumber": "sample string 4"
      }
    ],
    "isSuccessfull": true,
    "paymentMethod": 8,
    "email": "sample string 9",
    "CardLast4": "sample string 10",
    "PaymentMethodDescription": "sample string 11",
    "CardEntryContext": "sample string 12",
    "CardEntryMethod": "sample string 13",
    "NameonAccount": "sample string 14",
    "HostResponseCode": "sample string 15",
    "ApprovalNumber": "sample string 16",
    "SurchargeName": "sample string 17",
    "Token": "sample string 18",
    "IsVoided": true,
    "RefNumber": "sample string 20",
    "PaymentType": "sample string 21",
    "SubTotal": 22.1,
    "TotalAmount": 23.1,
    "SurchargeAmount": 24.1,
    "TaxAmount": 25.1,
    "TotalRecords": 26,
    "IsInvoiceEnabled": true,
    "IsInvoiceCount": 28,
    "RoutingNumber": "sample string 29"
  },
  {
    "CustomerPaymentID": 1,
    "CustomerPaymentNumber": "sample string 2",
    "transactionID": "sample string 3",
    "createDate": "2024-04-23T08:09:34.431037-04:00",
    "customerName": "sample string 5",
    "customerCode": "sample string 6",
    "amountDetails": {
      "paymentAmount": 1.0,
      "surchargeAmount": 2.0
    },
    "invoicesPaid": [
      {
        "InvoiceId": "sample string 1",
        "InvoiceNumber": "sample string 2",
        "paymentAmount": 3.0,
        "OrderNumber": "sample string 4"
      },
      {
        "InvoiceId": "sample string 1",
        "InvoiceNumber": "sample string 2",
        "paymentAmount": 3.0,
        "OrderNumber": "sample string 4"
      }
    ],
    "isSuccessfull": true,
    "paymentMethod": 8,
    "email": "sample string 9",
    "CardLast4": "sample string 10",
    "PaymentMethodDescription": "sample string 11",
    "CardEntryContext": "sample string 12",
    "CardEntryMethod": "sample string 13",
    "NameonAccount": "sample string 14",
    "HostResponseCode": "sample string 15",
    "ApprovalNumber": "sample string 16",
    "SurchargeName": "sample string 17",
    "Token": "sample string 18",
    "IsVoided": true,
    "RefNumber": "sample string 20",
    "PaymentType": "sample string 21",
    "SubTotal": 22.1,
    "TotalAmount": 23.1,
    "SurchargeAmount": 24.1,
    "TaxAmount": 25.1,
    "TotalRecords": 26,
    "IsInvoiceEnabled": true,
    "IsInvoiceCount": 28,
    "RoutingNumber": "sample string 29"
  }
]

application/xml, text/xml

Sample:
<ArrayOfPrintReachPayTransactionDetailResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PrintReachPayTransactionDetailResponse>
    <CustomerPaymentID>1</CustomerPaymentID>
    <CustomerPaymentNumber>sample string 2</CustomerPaymentNumber>
    <TransactionID>sample string 3</TransactionID>
    <TransactionDate>2024-04-23T08:09:34.431037-04:00</TransactionDate>
    <CustomerName>sample string 5</CustomerName>
    <customerCode>sample string 6</customerCode>
    <amountDetails>
      <paymentAmount>1</paymentAmount>
      <surchargeAmount>2</surchargeAmount>
    </amountDetails>
    <InvoicesPaid>
      <InvoicesPaid>
        <InvoiceId>sample string 1</InvoiceId>
        <InvoiceNumber>sample string 2</InvoiceNumber>
        <paymentAmount>3</paymentAmount>
        <OrderNumber>sample string 4</OrderNumber>
      </InvoicesPaid>
      <InvoicesPaid>
        <InvoiceId>sample string 1</InvoiceId>
        <InvoiceNumber>sample string 2</InvoiceNumber>
        <paymentAmount>3</paymentAmount>
        <OrderNumber>sample string 4</OrderNumber>
      </InvoicesPaid>
    </InvoicesPaid>
    <isSuccessfull>true</isSuccessfull>
    <PaymentMethod>8</PaymentMethod>
    <email>sample string 9</email>
    <CardLast4>sample string 10</CardLast4>
    <PaymentMethodDescription>sample string 11</PaymentMethodDescription>
    <CardEntryContext>sample string 12</CardEntryContext>
    <CardEntryMethod>sample string 13</CardEntryMethod>
    <NameonAccount>sample string 14</NameonAccount>
    <HostResponseCode>sample string 15</HostResponseCode>
    <ApprovalNumber>sample string 16</ApprovalNumber>
    <SurchargeName>sample string 17</SurchargeName>
    <Token>sample string 18</Token>
    <IsVoided>true</IsVoided>
    <RefNumber>sample string 20</RefNumber>
    <PaymentType>sample string 21</PaymentType>
    <SubTotal>22.1</SubTotal>
    <TotalAmount>23.1</TotalAmount>
    <SurchargeAmount>24.1</SurchargeAmount>
    <TaxAmount>25.1</TaxAmount>
    <TotalRecords>26</TotalRecords>
    <IsInvoiceEnabled>true</IsInvoiceEnabled>
    <IsInvoiceCount>28</IsInvoiceCount>
    <RoutingNumber>sample string 29</RoutingNumber>
  </PrintReachPayTransactionDetailResponse>
  <PrintReachPayTransactionDetailResponse>
    <CustomerPaymentID>1</CustomerPaymentID>
    <CustomerPaymentNumber>sample string 2</CustomerPaymentNumber>
    <TransactionID>sample string 3</TransactionID>
    <TransactionDate>2024-04-23T08:09:34.431037-04:00</TransactionDate>
    <CustomerName>sample string 5</CustomerName>
    <customerCode>sample string 6</customerCode>
    <amountDetails>
      <paymentAmount>1</paymentAmount>
      <surchargeAmount>2</surchargeAmount>
    </amountDetails>
    <InvoicesPaid>
      <InvoicesPaid>
        <InvoiceId>sample string 1</InvoiceId>
        <InvoiceNumber>sample string 2</InvoiceNumber>
        <paymentAmount>3</paymentAmount>
        <OrderNumber>sample string 4</OrderNumber>
      </InvoicesPaid>
      <InvoicesPaid>
        <InvoiceId>sample string 1</InvoiceId>
        <InvoiceNumber>sample string 2</InvoiceNumber>
        <paymentAmount>3</paymentAmount>
        <OrderNumber>sample string 4</OrderNumber>
      </InvoicesPaid>
    </InvoicesPaid>
    <isSuccessfull>true</isSuccessfull>
    <PaymentMethod>8</PaymentMethod>
    <email>sample string 9</email>
    <CardLast4>sample string 10</CardLast4>
    <PaymentMethodDescription>sample string 11</PaymentMethodDescription>
    <CardEntryContext>sample string 12</CardEntryContext>
    <CardEntryMethod>sample string 13</CardEntryMethod>
    <NameonAccount>sample string 14</NameonAccount>
    <HostResponseCode>sample string 15</HostResponseCode>
    <ApprovalNumber>sample string 16</ApprovalNumber>
    <SurchargeName>sample string 17</SurchargeName>
    <Token>sample string 18</Token>
    <IsVoided>true</IsVoided>
    <RefNumber>sample string 20</RefNumber>
    <PaymentType>sample string 21</PaymentType>
    <SubTotal>22.1</SubTotal>
    <TotalAmount>23.1</TotalAmount>
    <SurchargeAmount>24.1</SurchargeAmount>
    <TaxAmount>25.1</TaxAmount>
    <TotalRecords>26</TotalRecords>
    <IsInvoiceEnabled>true</IsInvoiceEnabled>
    <IsInvoiceCount>28</IsInvoiceCount>
    <RoutingNumber>sample string 29</RoutingNumber>
  </PrintReachPayTransactionDetailResponse>
</ArrayOfPrintReachPayTransactionDetailResponse>