Class CapturesClient

Captures client. Thread-safe.

Inheritance

object

ApiResource

CapturesClient

Inherited Members

ApiResource._communicator

ApiResource._clientMetaInfo

ApiResource.ClientHeaders

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

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Worldline.Connect.Sdk.V1.Merchant.Captures

Assembly: Worldline.Connect.Sdk.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

Dispute(string, CreateDisputeRequest, CallContext)

Resource /{merchantId}/captures/{captureId}/dispute

• Create dispute

Declaration

public Task<DisputeResponse> Dispute(string captureId, CreateDisputeRequest body, CallContext context = null)

Parameters

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

Returns

Type	Description
Task<DisputeResponse>	DisputeResponse

Exceptions

Type	Condition
IdempotenceException	if an idempotent request caused a conflict (HTTP status code 409)
ValidationException	if the request was not correct and couldn't be processed (HTTP status code 400)
AuthorizationException	if the request was not allowed (HTTP status code 403)
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 404, 409 or 410)
PlatformException	if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect 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 500, 502 or 503)
ApiException	if the Worldline Global Collect platform returned any other error

Disputes(string, CallContext)

Resource /{merchantId}/captures/{captureId}/disputes

• Get disputes

Declaration

public Task<DisputesResponse> Disputes(string captureId, CallContext context = null)

Parameters

Type	Name	Description
string	captureId	string
CallContext	context	CallContext

Returns

Type	Description
Task<DisputesResponse>	DisputesResponse

Exceptions

Type	Condition
IdempotenceException	if an idempotent request caused a conflict (HTTP status code 409)
ValidationException	if the request was not correct and couldn't be processed (HTTP status code 400)
AuthorizationException	if the request was not allowed (HTTP status code 403)
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 404, 409 or 410)
PlatformException	if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect 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 500, 502 or 503)
ApiException	if the Worldline Global Collect platform returned any other error

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
IdempotenceException	if an idempotent request caused a conflict (HTTP status code 409)
ValidationException	if the request was not correct and couldn't be processed (HTTP status code 400)
AuthorizationException	if the request was not allowed (HTTP status code 403)
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 404, 409 or 410)
PlatformException	if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect 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 500, 502 or 503)
ApiException	if the Worldline Global Collect 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 Worldline Global Collect platform declined / rejected the refund. The refund result will be available from the exception.
IdempotenceException	if an idempotent request caused a conflict (HTTP status code 409)
ValidationException	if the request was not correct and couldn't be processed (HTTP status code 400)
AuthorizationException	if the request was not allowed (HTTP status code 403)
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 404, 409 or 410)
PlatformException	if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect 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 500, 502 or 503)
ApiException	if the Worldline Global Collect platform returned any other error