BillingAccountRecurringPayment

Version: 1.33

BillingAccountRecurringPayment is the representation of a recurring payment configured on a billing account.

Parameters

Extends: TractObject

Elements
Element	Type	Required?	Description
CHOICE: creditCardPaymentMethod bankPaymentMethod referencedCreditCardPaymentMethod payPalPaymentMethod mobileCarrierPayment sepaDirectDebitPaymentMethod tokenizedCreditCardPaymentMethod	creditCardPaymentMethod bankPaymentMethod referencedCreditCardPaymentMethod payPalPaymentMethod mobileCarrierPayment SEPAPaymentMethod tokenizedCreditCardPaymentMethod	Y	The method of payment.
billingAccount	billingAccount		The billing account this recurring payment is configured on.

Attributes
Attribute	Required?	Datatype	Description
validFrom		determent	Start date the recurring payment is valid from.
validTo		dateTime	Ending date that the recurring payment is valid.

Querying BillingAccountRecurringPayment

For paged results, use the plural of the entity name (for example, billingAccounts, productCategories). For more information, refer to Understanding Queries.

Query Keys
Key	Type
eid	Long
accountNum	String
billingAccountEid	Long
token	String
validTo	Timestamp
validFrom	Timestamp

REST Endpoints

/billingAccounts
addRecurringPayment	POST	https://my.tractbilling.com/t/s/r/1.33/billingAccounts/{eid: \d+}/addRecurringPayment

Sample Requests and Responses

SOAP

Query

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:query xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:queryRequest>
                <simpleDataQuery startIndex="0" size="50">
                    <type>BillingAccountRecurringPayment</type>
                    <parameter parameter="billingAccountEid" parameterValue="19975"/>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

REST

Query
getBillingAccountRecurringPayments	GET	https://my.tractbilling.com/t/s/r/1.33/recurringPayments
getBillingAccountRecurringPayment	GET	https://my.tractbilling.com/t/s/r/1.33/recurringPayments/{eid: \d+}