Class PayoutsClient

Payouts client. Thread-safe.

Inheritance

object

ApiResource

PayoutsClient

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

Assembly: Worldline.Connect.Sdk.dll

Syntax

public class PayoutsClient : ApiResource

Constructors

PayoutsClient(ApiResource, IDictionary<string, string>)

Declaration

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

Parameters

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

Methods

Approve(string, ApprovePayoutRequest, CallContext)

Resource /{merchantId}/payouts/{payoutId}/approve

Approve payout

Declaration

public Task<PayoutResponse> Approve(string payoutId, ApprovePayoutRequest body, CallContext context = null)

Parameters

Type	Name	Description
string	payoutId	string
ApprovePayoutRequest	body	ApprovePayoutRequest
CallContext	context	CallContext

Returns

Type	Description
Task<PayoutResponse>	PayoutResponse

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}/payouts/{payoutId}/cancel

Cancel payout

Declaration

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

Parameters

Type	Name	Description
string	payoutId	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}/payouts/{payoutId}/cancelapproval

Undo approve payout

Declaration

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

Parameters

Type	Name	Description
string	payoutId	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

Create(CreatePayoutRequest, CallContext)

Resource /{merchantId}/payouts

Create payout

Declaration

public Task<PayoutResponse> Create(CreatePayoutRequest body, CallContext context = null)

Parameters

Type	Name	Description
CreatePayoutRequest	body	CreatePayoutRequest
CallContext	context	CallContext

Returns

Type	Description
Task<PayoutResponse>	PayoutResponse

Exceptions

Type	Condition
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(FindPayoutsParams, CallContext)

Resource /{merchantId}/payouts

Find payouts

Declaration

public Task<FindPayoutsResponse> Find(FindPayoutsParams query, CallContext context = null)

Parameters

Type	Name	Description
FindPayoutsParams	query	FindPayoutsParams
CallContext	context	CallContext

Returns

Type	Description
Task<FindPayoutsResponse>	FindPayoutsResponse

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}/payouts/{payoutId}

Get payout

Declaration

public Task<PayoutResponse> Get(string payoutId, CallContext context = null)

Parameters

Type	Name	Description
string	payoutId	string
CallContext	context	CallContext

Returns

Type	Description
Task<PayoutResponse>	PayoutResponse

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