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

Class PaymentsClient

java.lang.Object

com.worldline.connect.sdk.java.ApiResource

com.worldline.connect.sdk.java.v1.merchant.payments.PaymentsClient

public class PaymentsClient
extends ApiResource

Payments client. Thread-safe.

Field Summary

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

clientMetaInfo, communicator

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PaymentApprovalResponse	approve(String paymentId, ApprovePaymentRequest body) Resource /{merchantId}/payments/{paymentId}/approve - Approve payment
PaymentApprovalResponse	approve(String paymentId, ApprovePaymentRequest body, CallContext context) Resource /{merchantId}/payments/{paymentId}/approve - Approve payment
CancelPaymentResponse	cancel(String paymentId) Resource /{merchantId}/payments/{paymentId}/cancel - Cancel payment
CancelPaymentResponse	cancel(String paymentId, CallContext context) Resource /{merchantId}/payments/{paymentId}/cancel - Cancel payment
CancelApprovalPaymentResponse	cancelapproval(String paymentId) Resource /{merchantId}/payments/{paymentId}/cancelapproval - Undo capture payment
CancelApprovalPaymentResponse	cancelapproval(String paymentId, CallContext context) Resource /{merchantId}/payments/{paymentId}/cancelapproval - Undo capture payment
CaptureResponse	capture(String paymentId, CapturePaymentRequest body) Resource /{merchantId}/payments/{paymentId}/capture - Capture payment
CaptureResponse	capture(String paymentId, CapturePaymentRequest body, CallContext context) Resource /{merchantId}/payments/{paymentId}/capture - Capture payment
CapturesResponse	captures(String paymentId) Resource /{merchantId}/payments/{paymentId}/captures - Get captures of payment
CapturesResponse	captures(String paymentId, CallContext context) Resource /{merchantId}/payments/{paymentId}/captures - Get captures of payment
CompletePaymentResponse	complete(String paymentId, CompletePaymentRequest body) Resource /{merchantId}/payments/{paymentId}/complete - Complete payment
CompletePaymentResponse	complete(String paymentId, CompletePaymentRequest body, CallContext context) Resource /{merchantId}/payments/{paymentId}/complete - Complete payment
CreatePaymentResponse	create(CreatePaymentRequest body) Resource /{merchantId}/payments - Create payment
CreatePaymentResponse	create(CreatePaymentRequest body, CallContext context) Resource /{merchantId}/payments - Create payment
DeviceFingerprintDetails	devicefingerprint(String paymentId) Resource /{merchantId}/payments/{paymentId}/devicefingerprint - Get Device Fingerprint details
DeviceFingerprintDetails	devicefingerprint(String paymentId, CallContext context) Resource /{merchantId}/payments/{paymentId}/devicefingerprint - Get Device Fingerprint details
DisputeResponse	dispute(String paymentId, CreateDisputeRequest body) Resource /{merchantId}/payments/{paymentId}/dispute - Create dispute
DisputeResponse	dispute(String paymentId, CreateDisputeRequest body, CallContext context) Resource /{merchantId}/payments/{paymentId}/dispute - Create dispute
DisputesResponse	disputes(String paymentId) Resource /{merchantId}/payments/{paymentId}/disputes - Get disputes
DisputesResponse	disputes(String paymentId, CallContext context) Resource /{merchantId}/payments/{paymentId}/disputes - Get disputes
FindPaymentsResponse	find(FindPaymentsParams query) Resource /{merchantId}/payments - Find payments
FindPaymentsResponse	find(FindPaymentsParams query, CallContext context) Resource /{merchantId}/payments - Find payments
PaymentResponse	get(String paymentId) Resource /{merchantId}/payments/{paymentId} - Get payment
PaymentResponse	get(String paymentId, CallContext context) Resource /{merchantId}/payments/{paymentId} - Get payment
PaymentResponse	processchallenged(String paymentId) Resource /{merchantId}/payments/{paymentId}/processchallenged - Approves challenged payment
PaymentResponse	processchallenged(String paymentId, CallContext context) Resource /{merchantId}/payments/{paymentId}/processchallenged - Approves challenged payment
RefundResponse	refund(String paymentId, RefundRequest body) Resource /{merchantId}/payments/{paymentId}/refund - Create refund
RefundResponse	refund(String paymentId, RefundRequest body, CallContext context) Resource /{merchantId}/payments/{paymentId}/refund - Create refund
RefundsResponse	refunds(String paymentId) Resource /{merchantId}/payments/{paymentId}/refunds - Get refunds of payment
RefundsResponse	refunds(String paymentId, CallContext context) Resource /{merchantId}/payments/{paymentId}/refunds - Get refunds of payment
ThirdPartyStatusResponse	thirdPartyStatus(String paymentId) Resource /{merchantId}/payments/{paymentId}/thirdpartystatus - Third party status poll
ThirdPartyStatusResponse	thirdPartyStatus(String paymentId, CallContext context) Resource /{merchantId}/payments/{paymentId}/thirdpartystatus - Third party status poll
CreateTokenResponse	tokenize(String paymentId, TokenizePaymentRequest body) Resource /{merchantId}/payments/{paymentId}/tokenize - Create a token from payment
CreateTokenResponse	tokenize(String paymentId, TokenizePaymentRequest body, CallContext context) Resource /{merchantId}/payments/{paymentId}/tokenize - Create a token from payment

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

