GetScheduledDates

Description

The GetScheduledDates method retrieves the dates scheduled for a recurring payment.

Syntax

GetScheduledDatesResponse GetScheduledDates(SecurityToken securityToken, string scheduledPaymentInternalId)

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	ID of the RecurringBillingDetails object to retrieve scheduled dates for. Note: Assigned by the ScheduleRecurringPayment method.

Type

Name

Req.

Description

SecurityToken

securityToken

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

string

scheduledPaymentInternalId

ID of the RecurringBillingDetails object to retrieve scheduled dates for.

Note: Assigned by the ScheduleRecurringPayment method.

Return Value

Type	Description
GetScheduledDatesResponse	On success, returns scheduled payment dates and request status information. Otherwise, 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:GetScheduledDates>
         <ebiz:securityToken>
            <ebiz:SecurityId>*************-4621-b899-************</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:scheduledPaymentInternalId>*************-4c1d-963e-************</ebiz:scheduledPaymentInternalId>
      </ebiz:GetScheduledDates>
   </soapenv:Body>
</soapenv:Envelope>

public static void GetScheduledDates()
{
  IeBizService apiClient = new IeBizServiceClient();

  SecurityToken securityToken = new SecurityToken
  {
    SecurityId = TestSecurityId,
    UserId = "",
    Password = ""
    };

  const string scheduledPaymentInternalId = "********-80d8-4f7c-9d9a-************";

  GetScheduledDatesResponse response = apiClient.GetScheduledDates(
    securityToken,
    scheduledPaymentInternalId
  );

  Console.WriteLine($"Scheduled Dates: {response.ScheduledDates}");
  Console.WriteLine($"Status:          {response.Status}");
  Console.WriteLine($"Status Code:     {response.StatusCode}");
  Console.WriteLine($"Error:           {response.Error}");
  Console.WriteLine($"Error Code:      {response.ErrorCode}");
}

function getScheduledDates($client, $securityToken): void
{
  $scheduledPaymentInternalId = '********-80d8-4f7c-9d9a-************';

  $params = [
    'securityToken'              => $securityToken,
    'scheduledPaymentInternalId' => $scheduledPaymentInternalId,
  ];

  try {
    $response = $client->GetScheduledDates($params);
    $result   = $response->GetScheduledDatesResult ?? null;

    echo "Scheduled Dates: " . ($result->ScheduledDates ?? '') . PHP_EOL;
    echo "Status:          " . ($result->Status         ?? '') . PHP_EOL;
    echo "Status Code:     " . ($result->StatusCode     ?? '') . PHP_EOL;
    echo "Error:           " . ($result->Error          ?? '') . PHP_EOL;
    echo "Error Code:      " . ($result->ErrorCode      ?? '') . PHP_EOL;

  } catch (SoapFault $e) {
    echo "SOAP Error: " . $e->getMessage() . PHP_EOL;
  }
}

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">
      <GetScheduledDatesResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetScheduledDatesResult>
            <ScheduledDates>["2025-11-13","2025-12-13","2026-01-13","2026-02-13"]</ScheduledDates>
            <Status>Success</Status>
            <StatusCode>1</StatusCode>
            <Error/>
            <ErrorCode>0</ErrorCode>
         </GetScheduledDatesResult>
      </GetScheduledDatesResponse>
   </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>