MarkCustomerAsInactive

Description

The MarkCustomerAsInactive method marks a Customer as inactive.

If this object is marked as inactive, it will no longer be returned by the GetCustomer, SearchCustomers, and SearchCustomerList methods.

Syntax

CustomerResponse MarkCustomerAsInactive(SecurityToken securityToken, string customerInternalId)

Arguments

Type	Name	Req.	Description
SecurityToken	securityToken	R	A unique token that is used to identify a merchant and authenticate the API request.
string	customerInternalId	R	Internal ID of the Customer to mark as inactive.

Return Value

Type	Description
CustomerResponse	Indicates whether the Customer was successfully marked as inactive. Otherwise, a fault is returned.

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header />
   <soapenv:Body>
      <ebiz:MarkCustomerAsInactive>
         <ebiz:securityToken>
            <ebiz:SecurityId>********-23f6-4466-a993-************</ebiz:SecurityId>
            <ebiz:UserId />
            <ebiz:Password />
         </ebiz:securityToken>
         <ebiz:customerInternalId>********-0b2a-44ed-90be-************</ebiz:customerInternalId>
      </ebiz:MarkCustomerAsInactive>
   </soapenv:Body>
</soapenv:Envelope>

public void MarkCustomerAsInactive()
{
  eBizService apiClient = new eBizService();
  SecurityToken securityToken = new SecurityToken
  {
    SecurityId = "*******-c870-41b8-aa5c-************",
    UserId = "",
    Password = ""
    };
  var response = apiClient.MarkCustomerAsInactive(securityToken, "*************-4aad-ae21-************");
  Console.WriteLine(response.Status);
  Console.WriteLine(response.StatusCode);
  Console.WriteLine(response.Error);
  Console.WriteLine(response.ErrorCode);
  Console.ReadLine();
}

public function MarkCustomerAsInactive()
{
  $client = new SoapClient('End point URL');
  $securityToken = array(
    'SecurityId' => '******-454757-4567457-***',
    'UserId' => 'merchant1',
    'Password' => 'merchant1'
  );

  $response = $client->MarkCustomerAsInactive(
    array(
      'securityToken' => $securityToken,
      'customerInternalId' => '***-345435-45435-***',
    )
  );

  $result = $response->MarkCustomerAsInactiveResult;
}

Example 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">
      <MarkCustomerAsInactiveResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <MarkCustomerAsInactiveResult>
            <CustomerId>****-273-282-****</CustomerId>
            <CustomerInternalId>********-0b2a-44ed-90be-************</CustomerInternalId>
            <Status>Success</Status>
            <StatusCode>1</StatusCode>
            <Error />
            <ErrorCode>0</ErrorCode>
         </MarkCustomerAsInactiveResult>
      </MarkCustomerAsInactiveResponse>
   </s:Body>
</s:Envelope>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:InvalidCustomerInternalId</faultcode>
         <faultstring xml:lang="en-US">Invalid CustomerInternalId</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>