developer:soap-1.2:methods:deletecustomerpaymentmethod

Soap API v1.2

deleteCustomerPaymentMethod

Delete a payment method from an existing customer.

Description

This method removes a stored payment method from a customer's record.

Each customer record may contain multiple payment methods. (Exception: see Beta6 note below.) This option allows you to remove expired or unused payment methods from your customer's records.

New payment methods may be added by using addCustomerPaymentMethod.

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.

Please Note: Beta6 supports only one payment method for each customer. This means that if you delete a payment method from a customer's account without adding a new method, the customer will be left with no existing payment methods.

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

Syntax

boolean deleteCustomerPaymentMethod ( ueSecurityToken Token, Custnum, integer PaymentMethodID )

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
integer Custnum No description available.
integer PaymentMethodID The ID of the payment method to be deleted.

Return Value

boolean Returns confirmation of payment method deletion only if successful. If deletion 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 { 
  //Set CustNum for the Customer that you
  //want to delete a payment method from
  $CustNum="12345678"
 
  //Set PayID for the Payment Method ID
  //that you want to delete
  $PayID="7654321" 
 
  // Delete the payment method
  $Result=$client->deleteCustomerPaymentMethod($token, $CustNum, $PayID);	
} catch(Exception $e) { 
  echo 'Error: ' . $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 delete a payment method from
  BigInteger custnum = new BigInteger("12345678");
 
  //Set PayID for the Payment Method ID
  //that you want to delete
  BigInteger PayID = new BigInteger("7654321");
 
  boolean Result = client.deleteCustomerPaymentMethod(token, CustNum, PayID);
} catch (Exception e) {
    System.out.println("Soap Exception: " + e.getMessage());
}

.NET VB

Dim CustNum As String
        CustNum = "115163"
        Dim PaymentID As String
        PaymentID = "70"
 
        Dim response As Boolean
 
        response = client.deleteCustomerPaymentMethod(token, CustNum, PaymentID)
        MsgBox(response)

.NET C#

string CustNum = "109100";
            string PaymentID = "50";
 
            Boolean response;
 
            try
            {
                response = client.deleteCustomerPaymentMethod(token, CustNum, PaymentID);
                MessageBox.Show(string.Concat(response));
            }
 
            catch (Exception err)
            {
                MessageBox.Show(err.Message);
            }
developer/soap-1.2/methods/deletecustomerpaymentmethod.txt · Last modified: 2010/10/20 11:41 by irina

Page Tools