GetCardsExpirationList

Description

The GetCardsExpirationList returns basic customer information, including the number of cards that have already expired and those set to expire within specified timeframes. The results can also be filtered as needed.

Syntax

CardsExpirationListSearchResult GetCardsExpirationList(SecurityToken securityToken, SearchFilter[] filters, int start, int limit, string sort, bool countOnly)

Arguments

Type	Name	Req.	Description
SecurityToken	securityToken	R	A unique token that is used to identify a merchant and authenticate the API request.
SearchFilter[]	filters	S	Filters CardExpirationCounts objects based on one or more field names, comparison operators, and field values. See supported search parameters below. Note: If the SearchFilter object is empty, all CardExpirationCounts objects will be returned.
int	start	R	Index of the first object to return in the array. Note: Must be ≥ 0.
int	limit	R	Maximum number of objects to return. Note: Must be > 0.
string	sort	O	Sorts by field name. See the list of supported sort parameters below.
bool	countOnly	R	Whether the response should include only the total count of matching objects, excluding the objects themselves.

Return Value

Type	Description
CardsExpirationListSearchResult	Returns an array of CardExpirationCounts objects along with the start, limit and count. Otherwise, returns a fault.

Supported Search/Sort Parameters

CustomerId Unique identifier for the customer.

  <pre>
    <code>
      `<ebiz:SearchFilter>`
      ` <ebiz:FieldName>CustomerId</ebiz:FieldName>`
       `<ebiz:ComparisonOperator>ne</ebiz:ComparisonOperator>`
      ` <ebiz:FieldValue>CBS712312412</ebiz:FieldValue>`
      `</ebiz:SearchFilter>`
    </code>
  </pre>
</tr>

<tr>
  <td>FirstName</td>
  <td>First name of the customer.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>FirstName</ebiz:FieldName>`
         `<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>Bob</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>LastName</td>
  <td>Last name of the customer.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>LastName</ebiz:FieldName>`
         `<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>Smith</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>CompanyName</td>
  <td>Name of the company linked to the customer.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>CompanyName</ebiz:FieldName>`
         `<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>EBizCharge</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>Phone</td>
  <td>Phone number of the customer.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>Phone</ebiz:FieldName>`
         `<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>1-234-567-8910</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>Email</td>
  <td>Email of the customer.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>Email</ebiz:FieldName>`
         `<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>[email protected]</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>SoftwareId</td>
  <td>Unique identifier of the integration.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>SoftwareId</ebiz:FieldName>`
         `<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>123456</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>DivisionId</td>
  <td>Unique identifier for the division.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>DivisionId</ebiz:FieldName>`
         `<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>123456</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>WebSite</td>
  <td>The website attached to the customer record.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>WebSite</ebiz:FieldName>`
         `<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>ebizcharge.com</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>CellPhone</td>
  <td>Cell phone number of the customer.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>CellPhone</ebiz:FieldName>`
         `<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>1-234-567-8910</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>Fax</td>
  <td>Fax number of the customer.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>Fax</ebiz:FieldName>`
         `<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>1-234-567-8910</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

<tr>
  <td>MerchantId</td>
  <td>Unique identifier of the merchant.</td>

  <td>
    <pre>
      <code>
        `<ebiz:SearchFilter>`
        ` <ebiz:FieldName>MerchantId</ebiz:FieldName>`
         `<ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>`
        ` <ebiz:FieldValue>merchant1</ebiz:FieldValue>`
        `</ebiz:SearchFilter>`
      </code>
    </pre>
  </td>
</tr>

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:GetCardsExpirationList>
         <ebiz:securityToken>
            <ebiz:SecurityId>************-3703-4ac4-90b3-*********</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:filters>
            <!--Zero or more repetitions:-->
            <ebiz:SearchFilter>
               <ebiz:FieldName>CustomerInternalId</ebiz:FieldName>
               <ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>
               <ebiz:FieldValue>************-46a8-909a-************</ebiz:FieldValue>
            </ebiz:SearchFilter>
         </ebiz:filters>
         <ebiz:start>0</ebiz:start>
         <ebiz:limit>2</ebiz:limit>
         <ebiz:sort/>
         <ebiz:countOnly>false</ebiz:countOnly>
      </ebiz:GetCardsExpirationList>
   </soapenv:Body>
