Click or drag to resize
Infosoft Logo

OnlinePaymentAgreementServiceLockPaymentAgreement Method

Locks the customer payment agreement with a given ID.

Namespace: Infosoft.Webservices.Payments
Assembly: Infosoft.Webservices (in Infosoft.Webservices.dll) Version: 4.00.0.0
Syntax
Copy
public LockPaymentAgreementResponse LockPaymentAgreement(
	LockPaymentAgreementRequest request
)

Parameters

request  LockPaymentAgreementRequest
A request object that contains a payment agreement ID.

Return Value

LockPaymentAgreementResponse
A response object that contains the locked payment agreement.

Implements

IPaymentAgreementServiceLockPaymentAgreement(LockPaymentAgreementRequest)
Remarks

Locking an agreement involves two different operations: The agreement is marked as locked in the Infosoft database, and a delete request is sent to underlying provider, if the provider supports it.

Currently, PayEx and ePay are the only providers that support deleting agreements, but this operation should still be used when a different provider is used.

See Also