PaymentsClient

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

Method Detail

create

public CreatePaymentResponse create(CreatePaymentRequest body)

Resource /{merchantId}/payments - Create payment

Parameters:

body - CreatePaymentRequest

Returns:

CreatePaymentResponse

Throws:

DeclinedPaymentException - if the Worldline Global Collect platform declined / rejected the payment. The payment 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

create

public CreatePaymentResponse create(CreatePaymentRequest body,
                                    CallContext context)

Resource /{merchantId}/payments - Create payment

Parameters:

body - CreatePaymentRequest

context - CallContext

Returns:

CreatePaymentResponse

Throws:

DeclinedPaymentException - if the Worldline Global Collect platform declined / rejected the payment. The payment 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

find

public FindPaymentsResponse find(FindPaymentsParams query)

Resource /{merchantId}/payments - Find payments

Parameters:

query - FindPaymentsParams

Returns:

FindPaymentsResponse

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 FindPaymentsResponse find(FindPaymentsParams query,
                                 CallContext context)

Resource /{merchantId}/payments - Find payments

Parameters:

query - FindPaymentsParams

context - CallContext

Returns:

FindPaymentsResponse

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 PaymentResponse get(String paymentId)

Resource /{merchantId}/payments/{paymentId} - Get payment

Parameters:

paymentId - String

Returns:

PaymentResponse

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 PaymentResponse get(String paymentId,
                           CallContext context)

Resource /{merchantId}/payments/{paymentId} - Get payment

Parameters:

paymentId - String

context - CallContext

Returns:

PaymentResponse

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

complete

public CompletePaymentResponse complete(String paymentId,
                                        CompletePaymentRequest body)

Resource /{merchantId}/payments/{paymentId}/complete - Complete payment

Parameters:

paymentId - String

body - CompletePaymentRequest

Returns:

CompletePaymentResponse

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

complete

public CompletePaymentResponse complete(String paymentId,
                                        CompletePaymentRequest body,
                                        CallContext context)

Resource /{merchantId}/payments/{paymentId}/complete - Complete payment

Parameters:

paymentId - String

body - CompletePaymentRequest

context - CallContext

Returns:

CompletePaymentResponse

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

thirdPartyStatus

public ThirdPartyStatusResponse thirdPartyStatus(String paymentId)

Resource /{merchantId}/payments/{paymentId}/thirdpartystatus - Third party status poll

Parameters:

paymentId - String

Returns:

ThirdPartyStatusResponse

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

thirdPartyStatus

public ThirdPartyStatusResponse thirdPartyStatus(String paymentId,
                                                 CallContext context)

Resource /{merchantId}/payments/{paymentId}/thirdpartystatus - Third party status poll

Parameters:

paymentId - String

context - CallContext

Returns:

ThirdPartyStatusResponse

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

tokenize

public CreateTokenResponse tokenize(String paymentId,
                                    TokenizePaymentRequest body)

Resource /{merchantId}/payments/{paymentId}/tokenize - Create a token from payment

Parameters:

paymentId - String

body - TokenizePaymentRequest

Returns:

CreateTokenResponse

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

tokenize

public CreateTokenResponse tokenize(String paymentId,
                                    TokenizePaymentRequest body,
                                    CallContext context)

Resource /{merchantId}/payments/{paymentId}/tokenize - Create a token from payment

Parameters:

paymentId - String

body - TokenizePaymentRequest

context - CallContext

Returns:

CreateTokenResponse

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

processchallenged

public PaymentResponse processchallenged(String paymentId)

Resource /{merchantId}/payments/{paymentId}/processchallenged - Approves challenged payment

Parameters:

paymentId - String

Returns:

PaymentResponse

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

processchallenged

public PaymentResponse processchallenged(String paymentId,
                                         CallContext context)

Resource /{merchantId}/payments/{paymentId}/processchallenged - Approves challenged payment

Parameters:

paymentId - String

context - CallContext

Returns:

PaymentResponse

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 PaymentApprovalResponse approve(String paymentId,
                                       ApprovePaymentRequest body)

Resource /{merchantId}/payments/{paymentId}/approve - Approve payment

Parameters:

paymentId - String

body - ApprovePaymentRequest

