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

Class PayoutsClient

java.lang.Object

com.worldline.connect.sdk.java.ApiResource

com.worldline.connect.sdk.java.v1.merchant.payouts.PayoutsClient

public class PayoutsClient
extends ApiResource

Payouts client. Thread-safe.

Field Summary

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

clientMetaInfo, communicator

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PayoutResponse	approve(String payoutId, ApprovePayoutRequest body) Resource /{merchantId}/payouts/{payoutId}/approve - Approve payout
PayoutResponse	approve(String payoutId, ApprovePayoutRequest body, CallContext context) Resource /{merchantId}/payouts/{payoutId}/approve - Approve payout
void	cancel(String payoutId) Resource /{merchantId}/payouts/{payoutId}/cancel - Cancel payout
void	cancel(String payoutId, CallContext context) Resource /{merchantId}/payouts/{payoutId}/cancel - Cancel payout
void	cancelapproval(String payoutId) Resource /{merchantId}/payouts/{payoutId}/cancelapproval - Undo approve payout
void	cancelapproval(String payoutId, CallContext context) Resource /{merchantId}/payouts/{payoutId}/cancelapproval - Undo approve payout
PayoutResponse	create(CreatePayoutRequest body) Resource /{merchantId}/payouts - Create payout
PayoutResponse	create(CreatePayoutRequest body, CallContext context) Resource /{merchantId}/payouts - Create payout
FindPayoutsResponse	find(FindPayoutsParams query) Resource /{merchantId}/payouts - Find payouts
FindPayoutsResponse	find(FindPayoutsParams query, CallContext context) Resource /{merchantId}/payouts - Find payouts
PayoutResponse	get(String payoutId) Resource /{merchantId}/payouts/{payoutId} - Get payout
PayoutResponse	get(String payoutId, CallContext context) Resource /{merchantId}/payouts/{payoutId} - Get payout

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

PayoutsClient

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

Method Detail

create

public PayoutResponse create(CreatePayoutRequest body)

Resource /{merchantId}/payouts - Create payout

Parameters:

body - CreatePayoutRequest

Returns:

PayoutResponse

Throws:

DeclinedPayoutException - if the Worldline Global Collect platform declined / rejected the payout. The payout 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 PayoutResponse create(CreatePayoutRequest body,
                             CallContext context)

Resource /{merchantId}/payouts - Create payout

Parameters:

body - CreatePayoutRequest

context - CallContext

Returns:

PayoutResponse

Throws:

DeclinedPayoutException - if the Worldline Global Collect platform declined / rejected the payout. The payout 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 FindPayoutsResponse find(FindPayoutsParams query)

Resource /{merchantId}/payouts - Find payouts

Parameters:

query - FindPayoutsParams

Returns:

FindPayoutsResponse

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 FindPayoutsResponse find(FindPayoutsParams query,
                                CallContext context)

Resource /{merchantId}/payouts - Find payouts

Parameters:

query - FindPayoutsParams

context - CallContext

Returns:

FindPayoutsResponse

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 PayoutResponse get(String payoutId)

Resource /{merchantId}/payouts/{payoutId} - Get payout

Parameters:

payoutId - String

Returns:

PayoutResponse

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 PayoutResponse get(String payoutId,
                          CallContext context)

Resource /{merchantId}/payouts/{payoutId} - Get payout

Parameters:

payoutId - String

context - CallContext

Returns:

PayoutResponse

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 PayoutResponse approve(String payoutId,
                              ApprovePayoutRequest body)

Resource /{merchantId}/payouts/{payoutId}/approve - Approve payout

Parameters:

payoutId - String

body - ApprovePayoutRequest

Returns:

PayoutResponse

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 PayoutResponse approve(String payoutId,
                              ApprovePayoutRequest body,
                              CallContext context)

Resource /{merchantId}/payouts/{payoutId}/approve - Approve payout

Parameters:

payoutId - String

body - ApprovePayoutRequest

context - CallContext

Returns:

PayoutResponse

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 payoutId)

Resource /{merchantId}/payouts/{payoutId}/cancel - Cancel payout

Parameters:

payoutId - 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 payoutId,
                   CallContext context)

Resource /{merchantId}/payouts/{payoutId}/cancel - Cancel payout

Parameters:

payoutId - 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 payoutId)

Resource /{merchantId}/payouts/{payoutId}/cancelapproval - Undo approve payout

Parameters:

payoutId - 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 payoutId,
                           CallContext context)

Resource /{merchantId}/payouts/{payoutId}/cancelapproval - Undo approve payout

Parameters:

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