 | |
Online | |
A service implementation that combines three different service interfaces related to payment agreements.
Inheritance HierarchyNamespace: Infosoft.Webservices.Payments
Assembly: Infosoft.Webservices (in Infosoft.Webservices.dll) Version: 4.00.0.0
Syntaxpublic class OnlinePaymentAgreementService : BaseService, IPaymentAgreementService, IPaymentAgreementQueryService, IBusinessService, ICustomerPaymentAgreementService, ISubscriptionPaymentService
The OnlinePaymentAgreementService type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ChangePaymentAgreement | Changes the payment agreement of a given subscription. |
| CreateCustomerPaymentAgreement | Creates a new payment agreement and attaches it to a given customer. |
| Get | Gets a list of PaymentAgreements matching the specified filter. |
| GetAll | Gets all PaymentAgreements |
| GetCustomerPaymentAgreements | Gets all payment agreements belonging to the customer with the given customer number. |
| GetPaymentAgreement | Gets the current payment agreement of a given subscription. |
| GetPaymentAgreementDependencies | Gets all dependencies of a given payment agreement ID. A payment agreement cannot be deleted if it has any dependencies. |
| GetSingle | Gets a single PaymentAgreement matching the provided filter. |
| GetSubscriptionGiftPayments | Gets subscription gift payments. Not implemented |
| LockPaymentAgreement | Locks the customer payment agreement with a given ID. |
| PerformBalancePayment | Performs a credit card payment of a given monetary amount using the given payment agreement ID. |
| PerformInvoicePayment | Performs a credit card payment on the invoice with the given invoice number/title using the given payment agreement ID. |
| RemovePaymentAgreement | Removes the payment agreement of a given subscription. |
| UpdateCreditCardInformation | Attempts to update the creditcard information on payment agreements. |
Remarks
This service implementation lives in the WebServices project to emphasize the fact that it's an "external-only" endpoint.
We probably don't want to use this endpoint from our own code, but rather use the underlying endpoints instead.
It would also be somewhat clunky to instantiate the service if it were in IS.Common because it requires a reference to IS.Subscription
for the underlying SubscriptionPaymentService instance.
See Also