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

Class CapturesClient

java.lang.Object

com.worldline.connect.sdk.java.ApiResource

com.worldline.connect.sdk.java.v1.merchant.captures.CapturesClient

public class CapturesClient
extends ApiResource

Captures client. Thread-safe.

Field Summary

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

clientMetaInfo, communicator

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CaptureResponse	get(String captureId) Resource /{merchantId}/captures/{captureId} - Get capture
CaptureResponse	get(String captureId, CallContext context) Resource /{merchantId}/captures/{captureId} - Get capture
RefundResponse	refund(String captureId, RefundRequest body) Resource /{merchantId}/captures/{captureId}/refund - Create Refund
RefundResponse	refund(String captureId, RefundRequest body, CallContext context) Resource /{merchantId}/captures/{captureId}/refund - Create 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

CapturesClient

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

Method Detail

get

public CaptureResponse get(String captureId)

Resource /{merchantId}/captures/{captureId} - Get capture

Parameters:

captureId - String

Returns:

CaptureResponse

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 CaptureResponse get(String captureId,
                           CallContext context)

Resource /{merchantId}/captures/{captureId} - Get capture

Parameters:

captureId - String

context - CallContext

Returns:

CaptureResponse

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

refund

public RefundResponse refund(String captureId,
                             RefundRequest body)

Resource /{merchantId}/captures/{captureId}/refund - Create Refund

Parameters:

captureId - String

body - RefundRequest

Returns:

RefundResponse

Throws:

DeclinedRefundException - if the Worldline Global Collect 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 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

public RefundResponse refund(String captureId,
                             RefundRequest body,
                             CallContext context)

Resource /{merchantId}/captures/{captureId}/refund - Create Refund

Parameters:

captureId - String

body - RefundRequest

context - CallContext

Returns:

RefundResponse

Throws:

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