ModifyScheduledRecurringPaymentStatus

Description

The ModifyScheduledRecurringPaymentStatus method updates the ScheduleStatus field of an existing RecurringBillingDetails object in the EBizCharge platform.

Syntax

ModifyScheduledRecurringPaymentStatusResponse ModifyScheduledRecurringPaymentStatus(SecurityToken securityToken, string scheduledPaymentInternalId, int statusId)

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 update.
int	statusId	R	The new value for `ScheduleStatus`.

Return Value

Type	Description
ModifyScheduledRecurringPaymentStatusResponse	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:ModifyScheduledRecurringPaymentStatus>
         <ebiz:securityToken>
            <ebiz:SecurityId>*************4621-b899************</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:scheduledPaymentInternalId>*************49b4-aa4b************</ebiz:scheduledPaymentInternalId>
         <ebiz:statusId>1</ebiz:statusId>
      </ebiz:ModifyScheduledRecurringPaymentStatus>
   </soapenv:Body>
</soapenv:Envelope>

var client = new IeBizServiceClient();

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

String scheduledPaymentInternalId = "************8ddf-43ee************";

ModifyScheduledRecurringPaymentStatusResponse response = client.ModifyScheduledRecurringPaymentStatus(securityToken, scheduledPaymentInternalId, 3);

$client = new SoapClient('End Point URL');
$securityToken = array(
        'SecurityId' => '**********421b-86ce**********',
        'UserId' => 'merchant1',
        'Password' => 'merchant1'
);
 $params = array(
     'securityToken' => $securityToken,
     'scheduledPaymentInternalId' => '**********43ee-9b87**********',
     'statusId' => 3 // Example status ID
 );
$response = $client->ModifyScheduledRecurringPaymentStatus($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">
      <ModifyScheduledRecurringPaymentStatusResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <ModifyScheduledRecurringPaymentStatusResult>
            <Status>Success</Status>
            <StatusCode>1</StatusCode>
            <Error/>
            <ErrorCode>0</ErrorCode>
         </ModifyScheduledRecurringPaymentStatusResult>
      </ModifyScheduledRecurringPaymentStatusResponse>
   </s:Body>
</s:Envelope>

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