Returns:

PaymentApprovalResponse

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 PaymentApprovalResponse approve(String paymentId,
                                       ApprovePaymentRequest body,
                                       CallContext context)

Resource /{merchantId}/payments/{paymentId}/approve - Approve payment

Parameters:

paymentId - String

body - ApprovePaymentRequest

context - CallContext

Returns:

PaymentApprovalResponse

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

capture

public CaptureResponse capture(String paymentId,
                               CapturePaymentRequest body)

Resource /{merchantId}/payments/{paymentId}/capture - Capture payment

Parameters:

paymentId - String

body - CapturePaymentRequest

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

capture

public CaptureResponse capture(String paymentId,
                               CapturePaymentRequest body,
                               CallContext context)

Resource /{merchantId}/payments/{paymentId}/capture - Capture payment

Parameters:

paymentId - String

body - CapturePaymentRequest

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

cancelapproval

public CancelApprovalPaymentResponse cancelapproval(String paymentId)

Resource /{merchantId}/payments/{paymentId}/cancelapproval - Undo capture payment

Parameters:

paymentId - String

Returns:

CancelApprovalPaymentResponse

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 CancelApprovalPaymentResponse cancelapproval(String paymentId,
                                                    CallContext context)

Resource /{merchantId}/payments/{paymentId}/cancelapproval - Undo capture payment

Parameters:

paymentId - String

context - CallContext

Returns:

CancelApprovalPaymentResponse

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

captures

public CapturesResponse captures(String paymentId)

Resource /{merchantId}/payments/{paymentId}/captures - Get captures of payment

Parameters:

paymentId - String

Returns:

CapturesResponse

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

captures

public CapturesResponse captures(String paymentId,
                                 CallContext context)

Resource /{merchantId}/payments/{paymentId}/captures - Get captures of payment

Parameters:

paymentId - String

context - CallContext

Returns:

CapturesResponse

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 paymentId,
                             RefundRequest body)

Resource /{merchantId}/payments/{paymentId}/refund - Create refund

Parameters:

paymentId - 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 paymentId,
                             RefundRequest body,
                             CallContext context)

Resource /{merchantId}/payments/{paymentId}/refund - Create refund

Parameters:

paymentId - 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

refunds

public RefundsResponse refunds(String paymentId)

Resource /{merchantId}/payments/{paymentId}/refunds - Get refunds of payment

Parameters:

paymentId - String

Returns:

RefundsResponse

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

refunds

public RefundsResponse refunds(String paymentId,
                               CallContext context)

Resource /{merchantId}/payments/{paymentId}/refunds - Get refunds of payment

Parameters:

paymentId - String

context - CallContext

Returns:

RefundsResponse

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 CancelPaymentResponse cancel(String paymentId)

Resource /{merchantId}/payments/{paymentId}/cancel - Cancel payment

Parameters:

paymentId - String

Returns:

CancelPaymentResponse

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 CancelPaymentResponse cancel(String paymentId,
                                    CallContext context)

Resource /{merchantId}/payments/{paymentId}/cancel - Cancel payment

Parameters:

paymentId - String

context - CallContext

Returns:

CancelPaymentResponse

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

dispute

public DisputeResponse dispute(String paymentId,
                               CreateDisputeRequest body)

Resource /{merchantId}/payments/{paymentId}/dispute - Create dispute

Parameters:

paymentId - String

body - CreateDisputeRequest

Returns:

DisputeResponse

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

dispute

public DisputeResponse dispute(String paymentId,
                               CreateDisputeRequest body,
                               CallContext context)

Resource /{merchantId}/payments/{paymentId}/dispute - Create dispute

Parameters:

paymentId - String

body - CreateDisputeRequest

context - CallContext

Returns:

DisputeResponse

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

disputes

public DisputesResponse disputes(String paymentId)

Resource /{merchantId}/payments/{paymentId}/disputes - Get disputes

Parameters:

paymentId - String

Returns:

DisputesResponse

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

disputes

public DisputesResponse disputes(String paymentId,
                                 CallContext context)

Resource /{merchantId}/payments/{paymentId}/disputes - Get disputes

Parameters:

paymentId - String

context - CallContext

Returns:

DisputesResponse

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

devicefingerprint

public DeviceFingerprintDetails devicefingerprint(String paymentId)

Resource /{merchantId}/payments/{paymentId}/devicefingerprint - Get Device Fingerprint details

Parameters:

paymentId - String

Returns:

DeviceFingerprintDetails

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

devicefingerprint

public DeviceFingerprintDetails devicefingerprint(String paymentId,
                                                  CallContext context)

Resource /{merchantId}/payments/{paymentId}/devicefingerprint - Get Device Fingerprint details

Parameters:

paymentId - String

context - CallContext

Returns:

DeviceFingerprintDetails

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