developer:soap:methods:disablecustomer

Soap API v1.2

disableCustomer

Disable the recurring billing for a customer specified by CustNum.

Description

This method allows you to stop a customer's recurring billing cycle using the CustNum (unique customer number assigned by the gateway) as a reference. If you have lost or cannot remember the customer's CustNum, use the searchCustomerID method to retrieve it.

You can resume a customer's recurring billing cycle at any time using the enableCustomer method.

See also runCustomerTransaction, enableCustomer, deleteCustomer, searchCustomerID, getCustomer, searchCustomers, getCustomerHistory, addCustomer, addCustomerPaymentMethod, deleteCustomerPaymentMethod, updateCustomer, quickUpdateCustomer

Syntax

boolean disableCustomer ( ueSecurityToken Token, integer CustNum )

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
integer CustNum A unique customer number assigned by the gateway.

Return Value

boolean Returns confirmation of the disable recurring billing request only if request is successful. If request fails, an exception will be thrown.

Examples

PHP

For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.

<?php 
 
try { 
 
  $custnum='56805'; 
 
  print_r($client->disableCustomer($token,$custnum)); 
 
  } 
 
catch(SoapFault $e) { 
 
  echo $e->getMessage(); 
  } 
 
?> 

Java

This example uses the USAePay Java library. For directions on how to install the library and create the token/client objects, go to either the Java JAX-RPC Howto or the Java JAX-WS Howto.

try {
  //Set CustNum for the Customer that you want to disable
  BigInteger CustNum = new BigInteger("12345678");
 
  client.disableCustomer(token, CustNum);
} catch (Exception e) {
    System.out.println("Soap Exception: " + e.getMessage());
}
developer/soap/methods/disablecustomer.txt · Last modified: 2009/12/21 14:45 by vladg

Page Tools