ScheduleRecurringPayment

Description

This method is used to create a specific recurring billing cycles.

Syntax

string ScheduleRecurringPayment( SecurityToken SecurityToken securityToken, string customerInternalId, string paymentMethodProfileId, RecurringBilling RecurringBilling recurringBilling);

Arguments

Type	Name	Description
SecurityToken	securityToken	Merchant security token: used to identify merchant and validate transaction. (required)
string	customerInternalId	Unique customer ID number assigned by the internal system for an existing customer. (required)
string	paymentMethodProfileId	Unique payment method ID assigned by the gateway. (required)
RecurringBilling	recurringBilling	Recurring Billing object. (required)

Return Value


string	Returns scheduledJobId or throws an exception

Examples

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header />
   <soapenv:Body>
      <ebiz:ScheduleRecurringPayment>
         <ebiz:securityToken>
            <ebiz:SecurityId>********-766e-44e8-9e9b-9d2c93042a98</ebiz:SecurityId>
            <ebiz:UserId />
            <ebiz:Password />
         </ebiz:securityToken>
         <ebiz:customerInternalId>*******-7a53-4330-9408-d6254b9a2f1c</ebiz:customerInternalId>
         <ebiz:paymentMethodProfileId>1863</ebiz:paymentMethodProfileId>
         <ebiz:recurringBilling>
            <ebiz:Amount>1000.00</ebiz:Amount>
            <ebiz:Tax>10.00</ebiz:Tax>
            <ebiz:Enabled>true</ebiz:Enabled>
            <ebiz:Start>2017-02-13T23:41:13</ebiz:Start>
            <ebiz:Expire>2018-12-21T03:32:42-08:00</ebiz:Expire>
            <ebiz:Schedule>monthly</ebiz:Schedule>
            <ebiz:ScheduleName>Monthly billing</ebiz:ScheduleName>
            <ebiz:ReceiptNote />
            <ebiz:ReceiptTemplateName />
            <ebiz:SendCustomerReceipt>false</ebiz:SendCustomerReceipt>
         </ebiz:recurringBilling>
      </ebiz:ScheduleRecurringPayment>
   </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">
      <ScheduleRecurringPaymentResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <ScheduleRecurringPaymentResult>********-04a1-4c4b-bf7f-e35e57023ca9</ScheduleRecurringPaymentResult>
      </ScheduleRecurringPaymentResponse>
   </s:Body>
</s:Envelope>