Interface ILatitudePayClient
Interface for the ILatitudePayClient, provided to make testing via mocks/stubs etc. easier.
Inherited Members
Namespace: Yort.LatitudePay.InStore
Assembly: Yort.LatitudePay.InStore.dll
Syntax
public interface ILatitudePayClient : IDisposableMethods
| Improve this Doc View SourceCancelPurchaseAsync(LatitudePayCancelPurchaseRequest)
Cancels a (pending) payment plan previously requested via CreatePosPurchaseAsync(LatitudePayCreatePosPurchaseRequest).
Declaration
Task<LatitudePayCancelPurchaseResponse> CancelPurchaseAsync(LatitudePayCancelPurchaseRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| LatitudePayCancelPurchaseRequest | request | A LatitudePayCancelPurchaseRequest containing the token of the payment plan to cancel. |
Returns
| Type | Description |
|---|---|
| Task<LatitudePayCancelPurchaseResponse> | An instance of a LatitudePayCancelPurchaseResponse indicating if the cancellation was successful. |
Remarks
This only cancels pending/unapproved payment plans. If a plan has been accepted/approved you must refund it instead of cancel it.
See Also
CreatePosPurchaseAsync(LatitudePayCreatePosPurchaseRequest)
Creates a new 'payment plan'.
Declaration
Task<LatitudePayCreatePosPurchaseResponse> CreatePosPurchaseAsync(LatitudePayCreatePosPurchaseRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| LatitudePayCreatePosPurchaseRequest | request | A LatitudePayCreatePosPurchaseRequest instance specifying options for the payment plan to be created. |
Returns
| Type | Description |
|---|---|
| Task<LatitudePayCreatePosPurchaseResponse> | A LatitudePayCreatePosPurchaseResponse instance containing details of the pending payment plan. |
See Also
CreateRefundAsync(LatitudePayCreateRefundRequest)
Refunds a previously approved payment plan.
Declaration
Task<LatitudePayCreateRefundResponse> CreateRefundAsync(LatitudePayCreateRefundRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| LatitudePayCreateRefundRequest | request | A LatitudePayCreateRefundRequest instance containing details of the refund and payment plan to refund against. |
Returns
| Type | Description |
|---|---|
| Task<LatitudePayCreateRefundResponse> | A LatitudePayCreateRefundResponse instance indicating if the refund was successful and details of the refund created. |
Remarks
You can only refund a previously accepted payment plan. Use CancelPurchaseAsync(LatitudePayCancelPurchaseRequest) to cancel a payment plan that is pending.
A refund can be full or partial, and multiple partial refunds can be made. You can only refund up to the total amount of the original payment plan, across all refunds.
GetConfigurationAsync(LatitudePayConfigurationRequest)
Gets configuration information for the current merchant account, specifying the supported currency, minimum and maximum purchase values etc.
Declaration
Task<LatitudePayConfigurationResponse> GetConfigurationAsync(LatitudePayConfigurationRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| LatitudePayConfigurationRequest | request | A LatitudePayConfigurationRequest that specifies options for the data returned. |
Returns
| Type | Description |
|---|---|
| Task<LatitudePayConfigurationResponse> | A LatitudePayConfigurationResponse instance. |
GetPurchaseStatusAsync(LatitudePayPurchaseStatusRequest)
Gets the status of a payment plan previously requested via CreatePosPurchaseAsync(LatitudePayCreatePosPurchaseRequest).
Declaration
Task<LatitudePayPurchaseStatusResponse> GetPurchaseStatusAsync(LatitudePayPurchaseStatusRequest request)Parameters
| Type | Name | Description |
|---|---|---|
| LatitudePayPurchaseStatusRequest | request | A LatitudePayPurchaseStatusRequest instance containing the token of the payment plan who's status should be queried. |
Returns
| Type | Description |
|---|---|
| Task<LatitudePayPurchaseStatusResponse> | A LatitudePayPurchaseStatusResponse instance containing the status and other details of the plan. |