</soapenv:Envelope>

eBizService apiClient = new eBizService();
SecurityToken securityToken = new SecurityToken
{
  SecurityId = "********-c870-41b8-aa5c-********",
  UserId = "",
  Password = ""
  };

SearchFilter[] filters = new SearchFilter[1];
SearchFilter filter1 = new SearchFilter();
filter1.FieldName = "CustomerId";
filter1.ComparisonOperator = "eq";
filter1.FieldValue = "custID001";
filters[0] = filter1;

int start = 0;
int limit = 1;
string sort = "";
bool countOnly = false;

CardsExpirationListSearchResult result = client.GetCardsExpirationList(securityToken, filters, start, 1, null, false);

$client = new SoapClient('Endpoint URL');
$securityToken = array(
  'SecurityId' => '********-1b21-421b-86ce-***********',
  'UserId' => 'merchant1',
  'Password' => 'merchant1'
);

$params = array(
  'securityToken' => $securityToken
  ,'filters' => 
  array(
    array(
      'FieldName' => 'CustomerId'
      ,'ComparisonOperator' => 'eq' 
      ,'FieldValue' => 'test-customer'
    )
  )
  ,'start' => 0
  ,'limit' => 10
  ,'sort' => null
  ,'countOnly' => true
);
$result2 = $client->GetCardsExpirationList($params);

Example 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">
      <GetCardsExpirationListResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetCardsExpirationListResult>
            <CardExpirationCountsList>
               <CardExpirationCounts>
                  <CustomerInformation>
                     <CustomerInternalId>************ewe-3703-4ac4-90b3-*********</CustomerInternalId>
                     <CustomerId/>
                     <FirstName/>
                     <LastName/>
                     <CompanyName/>
                     <Email>[email protected]</Email>
                  </CustomerInformation>
                  <ExpiredCreditCardsCount>0</ExpiredCreditCardsCount>
                  <ExpireThisMonthCreditCardsCount>0</ExpireThisMonthCreditCardsCount>
                  <ExpireNextMonthCreditCardsCount>0</ExpireNextMonthCreditCardsCount>
                  <ExpireWithin3MonthCreditCardsCount>0</ExpireWithin3MonthCreditCardsCount>
                  <ExpireWithin6MonthCreditCardsCount>0</ExpireWithin6MonthCreditCardsCount>
                  <ExpireWithinaYearCreditCardsCount>0</ExpireWithinaYearCreditCardsCount>
                  <ExpireWithinXDaysCreditCardsCount>0</ExpireWithinXDaysCreditCardsCount>
               </CardExpirationCounts>
               <CardExpirationCounts>
                  <CustomerInformation>
                     <CustomerInternalId>d9541cc1-b005-4fd9-a126-81efdf4349ec</CustomerInternalId>
                     <CustomerId>Automation-Customer</CustomerId>
                     <FirstName/>
                     <LastName/>
                     <CompanyName/>
                     <Email/>
                  </CustomerInformation>
                  <ExpiredCreditCardsCount>0</ExpiredCreditCardsCount>
                  <ExpireThisMonthCreditCardsCount>0</ExpireThisMonthCreditCardsCount>
                  <ExpireNextMonthCreditCardsCount>0</ExpireNextMonthCreditCardsCount>
                  <ExpireWithin3MonthCreditCardsCount>0</ExpireWithin3MonthCreditCardsCount>
                  <ExpireWithin6MonthCreditCardsCount>0</ExpireWithin6MonthCreditCardsCount>
                  <ExpireWithinaYearCreditCardsCount>0</ExpireWithinaYearCreditCardsCount>
                  <ExpireWithinXDaysCreditCardsCount>0</ExpireWithinXDaysCreditCardsCount>
               </CardExpirationCounts>
            </CardExpirationCountsList>
            <Start>0</Start>
            <Limit>2</Limit>
            <Count>2</Count>
         </GetCardsExpirationListResult>
      </GetCardsExpirationListResponse>
   </s:Body>
</s:Envelope>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:InvalidData</faultcode>
         <faultstring xml:lang="en-US">Invalid data: Error: The number of rows provided for a FETCH clause must be greater then zero.</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>