ModifyScheduledRecurringPayment

Description

The ModifyScheduledRecurringPayment_RecurringBilling method modifies the recurring billing information in an existing RecurringBillingDetails object on the EBizCharge platform.

Syntax

ModifyScheduledRecurringPaymentResponse ModifyScheduledRecurringPayment_RecurringBilling(SecurityToken securityToken, string scheduledPaymentInternalId, RecurringBilling recurringBilling )

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	Identifies the RecurringBillingDetails object to modify.
RecurringBilling	recurringBilling	R	Specifies the recurring billing information to modify within the RecurringBillingDetails object. Warning: Omitting a field clears its value. Required Fields `Amount` `Tax` `Enabled` `Start` `Expire` `Schedule` `SendCustomerReceipt`

Type

Name

Req.

Description

SecurityToken

securityToken

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

string

scheduledPaymentInternalId

Identifies the RecurringBillingDetails object to modify.

RecurringBilling

recurringBilling

Specifies the recurring billing information to modify within the RecurringBillingDetails object.

Warning: Omitting a field clears its value.

Required Fields

Amount
Tax
Enabled
Start
Expire
Schedule
SendCustomerReceipt

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_RecurringBilling>
         <ebiz:securityToken>
            <ebiz:SecurityId>************4621-b899************</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:scheduledPaymentInternalId>*************4445-8b20************</ebiz:scheduledPaymentInternalId>
         <ebiz:recurringBilling>
            <ebiz:Amount>320.00</ebiz:Amount>
            <ebiz:Enabled>true</ebiz:Enabled>
            <ebiz:Start>2023-03-12T00:00:00</ebiz:Start>
            <ebiz:Expire>2028-06-21T00:00:00</ebiz:Expire>
            <ebiz:Schedule>monthly</ebiz:Schedule>
            <ebiz:ScheduleName/>
            <ebiz:ReceiptNote/>
            <ebiz:ReceiptTemplateName/>
            <ebiz:SendCustomerReceipt>false</ebiz:SendCustomerReceipt>
            <ebiz:CustomerEmailList/>
         </ebiz:recurringBilling>
      </ebiz:ModifyScheduledRecurringPayment_RecurringBilling>
   </soapenv:Body>
</soapenv:Envelope>

var client = new IeBizServiceClient();

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

String scheduledPaymentInternalId = "***********43ee-9b87***********";

RecurringBilling updatedRecurringBilling = new RecurringBilling();
updatedRecurringBilling.Amount = 20;
updatedRecurringBilling.Start = new DateTime(2027, 1, 1);
updatedRecurringBilling.Next = new DateTime(2027, 1, 1);
updatedRecurringBilling.Expire = new DateTime(2028, 1, 1);
updatedRecurringBilling.Schedule = "annually";
updatedRecurringBilling.ScheduleName = "new schedule";
updatedRecurringBilling.SendCustomerReceipt = false;
updatedRecurringBilling.ReceiptNote = "note";

ModifyScheduledRecurringPaymentResponse response = client.ModifyScheduledRecurringPayment_RecurringBilling(securityToken, scheduledPaymentInternalId, updatedRecurringBilling);

$client = new SoapClient('End Point URL');
$securityToken = array(
        'SecurityId' => '************421b-86ce************',
        'UserId' => 'merchant1',
        'Password' => 'merchant1'
);
 $params = array(
     'securityToken' => $securityToken,
     'scheduledPaymentInternalId' => '************43ee-9b87************',
     'recurringBilling' => array(
         'Amount' => 15.00,
         'Start' => '2021-07-07T00:00:00',
         'Next' => '2022-01-01T00:00:00',
         'Expire' => '2031-07-07T00:00:00',
         'Schedule' => 'Monthly',
         'ScheduleName' => 'Updated Schedule Name',
         'SendCustomerReceipt' => false,
         'ReceiptNote' => 'Updated receipt note'
     )
 );
$response = $client->ModifyScheduledRecurringPayment_RecurringBilling($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_RecurringBillingResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <ModifyScheduledRecurringPayment_RecurringBillingResult>
            <Status>Success</Status>
            <StatusCode>1</StatusCode>
            <Error/>
            <ErrorCode>0</ErrorCode>
         </ModifyScheduledRecurringPayment_RecurringBillingResult>
      </ModifyScheduledRecurringPayment_RecurringBillingResponse>
   </s:Body>
</s:Envelope>

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