class Ingenico::Connect::SDK::Merchant::Payouts::PayoutsClient

Payouts client. Thread-safe.

def approve(payout_id, body, context=nil)

Raises:
  • (Ingenico::Connect::SDK::ApiException) - if the Ingenico ePayments platform returned any other error
  • (Ingenico::Connect::SDK::GlobalCollectException) - if something went wrong at the Ingenico ePayments platform,
  • (Ingenico::Connect::SDK::ReferenceException) - if an object was attempted to be referenced that doesn't exist or has been removed,
  • (Ingenico::Connect::SDK::IdempotenceException) - if an idempotent request caused a conflict (HTTP status code 409)
  • (Ingenico::Connect::SDK::AuthorizationException) - if the request was not allowed (HTTP status code 403)
  • (Ingenico::Connect::SDK::ValidationException) - if the request was not correct and couldn't be processed (HTTP status code 400)

Returns:
  • (Ingenico::Connect::SDK::Domain::Payout::PayoutResponse) -

Parameters:
  • context (Ingenico::Connect::SDK::CallContext) --
  • body (Ingenico::Connect::SDK::Domain::Payout::ApprovePayoutRequest) --
  • payout_id (String) --
def approve(payout_id, body, context=nil)
  path_context = {
    'payoutId'.freeze => payout_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payouts/{payoutId}/approve', path_context)
  return @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Ingenico::Connect::SDK::Domain::Payout::PayoutResponse,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

def cancel(payout_id, context=nil)

Raises:
  • (Ingenico::Connect::SDK::ApiException) - if the Ingenico ePayments platform returned any other error
  • (Ingenico::Connect::SDK::GlobalCollectException) - if something went wrong at the Ingenico ePayments platform,
  • (Ingenico::Connect::SDK::ReferenceException) - if an object was attempted to be referenced that doesn't exist or has been removed,
  • (Ingenico::Connect::SDK::IdempotenceException) - if an idempotent request caused a conflict (HTTP status code 409)
  • (Ingenico::Connect::SDK::AuthorizationException) - if the request was not allowed (HTTP status code 403)
  • (Ingenico::Connect::SDK::ValidationException) - if the request was not correct and couldn't be processed (HTTP status code 400)

Parameters:
  • context (Ingenico::Connect::SDK::CallContext) --
  • payout_id (String) --
def cancel(payout_id, context=nil)
  path_context = {
    'payoutId'.freeze => payout_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payouts/{payoutId}/cancel', path_context)
  return @communicator.post(
    uri,
    client_headers,
    nil,
    nil,
    nil,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

def cancelapproval(payout_id, context=nil)

Raises:
  • (Ingenico::Connect::SDK::ApiException) - if the Ingenico ePayments platform returned any other error
  • (Ingenico::Connect::SDK::GlobalCollectException) - if something went wrong at the Ingenico ePayments platform,
  • (Ingenico::Connect::SDK::ReferenceException) - if an object was attempted to be referenced that doesn't exist or has been removed,
  • (Ingenico::Connect::SDK::IdempotenceException) - if an idempotent request caused a conflict (HTTP status code 409)
  • (Ingenico::Connect::SDK::AuthorizationException) - if the request was not allowed (HTTP status code 403)
  • (Ingenico::Connect::SDK::ValidationException) - if the request was not correct and couldn't be processed (HTTP status code 400)

Parameters:
  • context (Ingenico::Connect::SDK::CallContext) --
  • payout_id (String) --
def cancelapproval(payout_id, context=nil)
  path_context = {
    'payoutId'.freeze => payout_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payouts/{payoutId}/cancelapproval', path_context)
  return @communicator.post(
    uri,
    client_headers,
    nil,
    nil,
    nil,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

def create(body, context=nil)

Raises:
  • (Ingenico::Connect::SDK::ApiException) - if the Ingenico ePayments platform returned any other error
  • (Ingenico::Connect::SDK::GlobalCollectException) - if something went wrong at the Ingenico ePayments platform,
  • (Ingenico::Connect::SDK::ReferenceException) - if an object was attempted to be referenced that doesn't exist or has been removed,
  • (Ingenico::Connect::SDK::IdempotenceException) - if an idempotent request caused a conflict (HTTP status code 409)
  • (Ingenico::Connect::SDK::AuthorizationException) - if the request was not allowed (HTTP status code 403)
  • (Ingenico::Connect::SDK::ValidationException) - if the request was not correct and couldn't be processed (HTTP status code 400)
  • (Ingenico::Connect::SDK::DeclinedPayoutException) - if the Ingenico ePayments platform declined / rejected the payout. The payout result will be available from the exception.

Returns:
  • (Ingenico::Connect::SDK::Domain::Payout::PayoutResponse) -

Parameters:
  • context (Ingenico::Connect::SDK::CallContext) --
  • body (Ingenico::Connect::SDK::Domain::Payout::CreatePayoutRequest) --
def create(body, context=nil)
  uri = instantiate_uri('/v1/{merchantId}/payouts', nil)
  return @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Ingenico::Connect::SDK::Domain::Payout::PayoutResponse,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Payout::PayoutErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

def find(query, context=nil)

Raises:
  • (Ingenico::Connect::SDK::ApiException) - if the Ingenico ePayments platform returned any other error
  • (Ingenico::Connect::SDK::GlobalCollectException) - if something went wrong at the Ingenico ePayments platform,
  • (Ingenico::Connect::SDK::ReferenceException) - if an object was attempted to be referenced that doesn't exist or has been removed,
  • (Ingenico::Connect::SDK::IdempotenceException) - if an idempotent request caused a conflict (HTTP status code 409)
  • (Ingenico::Connect::SDK::AuthorizationException) - if the request was not allowed (HTTP status code 403)
  • (Ingenico::Connect::SDK::ValidationException) - if the request was not correct and couldn't be processed (HTTP status code 400)

Returns:
  • (Ingenico::Connect::SDK::Domain::Payout::FindPayoutsResponse) -

Parameters:
  • context (Ingenico::Connect::SDK::CallContext) --
  • query (Ingenico::Connect::SDK::Merchant::Payouts::FindPayoutsParams) --
def find(query, context=nil)
  uri = instantiate_uri('/v1/{merchantId}/payouts', nil)
  return @communicator.get(
    uri,
    client_headers,
    query,
    Ingenico::Connect::SDK::Domain::Payout::FindPayoutsResponse,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

def get(payout_id, context=nil)

Raises:
  • (Ingenico::Connect::SDK::ApiException) - if the Ingenico ePayments platform returned any other error
  • (Ingenico::Connect::SDK::GlobalCollectException) - if something went wrong at the Ingenico ePayments platform,
  • (Ingenico::Connect::SDK::ReferenceException) - if an object was attempted to be referenced that doesn't exist or has been removed,
  • (Ingenico::Connect::SDK::IdempotenceException) - if an idempotent request caused a conflict (HTTP status code 409)
  • (Ingenico::Connect::SDK::AuthorizationException) - if the request was not allowed (HTTP status code 403)
  • (Ingenico::Connect::SDK::ValidationException) - if the request was not correct and couldn't be processed (HTTP status code 400)

Returns:
  • (Ingenico::Connect::SDK::Domain::Payout::PayoutResponse) -

Parameters:
  • context (Ingenico::Connect::SDK::CallContext) --
  • payout_id (String) --
def get(payout_id, context=nil)
  path_context = {
    'payoutId'.freeze => payout_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payouts/{payoutId}', path_context)
  return @communicator.get(
    uri,
    client_headers,
    nil,
    Ingenico::Connect::SDK::Domain::Payout::PayoutResponse,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

def initialize(parent, path_context)

Parameters:
  • path_context (Hash) --
  • parent (Ingenico::Connect::SDK::ApiResource) --
def initialize(parent, path_context)
  super(parent, path_context)
end