Class RefundsClient

Refunds client. Thread-safe.

Inheritance

object

ApiResource

RefundsClient

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.Refunds

Assembly: Worldline.Connect.Sdk.dll

Syntax

public class RefundsClient : ApiResource

Constructors

RefundsClient(ApiResource, IDictionary<string, string>)

Declaration

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

Parameters

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

Methods

Approve(string, ApproveRefundRequest, CallContext)

Resource /{merchantId}/refunds/{refundId}/approve

• Approve refund

Declaration

public Task Approve(string refundId, ApproveRefundRequest body, CallContext context = null)

Parameters

Type	Name	Description
string	refundId	string
ApproveRefundRequest	body	ApproveRefundRequest
CallContext	context	CallContext

Returns

Type	Description
Task

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

Cancel(string, CallContext)

Resource /{merchantId}/refunds/{refundId}/cancel

• Cancel refund

Declaration

public Task Cancel(string refundId, CallContext context = null)

Parameters

Type	Name	Description
string	refundId	string
CallContext	context	CallContext

Returns

Type	Description
Task

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

Cancelapproval(string, CallContext)

Resource /{merchantId}/refunds/{refundId}/cancelapproval

• Undo approve refund

Declaration

public Task Cancelapproval(string refundId, CallContext context = null)

Parameters

Type	Name	Description
string	refundId	string
CallContext	context	CallContext

Returns

Type	Description
Task

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

Find(FindRefundsParams, CallContext)

Resource /{merchantId}/refunds

• Find refunds

Declaration

public Task<FindRefundsResponse> Find(FindRefundsParams query, CallContext context = null)

Parameters

Type	Name	Description
FindRefundsParams	query	FindRefundsParams
CallContext	context	CallContext

Returns

Type	Description
Task<FindRefundsResponse>	FindRefundsResponse

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}/refunds/{refundId}

• Get refund

Declaration

public Task<RefundResponse> Get(string refundId, CallContext context = null)

Parameters

Type	Name	Description
string	refundId	string
CallContext	context	CallContext

Returns

Type	Description
Task<RefundResponse>	RefundResponse

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