deleteCustomerPaymentMethod

Parent Previous Next

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.

 

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

 

<?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

 

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 = "103125"

       Dim PaymentID As String

       PaymentID = "41"

       Dim response As Boolean

       response = client.deleteCustomerPaymentMethod(token, CustNum, PaymentID)

       MsgBox(response)

 

 

.NET C#

 

           string CustNum = "89792";

           string PaymentID = "21";

          Boolean response;

           try

           {

               response = client.deleteCustomerPaymentMethod(token, CustNum, PaymentID);

               MessageBox.Show(string.Concat(response));

           }

           catch (Exception err)

           {

               MessageBox.Show(err.Message);

           }

: