SearchTerms

Description

This method is used to search terms.

Syntax

Terms[] SearchTerms(SecurityToken securityToken , string termsInternalId, string termsId, int start, int limit, string sort).

Arguments

Type

Name

Description

SecurityToken

securityToken

Merchant security token: used to identify merchant and validate transaction. (required)

String

termsInternalId

Unique internal terms ID assigned by EBizCharge. (required)

String

termsId

Terms ID. (required)

Int

start

Start position, defaults to 0 (first payment found). (required)

Int

limit

Maximum number of payments to return in result. Default Max 1000. (required)

String

sort

Field name to sort the results by. (optional)

Return Value

Type

Description

Terms[]

Returns an array of terms matching the specified search parameters.

Example

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header />
   <soapenv:Body>
      <ebiz:SearchTerms>
         <ebiz:securityToken>
            <ebiz:SecurityId>********-55ee-434c-b126-f630f2486a2d</ebiz:SecurityId>
            <ebiz:UserId />
            <ebiz:Password />
         </ebiz:securityToken>
         <ebiz:termsInternalId />
         <ebiz:termsId>T-0001</ebiz:termsId>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>10</ebiz:limit>
         <ebiz:sort>true</ebiz:sort>
      </ebiz:SearchTerms>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <SearchTermsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchTermsResult>
            <Terms>
               <TermsInternalId>********-1838-4b16-b38c-3b801ed8822f</TermsInternalId>
               <TermsId>T-0001</TermsId>
               <TermsName>Net30</TermsName>
               <TermsDescription />
               <NetDueInDays>30</NetDueInDays>
               <DiscountPercentage>4.00</DiscountPercentage>
               <DiscountIfPaidWithinDays>4</DiscountIfPaidWithinDays>
               <IsInactive>false</IsInactive>
            </Terms>
         </SearchTermsResult>
      </SearchTermsResponse>
   </s:Body>
</s:Envelope>