DeleteCustomerPaymentMethodProfile

Description

The DeleteCustomerPaymentMethodProfile method deletes the PaymentMethodProfile for the Customer.

Syntax

boolean DeleteCustomerPaymentMethodProfile(SecurityToken securityToken, string customerToken, string paymentMethodId)

Arguments

Type	Name	Req.	Description
SecurityToken	securityToken	R	A unique token that is used to identify a merchant and authenticate the API request.
string	customerToken	R	Identifies the Customer associated with the stored payment method. Note: Retrieve this value using GetCustomerToken.
string	paymentMethodId	R	Identifies the PaymentMethodProfile to delete.

Type

Name

Req.

Description

SecurityToken

securityToken

A unique token that is used to identify a merchant and authenticate the API request.

string

customerToken

Identifies the Customer associated with the stored payment method.

Note: Retrieve this value using GetCustomerToken.

string

paymentMethodId

Identifies the PaymentMethodProfile to delete.

Return Value

Type	Description
boolean	Returns `true` if the PaymentMethodProfile is successfully deleted. Otherwise, returns a fault.

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:DeleteCustomerPaymentMethodProfile>
         <ebiz:securityToken>
            <ebiz:SecurityId>***********2902-4a3e***********</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:customerToken>*******</ebiz:customerToken>
         <ebiz:paymentMethodId>123</ebiz:paymentMethodId>
      </ebiz:DeleteCustomerPaymentMethodProfile>
   </soapenv:Body>
</soapenv:Envelope>

var client = new IeBizServiceClient();

// Configure the API SecurityToken to use for API authentication
SecurityToken securityToken = new SecurityToken
{
    SecurityId = "***********4bf0-91cd***********",
    UserId = "",
    Password = ""
};

String methodId = "12160";
String customerToken = "*****803";

bool result = client.DeleteCustomerPaymentMethodProfile(securityToken, customerToken, methodId);

$client = new SoapClient('End Point URL');
$securityToken = array(
        'SecurityId' => '***********421b-86ce***********',
        'UserId' => 'merchant1',
        'Password' => 'merchant1'
);
$customerToken = '****6639';
$paymentMethodId = '1405';
$params = array(
   'securityToken' => $securityToken,
   'customerToken' => $customerToken,
   'paymentMethodId' => $paymentMethodId
);
$deletionResponse = $client->DeleteCustomerPaymentMethodProfile($params);

Example Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <DeleteCustomerPaymentMethodProfileResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <DeleteCustomerPaymentMethodProfileResult>true</DeleteCustomerPaymentMethodProfileResult>
      </DeleteCustomerPaymentMethodProfileResponse>
   </s:Body>
</s:Envelope>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:Server</faultcode>
         <faultstring xml:lang="en-US">40453: Unable to locate requested payment method.</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>