ModifyScheduledRecurringPayment_PaymentMethodProfile

Description

The ModifyScheduledRecurringPayment_PaymentMethodProfile method updates the payment method profile ID for the scheduled recurring payment.

The following fields will automatically update with the data from the newly associated payment method profile ID:MaskedPM, PMHolderName, PMExpirationYear, PMExpirationMonth, and PmType .

Syntax

ModifyScheduledRecurringPaymentResponse ModifyScheduledRecurringPayment_PaymentMethodProfile (SecurityToken securityToken, string scheduledPaymentInternalId, string paymentMethodProfileId)

Arguments

Type	Name	Req	Description
SecurityToken	securityToken	R	A unique token that is used to identify a merchant and authenticate the API request.
string	scheduledPaymentInternalId	R	Indicates the RecurringBillingDetails object to update.
string	paymentMethodProfileId	R	Specifies the new payment method profile ID that will replace the current one. Note: This field is returned by the `AddCustomerMethodProfile` method.

Type

Name

Req

Description

SecurityToken

securityToken

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

string

scheduledPaymentInternalId

Indicates the RecurringBillingDetails object to update.

string

paymentMethodProfileId

Specifies the new payment method profile ID that will replace the current one.

Note: This field is returned by the AddCustomerMethodProfile method.

Return Value

Type	Description
ModifyScheduledRecurringPaymentResponse	Indicates whether the operation was successful. If an error occurs, a fault is returned.

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:ModifyScheduledRecurringPayment_PaymentMethodProfile>
         <ebiz:securityToken>
            <ebiz:SecurityId>***********b636-c223***********</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:scheduledPaymentInternalId>***********e747-5122***********</ebiz:scheduledPaymentInternalId>
         <ebiz:paymentMethodProfileId>311</ebiz:paymentMethodProfileId>
      </ebiz:ModifyScheduledRecurringPayment_PaymentMethodProfile>
   </soapenv:Body>
</soapenv:Envelope>

var client = new IeBizServiceClient();

SecurityToken securityToken = new SecurityToken();
securityToken.UserId = "";
securityToken.SecurityId = "***********421b-86ce***********";
securityToken.Password = "";

String scheduledPaymentInternalId = "***********43ee-9b87***********";
String newPaymentMethodProfileId = "1396";
ModifyScheduledRecurringPaymentResponse response = client.ModifyScheduledRecurringPayment_PaymentMethodProfile(securityToken, scheduledPaymentInternalId, newPaymentMethodProfileId);

$client = new SoapClient('End Point URL');
$securityToken = array(
        'SecurityId' => '***********421b-86ce***********',
        'UserId' => 'merchant1',
        'Password' => 'merchant1'
);
 $params = array(
     'securityToken' => $securityToken,
     'scheduledPaymentInternalId' => '***********43ee-9b87***********',
     'paymentMethodProfileId' => '1396'
 );

$response = $client->ModifyScheduledRecurringPayment_PaymentMethodProfile($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">
      <ModifyScheduledRecurringPayment_PaymentMethodProfileResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <ModifyScheduledRecurringPayment_PaymentMethodProfileResult>
            <Status>Success</Status>
            <StatusCode>1</StatusCode>
            <Error/>
            <ErrorCode>0</ErrorCode>
         </ModifyScheduledRecurringPayment_PaymentMethodProfileResult>
      </ModifyScheduledRecurringPayment_PaymentMethodProfileResponse>
   </s:Body>
</s:Envelope>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:InvalidScheduledPaymentInternalId</faultcode>
         <faultstring xml:lang="en-US">Invalid scheduledPaymentInternalId</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>