SearchScheduledRecurringPayments

Description

This method is used to search scheduled recurring payments.

Syntax

List RecurringBillingDetails SearchScheduledRecurringPayments(SecurityToken securityToken, string customerInternalId, string customerId, int start, int limit, string sort);

Arguments

Type	Name	Description
SecurityToken	securityToken	Merchant security token: used to identify merchant and validate transaction. (required)
string	customerInternalId	Customer Internal Id. (required)
string	customerId	Customer Id. (required)
int	start	Start position, defaults to 0 (first payment found). (required)
int	limit	Maximum number of payments to return in result. Default Max 1000. (required)
string	sort	Field name to sort the results by. (optional)

Return Value

Type	Description
List RecurringBillingDetails	This object contains all recurring billing details , including payment, invoice, and customer information.

Example

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header />
   <soapenv:Body>
      <ebiz:SearchScheduledRecurringPayments>
         <ebiz:securityToken>
            <ebiz:SecurityId>********-7ec3-4951-b1de-8ef47d896241</ebiz:SecurityId>
            <ebiz:UserId />
            <ebiz:Password />
         </ebiz:securityToken>
         <ebiz:customerInternalId />
         <ebiz:customerId />
         <ebiz:start>1</ebiz:start>
         <ebiz:limit>10</ebiz:limit>
         <ebiz:sort />
      </ebiz:SearchScheduledRecurringPayments>
   </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">
      <SearchScheduledRecurringPaymentsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchScheduledRecurringPaymentsResult>
            <RecurringBillingDetails>
               <ScheduledPaymentInternalId>********-3b12-49f0-93e2-4e9eac3bae62</ScheduledPaymentInternalId>
               <CustomerInternalId>********-b1af-49df-b1b9-9a3033b03c1e</CustomerInternalId>
               <CustomerId>0015600000VAe4KAAT</CustomerId>
               <Amount>100.0000</Amount>
               <Tax>0.0000</Tax>
               <Enabled>true</Enabled>
               <Start>2021-07-15T00:00:00</Start>
               <Expire>2021-07-17T00:00:00</Expire>
               <Next>0001-01-01T00:00:00</Next>
               <RepeatCount>0</RepeatCount>
               <Schedule>daily</Schedule>
               <ScheduleName>Test Payment SF</ScheduleName>
               <ReceiptNote />
               <SendCustomerReceipt>true</SendCustomerReceipt>
               <CustNum>11688247</CustNum>
               <PaymentMethodId>15</PaymentMethodId>
               <MaskedPM>1111</MaskedPM>
               <PMHolderName>Mary 1</PMHolderName>
               <PMExpirationYear>2021</PMExpirationYear>
               <PMExpirationMonth>08</PMExpirationMonth>
               <PmType>Visa</PmType>
               <ScheduleStatus>0</ScheduleStatus>
               <DateTimeCreated>7/13/2021 12:02:23 AM</DateTimeCreated>
               <DateTimeModified>7/15/2021 8:15:47 PM</DateTimeModified>
            </RecurringBillingDetails>
         </SearchScheduledRecurringPaymentsResult>
      </SearchScheduledRecurringPaymentsResponse>
   </s:Body>
</s:Envelope>

Updated over 1 year ago