Class CapturesClient

Captures client. Thread-safe.

Inheritance

object

ApiResource

CapturesClient

Inherited Members

ApiResource._communicator

ApiResource._clientMetaInfo

ApiResource.ClientHeaders

ApiResource.InstantiateUri(string, IDictionary<string, string>)

ApiResource.CreateException(HttpStatusCode, string, object, CallContext)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Ingenico.Connect.Sdk.Merchant.Captures

Assembly: connect-sdk-dotnet.dll

Syntax

public class CapturesClient : ApiResource

Constructors

CapturesClient(ApiResource, IDictionary<string, string>)

Declaration

public CapturesClient(ApiResource parent, IDictionary<string, string> pathContext)

Parameters

Type	Name	Description
ApiResource	parent
IDictionary<string, string>	pathContext

Methods

Get(string, CallContext)

Resource /{merchantId}/captures/{captureId}

• Get capture

Declaration

public Task<CaptureResponse> Get(string captureId, CallContext context = null)

Parameters

Type	Name	Description
string	captureId	string
CallContext	context	CallContext

Returns

Type	Description
Task<CaptureResponse>	CaptureResponse

Exceptions

Type	Condition
ValidationException	if the request was not correct and couldn't be processed (HTTP status code BadRequest)
AuthorizationException	if the request was not allowed (HTTP status code Forbidden)
IdempotenceException	if an idempotent request caused a conflict (HTTP status code Conflict)
ReferenceException	if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code NotFound, Conflict or Gone)
GlobalCollectException	if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code InternalServerError, BadGateway or ServiceUnavailable)
ApiException	if the Ingenico ePayments platform returned any other error

Refund(string, RefundRequest, CallContext)

Resource /{merchantId}/captures/{captureId}/refund

• Create Refund

Declaration

public Task<RefundResponse> Refund(string captureId, RefundRequest body, CallContext context = null)

Parameters

Type	Name	Description
string	captureId	string
RefundRequest	body	RefundRequest
CallContext	context	CallContext

Returns

Type	Description
Task<RefundResponse>	RefundResponse

Exceptions

Type	Condition
DeclinedRefundException	if the Ingenico ePayments platform declined / rejected the refund. The refund result will be available from the exception.
ValidationException	if the request was not correct and couldn't be processed (HTTP status code BadRequest)
AuthorizationException	if the request was not allowed (HTTP status code Forbidden)
IdempotenceException	if an idempotent request caused a conflict (HTTP status code Conflict)
ReferenceException	if an object was attempted to be referenced that doesn't exist or has been removed, or there was a conflict (HTTP status code NotFound, Conflict or Gone)
GlobalCollectException	if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer, or the service that you're trying to reach is temporary unavailable (HTTP status code InternalServerError, BadGateway or ServiceUnavailable)
ApiException	if the Ingenico ePayments platform returned any other error