com.worldline.connect.sdk.java.v1.merchant.refunds

Class RefundsClient

java.lang.Object

com.worldline.connect.sdk.java.ApiResource

com.worldline.connect.sdk.java.v1.merchant.refunds.RefundsClient

public class RefundsClient
extends ApiResource

Refunds client. Thread-safe.

Field Summary

Fields inherited from class com.worldline.connect.sdk.java.ApiResource

clientMetaInfo, communicator

Constructor Summary

Constructors

Constructor and Description
RefundsClient(ApiResource parent, Map<String,String> pathContext)

Method Summary

Modifier and Type	Method and Description
void	approve(String refundId, ApproveRefundRequest body) Resource /{merchantId}/refunds/{refundId}/approve - Approve refund
void	approve(String refundId, ApproveRefundRequest body, CallContext context) Resource /{merchantId}/refunds/{refundId}/approve - Approve refund
void	cancel(String refundId) Resource /{merchantId}/refunds/{refundId}/cancel - Cancel refund
void	cancel(String refundId, CallContext context) Resource /{merchantId}/refunds/{refundId}/cancel - Cancel refund
void	cancelapproval(String refundId) Resource /{merchantId}/refunds/{refundId}/cancelapproval - Undo approve refund
void	cancelapproval(String refundId, CallContext context) Resource /{merchantId}/refunds/{refundId}/cancelapproval - Undo approve refund
FindRefundsResponse	find(FindRefundsParams query) Resource /{merchantId}/refunds - Find refunds
FindRefundsResponse	find(FindRefundsParams query, CallContext context) Resource /{merchantId}/refunds - Find refunds
RefundResponse	get(String refundId) Resource /{merchantId}/refunds/{refundId} - Get refund
RefundResponse	get(String refundId, CallContext context) Resource /{merchantId}/refunds/{refundId} - Get refund

Methods inherited from class com.worldline.connect.sdk.java.ApiResource

getClientHeaders, instantiateUri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RefundsClient

public RefundsClient(ApiResource parent,
                     Map<String,String> pathContext)

Method Detail

find

public FindRefundsResponse find(FindRefundsParams query)

Resource /{merchantId}/refunds - Find refunds

Parameters:

query - FindRefundsParams

Returns:

FindRefundsResponse

Throws:

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

public FindRefundsResponse find(FindRefundsParams query,
                                CallContext context)

Resource /{merchantId}/refunds - Find refunds

Parameters:

query - FindRefundsParams

context - CallContext

Returns:

FindRefundsResponse

Throws:

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

public RefundResponse get(String refundId)

Resource /{merchantId}/refunds/{refundId} - Get refund

Parameters:

refundId - String

Returns:

RefundResponse

Throws:

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

public RefundResponse get(String refundId,
                          CallContext context)

Resource /{merchantId}/refunds/{refundId} - Get refund

Parameters:

refundId - String

context - CallContext

Returns:

RefundResponse

Throws:

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

approve

public void approve(String refundId,
                    ApproveRefundRequest body)

Resource /{merchantId}/refunds/{refundId}/approve - Approve refund

Parameters:

refundId - String

body - ApproveRefundRequest

Throws:

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

approve

public void approve(String refundId,
                    ApproveRefundRequest body,
                    CallContext context)

Resource /{merchantId}/refunds/{refundId}/approve - Approve refund

Parameters:

refundId - String

body - ApproveRefundRequest

context - CallContext

Throws:

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

public void cancel(String refundId)

Resource /{merchantId}/refunds/{refundId}/cancel - Cancel refund

Parameters:

refundId - String

Throws:

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

public void cancel(String refundId,
                   CallContext context)

Resource /{merchantId}/refunds/{refundId}/cancel - Cancel refund

Parameters:

refundId - String

context - CallContext

Throws:

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

public void cancelapproval(String refundId)

Resource /{merchantId}/refunds/{refundId}/cancelapproval - Undo approve refund

Parameters:

refundId - String

Throws:

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

public void cancelapproval(String refundId,
                           CallContext context)

Resource /{merchantId}/refunds/{refundId}/cancelapproval - Undo approve refund

Parameters:

refundId - String

context - CallContext

Throws:

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