class Ingenico::Connect::SDK::Merchant::Payouts::PayoutsClient
Payouts
client. Thread-safe.
Public Class Methods
@param parent [Ingenico::Connect::SDK::ApiResource] @param path_context [Hash]
Ingenico::Connect::SDK::ApiResource::new
# File lib/ingenico/connect/sdk/merchant/payouts/payouts_client.rb, line 21 def initialize(parent, path_context) super(parent, path_context) end
Public Instance Methods
Resource /!{merchantId}/payouts/!{payoutId}/approve - {epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/approve.html Approve payout} @param payout_id [String] @param body [Ingenico::Connect::SDK::Domain::Payout::ApprovePayoutRequest] @param context [Ingenico::Connect::SDK::CallContext] @return [Ingenico::Connect::SDK::Domain::Payout::PayoutResponse] @raise [Ingenico::Connect::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400) @raise [Ingenico::Connect::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403) @raise [Ingenico::Connect::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409) @raise [Ingenico::Connect::SDK::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)
@raise [Ingenico::Connect::SDK::GlobalCollectException] if something went wrong at the Ingenico
ePayments platform,
the Ingenico ePayments 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)
@raise [Ingenico::Connect::SDK::ApiException]if the Ingenico
ePayments platform returned any other error
# File lib/ingenico/connect/sdk/merchant/payouts/payouts_client.rb, line 125 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
Resource /!{merchantId}/payouts/!{payoutId}/cancel - {epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/cancel.html Cancel payout} @param payout_id [String] @param context [Ingenico::Connect::SDK::CallContext] @raise [Ingenico::Connect::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400) @raise [Ingenico::Connect::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403) @raise [Ingenico::Connect::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409) @raise [Ingenico::Connect::SDK::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)
@raise [Ingenico::Connect::SDK::GlobalCollectException] if something went wrong at the Ingenico
ePayments platform,
the Ingenico ePayments 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)
@raise [Ingenico::Connect::SDK::ApiException]if the Ingenico
ePayments platform returned any other error
# File lib/ingenico/connect/sdk/merchant/payouts/payouts_client.rb, line 155 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
Resource /!{merchantId}/payouts/!{payoutId}/cancelapproval - {epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/cancelapproval.html Undo approve payout} @param payout_id [String] @param context [Ingenico::Connect::SDK::CallContext] @raise [Ingenico::Connect::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400) @raise [Ingenico::Connect::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403) @raise [Ingenico::Connect::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409) @raise [Ingenico::Connect::SDK::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)
@raise [Ingenico::Connect::SDK::GlobalCollectException] if something went wrong at the Ingenico
ePayments platform,
the Ingenico ePayments 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)
@raise [Ingenico::Connect::SDK::ApiException]if the Ingenico
ePayments platform returned any other error
# File lib/ingenico/connect/sdk/merchant/payouts/payouts_client.rb, line 185 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
Resource /!{merchantId}/payouts - {epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/create.html Create payout} @param body [Ingenico::Connect::SDK::Domain::Payout::CreatePayoutRequest] @param context [Ingenico::Connect::SDK::CallContext] @return [Ingenico::Connect::SDK::Domain::Payout::PayoutResponse] @raise [Ingenico::Connect::SDK::DeclinedPayoutException] if the Ingenico
ePayments platform declined / rejected the payout. The payout result will be available from the exception. @raise [Ingenico::Connect::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400) @raise [Ingenico::Connect::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403) @raise [Ingenico::Connect::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409) @raise [Ingenico::Connect::SDK::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)
@raise [Ingenico::Connect::SDK::GlobalCollectException] if something went wrong at the Ingenico
ePayments platform,
the Ingenico ePayments 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)
@raise [Ingenico::Connect::SDK::ApiException]if the Ingenico
ePayments platform returned any other error
# File lib/ingenico/connect/sdk/merchant/payouts/payouts_client.rb, line 39 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
Resource /!{merchantId}/payouts - {epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/find.html Find payouts} @param query [Ingenico::Connect::SDK::Merchant::Payouts::FindPayoutsParams] @param context [Ingenico::Connect::SDK::CallContext] @return [Ingenico::Connect::SDK::Domain::Payout::FindPayoutsResponse] @raise [Ingenico::Connect::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400) @raise [Ingenico::Connect::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403) @raise [Ingenico::Connect::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409) @raise [Ingenico::Connect::SDK::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)
@raise [Ingenico::Connect::SDK::GlobalCollectException] if something went wrong at the Ingenico
ePayments platform,
the Ingenico ePayments 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)
@raise [Ingenico::Connect::SDK::ApiException]if the Ingenico
ePayments platform returned any other error
# File lib/ingenico/connect/sdk/merchant/payouts/payouts_client.rb, line 67 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
Resource /!{merchantId}/payouts/!{payoutId} - {epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/get.html Get payout} @param payout_id [String] @param context [Ingenico::Connect::SDK::CallContext] @return [Ingenico::Connect::SDK::Domain::Payout::PayoutResponse] @raise [Ingenico::Connect::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400) @raise [Ingenico::Connect::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403) @raise [Ingenico::Connect::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409) @raise [Ingenico::Connect::SDK::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)
@raise [Ingenico::Connect::SDK::GlobalCollectException] if something went wrong at the Ingenico
ePayments platform,
the Ingenico ePayments 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)
@raise [Ingenico::Connect::SDK::ApiException]if the Ingenico
ePayments platform returned any other error
# File lib/ingenico/connect/sdk/merchant/payouts/payouts_client.rb, line 94 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