Click or drag to resize
Infosoft Logo

IPaymentAgreementServiceLockPaymentAgreement Method

Locks the customer payment agreement with a given ID.

Namespace: Infosoft.Common.Contracts.ServiceContracts
Assembly: Infosoft.Common.Contracts (in Infosoft.Common.Contracts.dll) Version: 4.00.0.0
Syntax
Copy

Parameters

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

Return Value

LockPaymentAgreementResponse
A response object that contains the locked payment agreement.
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 is the only provider that supports deleting agreements, but this operation should still be used when a different provider is used.

See Also