Delete the customer specified by CustNum.
This method requires the use of the CustNum, a unique customer number assigned by the gateway. If you have lost or cannot remember the customer's CustNum, use the searchCustomers method to find the correct CustNum.
See also runCustomerTransaction, enableCustomer, disableCustomer, searchCustomerID, getCustomer, searchCustomers, getCustomerHistory, addCustomer, addCustomerPaymentMethod, deleteCustomerPaymentMethod, updateCustomer, quickUpdateCustomer
boolean deleteCustomer ( ueSecurityToken Token, integer CustNum )
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. |
boolean | Returns confirmation of request only if successful. If request fails, an exception will be thrown. |
For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.
<?php try { $custnum=$this->createCustomer(); $res=$client->deleteCustomer($token, $custnum); $this->assertTrue($res); } catch(SoapFault $e) { die("soap fault: " .$e->getMessage()); } ?>
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 Customer you want to delete BigInteger CustNum = BigInteger("12345678"); //Delete Customer client.deleteCustomer(token, CustNum); } catch (Exception e) { System.out.println("Soap Exception: " + e.getMessage()); }
Dim custNum As String custNum = "103125" Dim response As Boolean response = client.deleteCustomer(token, custNum) MsgBox(response)
string custNum = "89792"; Boolean response; try { response = client.deleteCustomer(token, custNum); if (response) { MessageBox.Show(string.Concat("Succesfull")); } else MessageBox.Show(string.Concat("Error!")); } catch (Exception err) { MessageBox.Show(err.Message); }
Version | Change |
---|---|
1.1 | Method added prior to soap-1.1 |