SearchSurchargePayments

Description

This method searches surcharge payments.

Syntax

SurchargeSearchResult SearchSurchargePayments (SecurityToken, DateTime fromDateTime, DateTime toDateTime, SearchFilter filters, bool countOnly, Int start, Int Limit, String sort)

Arguments

Type	Name	Description
SecurityToken	securityToken	Merchant security token: used to identify merchant and validate transaction. (required)
fromDateTime	fromDateTime	From Date and Time. (required)
toDateTime	toDateTime	To Date and Time. (required)
SearchFilter	Filters	To filter returned results. (required)
Boolean	countOnly	Count Only. (required)
Int	start	Starting index for search. (required)
Int	limit	Maximum number of search results to return in response. (required)
String	sort	To sort the data. (optional).

Return Value

Type	Description
SurchargeSearchResult	Returns results of search surcharge request.

Examples

Request:

soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:SearchSurchargePayments>
        <ebiz:securityToken>
            <ebiz:SecurityId>********-0be8-4bf0-91cd-**********</ebiz:SecurityId>
            <ebiz:UserId>usertesting</ebiz:UserId>
            <ebiz:Password>*********</ebiz:Password>
         </ebiz:securityToken>
         <ebiz:fromDateTime>2023-01-01</ebiz:fromDateTime>
         <ebiz:toDateTime>2024-01-01</ebiz:toDateTime>
         <ebiz:countOnly>false</ebiz:countOnly>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>1000</ebiz:limit>
         <ebiz:sort></ebiz:sort>
      </ebiz:SearchSurchargePayments>
   </soapenv:Body>
</soapenv:Envelope>

Response:
                  
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <SearchSurchargePaymentsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchSurchargePaymentsResult>
            <Surcharges>
               <Surcharge>
                  <SurchargeInternalId>********-df48-4fb9-8c7e-********</SurchargeInternalId>
                  <AuthCode>065**9</AuthCode>
                  <RefNum>*****46641</RefNum>
                  <Last4>**39</Last4>
                  <PaymentMethodType>Visa</PaymentMethodType>
                  <DatePaid>3/30/2023 3:55:40 PM</DatePaid>
                  <TotalSurchargeAmount>0.1500</TotalSurchargeAmount>
                  <PaymentMethodId/>
                  <PaymentSourceId>EBizCharge *******</PaymentSourceId>
                  <SurchargePercentage>2.5000</SurchargePercentage>
                  <TotalPaidAmount>6.1500</TotalPaidAmount>
                  <Currency>USD</Currency>
                  <PaidDocuments>
                     <PaidDocument>
                        <CustomerId>ID0001</CustomerId>
                        <DivisionId/>
                        <DocumentNumber>HELLO1</DocumentNumber>
                        <DocumentInternalId/>
                        <DocumentTypeId>Invoice</DocumentTypeId>
                        <PaidAmount>6.0000</PaidAmount>
                     </PaidDocument>
                  </PaidDocuments>
                  <IsApplied>false</IsApplied>
                  <DateApplied/>
               </Surcharge>
            </Surcharges>
            <Start>0</Start>
            <Limit>1</Limit>
            <Count>1</Count>
         </SearchSurchargePaymentsResult>
      </SearchSurchargePaymentsResponse>
   </s:Body>
</s:Envelope>

Updated over 1 year ago