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

TypeNameDescription
SecurityToken securityTokenMerchant security token: used to identify merchant and validate transaction. (required)
fromDateTimefromDateTimeFrom date and Time. (required)
toDateTimetoDateTimeTo Date time. (required)
SearchFilterFiltersTo search surcharge payments. (optional)
BooleancountOnlyCount Only. (required)
IntstartStarting index for search. (required)
IntlimitEnding index for search. (required)
StringsortTo sort the data. (optional).

Return Value

TypeDescription
SurchargeSearchResultReturns results of search surcharge request.

Examples

Request:

<ebiz:SearchSurchargePayments>
         <!--Optional:-->
         <ebiz:securityToken>
            <!--Optional:-->
            <ebiz:SecurityId>*******-****-402e-8ce1-********</ebiz:SecurityId>
            <!--Optional:-->
            <ebiz:UserId></ebiz:UserId>
            <!--Optional:-->
            <ebiz:Password></ebiz:Password>
         </ebiz:securityToken>
         <ebiz:fromDateTime>2021-09-01</ebiz:fromDateTime>
         <ebiz:toDateTime>2022-09-10</ebiz:toDateTime>
         <!--Optional:-->
         <ebiz:countOnly>0</ebiz:countOnly>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>100</ebiz:limit>
         <!--Optional:-->
         <ebiz:sort>0</ebiz:sort>
      </ebiz:SearchSurchargePayments>

Response:
<Surcharge>
                  <SurchargeInternalId>******-*****-4c2c-9bb2-********</SurchargeInternalId>
                  <AuthCode>979747</AuthCode>
                  <RefNum>3125284068</RefNum>
                  <Last4>2225</Last4>
                  <PaymentMethodType>American Express</PaymentMethodType>
                  <DatePaid>9/15/2021 6:44:38 PM</DatePaid>
                  <TotalSurchargeAmount>8.7500</TotalSurchargeAmount>
                  <PaymentMethodId>21</PaymentMethodId>
                  <PaymentSourceId>EmailPaymentForm</PaymentSourceId>
                  <SurchargePercentage>3.5000</SurchargePercentage>
                  <TotalPaidAmount>258.7500</TotalPaidAmount>
                  <Currency>USD</Currency>
                  <PaidDocuments>
                     <PaidDocument>
                        <CustomerId>58</CustomerId>
                        <DivisionId></DivisionId>
                        <DocumentNumber>1039</DocumentNumber>
                        <DocumentInternalId>********-9cfb-4bab-9e2c-********</DocumentInternalId>
                        <DocumentTypeId>Invoice</DocumentTypeId>
                        <PaidAmount>250.0000</PaidAmount>
                     </PaidDocument>
                  </PaidDocuments>
                  <IsApplied>false</IsApplied>
                  <DateApplied/>
               </Surcharge>