ScheduleRecurringPayment

Description

Creates 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

<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>1dc496d1-90b4-4a38-ad78-28a795af78e9</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:customerInternalId>4d913a99-8c22-4980-b258-969cd23a41f3</ebiz:customerInternalId>
         <ebiz:paymentMethodProfileId>30464</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:ReceiptTemplateName>
            <ebiz:SendCustomerReceipt>false</ebiz:SendCustomerReceipt>
         </ebiz:recurringBilling>
      </ebiz:ScheduleRecurringPayment>
   </soapenv:Body>
</soapenv:Envelope>