Guides

GetRecurringSchedulePreview

Description

This method is used to get recurring schedule preview.

Syntax

GetScheduledDates GetScheduledDatesResponse GetRecurringSchedulePreview(SecurityToken securityToken, RecurringBilling recurringBilling)

Arguments

TypeNameDescription
SecurityTokensecurityTokenMerchant security token: used to identify merchant and validate transaction. (required)
RecurringBillingrecurringBillingRecurring Billing.

Return Value

GetScheduledDatesReturns Get Scheduled Dates response.

Examples

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header />
   <soapenv:Body>
      <ebiz:GetRecurringSchedulePreview>
         <ebiz:securityToken>
            <ebiz:SecurityId>********-794B-4CEE-B4DF-*************</ebiz:SecurityId>
            <ebiz:UserId />
            <ebiz:Password />
         </ebiz:securityToken>
         <ebiz:recurringBilling>
            <ebiz:Amount>0.05</ebiz:Amount>
            <ebiz:Tax>0.00</ebiz:Tax>
            <ebiz:Enabled>true</ebiz:Enabled>
            <ebiz:Start>2021-07-07T00:00:00</ebiz:Start>
            <ebiz:Expire>2031-07-07T00:00:00</ebiz:Expire>
            <ebiz:Next>0001-01-01T00:00:00</ebiz:Next>
            <ebiz:NumLeft />
            <ebiz:RepeatCount>0</ebiz:RepeatCount>
            <ebiz:Schedule>bi-monthly</ebiz:Schedule>
               <ebiz:CustomScheduleObject>
               <ebiz:Interval>1</ebiz:Interval>
               <ebiz:Frequency />
            </ebiz:CustomScheduleObject>
            <ebiz:ScheduleName>Monthly billing</ebiz:ScheduleName>
            <ebiz:ReceiptNote />
            <ebiz:ReceiptTemplateName />
            <ebiz:SendCustomerReceipt>false</ebiz:SendCustomerReceipt>
         </ebiz:recurringBilling>
      </ebiz:GetRecurringSchedulePreview>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <GetRecurringSchedulePreviewResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetRecurringSchedulePreviewResult>
            <ScheduledDates>["2021-07-15","2021-08-01","2021-08-15","2021-09-01","2021-09-15","2021-10-01","2021-10-15","2021-11-01","2021-11-15","2021-12-01","2021-12-15","2022-01-01","2022-01-15","2022-02-01","2022-02-15","2022-03-01","2022-03-15","2022-04-01","2022-04-15","2022-05-01","2022-05-15","2022-06-01","2022-06-15","2022-07-01","2022-07-15","2022-08-01","2022-08-15","2022-09-01","2022-09-15","2022-10-01","2022-10-15","2022-11-01","2022-11-15","2022-12-01","2022-12-15","2023-01-01","2023-01-15","2023-02-01","2023-02-15","2023-03-01","2023-03-15","2023-04-01","2023-04-15","2023-05-01","2023-05-15","2023-06-01","2023-06-15","2023-07-01","2023-07-15","2023-08-01","2023-08-15","2023-09-01","2023-09-15","2023-10-01","2023-10-15","2023-11-01","2023-11-15","2023-12-01","2023-12-15","2024-01-01","2024-01-15","2024-02-01","2024-02-15","2024-03-01","2024-03-15","2024-04-01","2024-04-15","2024-05-01","2024-05-15","2024-06-01","2024-06-15","2024-07-01","2024-07-15","2024-08-01","2024-08-15","2024-09-01","2024-09-15","2024-10-01","2024-10-15","2024-11-01","2024-11-15","2024-12-01","2024-12-15","2025-01-01","2025-01-15","2025-02-01","2025-02-15","2025-03-01","2025-03-15","2025-04-01","2025-04-15","2025-05-01","2025-05-15","2025-06-01","2025-06-15","2025-07-01","2025-07-15","2025-08-01","2025-08-15","2025-09-01","2025-09-15","2025-10-01","2025-10-15","2025-11-01","2025-11-15","2025-12-01","2025-12-15","2026-01-01","2026-01-15","2026-02-01","2026-02-15","2026-03-01","2026-03-15","2026-04-01","2026-04-15","2026-05-01","2026-05-15","2026-06-01","2026-06-15","2026-07-01","2026-07-15","2026-08-01","2026-08-15","2026-09-01","2026-09-15","2026-10-01","2026-10-15","2026-11-01","2026-11-15","2026-12-01","2026-12-15","2027-01-01","2027-01-15","2027-02-01","2027-02-15","2027-03-01","2027-03-15","2027-04-01","2027-04-15","2027-05-01","2027-05-15","2027-06-01","2027-06-15","2027-07-01","2027-07-15","2027-08-01","2027-08-15","2027-09-01","2027-09-15","2027-10-01","2027-10-15","2027-11-01","2027-11-15","2027-12-01","2027-12-15","2028-01-01","2028-01-15","2028-02-01","2028-02-15","2028-03-01","2028-03-15","2028-04-01","2028-04-15","2028-05-01","2028-05-15","2028-06-01","2028-06-15","2028-07-01","2028-07-15","2028-08-01","2028-08-15","2028-09-01","2028-09-15","2028-10-01","2028-10-15","2028-11-01","2028-11-15","2028-12-01","2028-12-15","2029-01-01","2029-01-15","2029-02-01","2029-02-15","2029-03-01","2029-03-15","2029-04-01","2029-04-15","2029-05-01","2029-05-15","2029-06-01","2029-06-15","2029-07-01","2029-07-15","2029-08-01","2029-08-15","2029-09-01","2029-09-15","2029-10-01","2029-10-15","2029-11-01","2029-11-15","2029-12-01","2029-12-15","2030-01-01","2030-01-15","2030-02-01","2030-02-15","2030-03-01","2030-03-15","2030-04-01","2030-04-15","2030-05-01","2030-05-15","2030-06-01","2030-06-15","2030-07-01","2030-07-15","2030-08-01","2030-08-15","2030-09-01","2030-09-15","2030-10-01","2030-10-15","2030-11-01","2030-11-15","2030-12-01","2030-12-15","2031-01-01","2031-01-15","2031-02-01","2031-02-15","2031-03-01","2031-03-15","2031-04-01","2031-04-15","2031-05-01","2031-05-15","2031-06-01","2031-06-15","2031-07-01"]</ScheduledDates>
            <Status>Success</Status>
            <StatusCode>1</StatusCode>
            <Error />
            <ErrorCode>0</ErrorCode>
         </GetRecurringSchedulePreviewResult>
      </GetRecurringSchedulePreviewResponse>
   </s:Body>
</s:Envelope>

Updated over 1 year ago