connect-sdk-ruby 1.7.0 → 1.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/connect-sdk-ruby.gemspec +3 -3
- data/examples/merchant/payments/create_payment_example.rb +14 -10
- data/examples/merchant/payouts/create_payout_example.rb +9 -5
- data/lib/ingenico/connect/sdk/api_exception.rb +4 -4
- data/lib/ingenico/connect/sdk/api_resource.rb +3 -3
- data/lib/ingenico/connect/sdk/authenticator.rb +1 -1
- data/lib/ingenico/connect/sdk/authorization_exception.rb +2 -2
- data/lib/ingenico/connect/sdk/call_context.rb +1 -1
- data/lib/ingenico/connect/sdk/client.rb +1 -1
- data/lib/ingenico/connect/sdk/communication_exception.rb +1 -1
- data/lib/ingenico/connect/sdk/communicator.rb +10 -10
- data/lib/ingenico/connect/sdk/communicator_configuration.rb +11 -11
- data/lib/ingenico/connect/sdk/declined_payment_exception.rb +3 -3
- data/lib/ingenico/connect/sdk/declined_payout_exception.rb +3 -3
- data/lib/ingenico/connect/sdk/declined_refund_exception.rb +3 -3
- data/lib/ingenico/connect/sdk/declined_transaction_exception.rb +1 -1
- data/lib/ingenico/connect/sdk/defaultimpl/default_authenticator.rb +1 -1
- data/lib/ingenico/connect/sdk/defaultimpl/default_connection.rb +5 -5
- data/lib/ingenico/connect/sdk/domain/payment/approve_payment_direct_debit_payment_method_specific_input.rb +15 -0
- data/lib/ingenico/connect/sdk/domain/payment/approve_payment_non_sepa_direct_debit_payment_method_specific_input.rb +2 -2
- data/lib/ingenico/connect/sdk/domain/payment/approve_payment_sepa_direct_debit_payment_method_specific_input.rb +2 -2
- data/lib/ingenico/connect/sdk/domain/payment/complete_payment_request.rb +11 -0
- data/lib/ingenico/connect/sdk/domain/payment/order.rb +2 -0
- data/lib/ingenico/connect/sdk/domain/payment/payment_product840_specific_output.rb +11 -0
- data/lib/ingenico/connect/sdk/domain/payment/protection_eligibility.rb +38 -0
- data/lib/ingenico/connect/sdk/domain/payment/redirect_payment_method_specific_input.rb +11 -0
- data/lib/ingenico/connect/sdk/domain/payment/redirect_payment_method_specific_input_base.rb +14 -0
- data/lib/ingenico/connect/sdk/domain/payment/redirect_payment_product840_specific_input.rb +38 -0
- data/lib/ingenico/connect/sdk/domain/payment/shopping_cart.rb +14 -0
- data/lib/ingenico/connect/sdk/domain/product/abstract_indicator.rb +38 -0
- data/lib/ingenico/connect/sdk/domain/product/authentication_indicator.rb +15 -0
- data/lib/ingenico/connect/sdk/domain/product/payment_product.rb +11 -0
- data/lib/ingenico/connect/sdk/endpoint_configuration.rb +10 -10
- data/lib/ingenico/connect/sdk/factory.rb +4 -4
- data/lib/ingenico/connect/sdk/global_collect_exception.rb +3 -3
- data/lib/ingenico/connect/sdk/idempotence_exception.rb +2 -2
- data/lib/ingenico/connect/sdk/merchant/captures/captures_client.rb +3 -3
- data/lib/ingenico/connect/sdk/merchant/hostedcheckouts/hostedcheckouts_client.rb +6 -6
- data/lib/ingenico/connect/sdk/merchant/payments/payments_client.rb +38 -38
- data/lib/ingenico/connect/sdk/merchant/payouts/payouts_client.rb +16 -16
- data/lib/ingenico/connect/sdk/merchant/productgroups/productgroups_client.rb +6 -6
- data/lib/ingenico/connect/sdk/merchant/products/products_client.rb +15 -15
- data/lib/ingenico/connect/sdk/merchant/refunds/refunds_client.rb +12 -12
- data/lib/ingenico/connect/sdk/merchant/riskassessments/riskassessments_client.rb +6 -6
- data/lib/ingenico/connect/sdk/merchant/services/services_client.rb +12 -12
- data/lib/ingenico/connect/sdk/merchant/sessions/sessions_client.rb +3 -3
- data/lib/ingenico/connect/sdk/merchant/tokens/tokens_client.rb +15 -15
- data/lib/ingenico/connect/sdk/meta_data_provider.rb +2 -2
- data/lib/ingenico/connect/sdk/modules.rb +24 -24
- data/lib/ingenico/connect/sdk/not_found_exception.rb +1 -1
- data/lib/ingenico/connect/sdk/reference_exception.rb +2 -2
- data/lib/ingenico/connect/sdk/response_exception.rb +7 -7
- data/lib/ingenico/connect/sdk/session.rb +3 -3
- data/lib/ingenico/connect/sdk/validation_exception.rb +3 -3
- data/spec/integration/convert_amount_spec.rb +1 -1
- data/spec/integration/risk_assessments_spec.rb +1 -1
- metadata +11 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 980877434fcc0d67e0a3b79881d54a496584dff0
|
4
|
+
data.tar.gz: 84819aa760a8d93e692c0b2cbce97fa7a20a2f7c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7299829037d437656d41cee2a9331a67f35cc736d0ab7bfc7a368e771243f6ce62ebd6ba5f32b6080f40ce53f0c0a28fc976dcedf0f2013f897c17a1688f011f
|
7
|
+
data.tar.gz: 015e6059dc121b9dc0c34085147c173aa854802eaeef3e47a38e8d6cad9917964cebe3cd19774ef8e3973f554b86940c1040252770bf4794de63e75b4b7a7385
|
data/README.md
CHANGED
@@ -12,7 +12,7 @@ The Ruby SDK helps you to communicate with the [Ingenico Connect](http://www.ing
|
|
12
12
|
|
13
13
|
Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API keys.
|
14
14
|
|
15
|
-
See the [Ingenico Connect Developer Hub](https://developer.
|
15
|
+
See the [Ingenico Connect Developer Hub](https://epayments.developer-ingenico.com/documentation/sdk/server/ruby/) for more information on how to use the SDK.
|
16
16
|
|
17
17
|
## Structure of this repository
|
18
18
|
|
data/connect-sdk-ruby.gemspec
CHANGED
@@ -1,10 +1,10 @@
|
|
1
1
|
Gem::Specification.new do |spec|
|
2
2
|
spec.name = 'connect-sdk-ruby'
|
3
|
-
spec.version = '1.
|
3
|
+
spec.version = '1.8.0'
|
4
4
|
spec.authors = ['Ingenico ePayments']
|
5
5
|
spec.email = ['github@epay.ingenico.com']
|
6
|
-
spec.summary = %q{SDK to communicate with the
|
7
|
-
spec.description = %q{SDK to communicate with the
|
6
|
+
spec.summary = %q{SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API}
|
7
|
+
spec.description = %q{SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API}
|
8
8
|
spec.homepage = %q{https://github.com/Ingenico-ePayments/connect-sdk-ruby}
|
9
9
|
spec.license = 'MIT'
|
10
10
|
|
@@ -21,6 +21,7 @@ require 'ingenico/connect/sdk/domain/payment/order_invoice_data'
|
|
21
21
|
require 'ingenico/connect/sdk/domain/payment/order_references'
|
22
22
|
require 'ingenico/connect/sdk/domain/payment/personal_information'
|
23
23
|
require 'ingenico/connect/sdk/domain/payment/personal_name'
|
24
|
+
require 'ingenico/connect/sdk/domain/payment/shopping_cart'
|
24
25
|
|
25
26
|
Definitions = Ingenico::Connect::SDK::Domain::Definitions
|
26
27
|
Payment = Ingenico::Connect::SDK::Domain::Payment
|
@@ -96,6 +97,16 @@ def example
|
|
96
97
|
customer.shipping_address = shipping_address
|
97
98
|
customer.vat_number = '1234AB5678CD'
|
98
99
|
|
100
|
+
invoice_data = Payment::OrderInvoiceData.new
|
101
|
+
invoice_data.invoice_date = '20140306191500'
|
102
|
+
invoice_data.invoice_number = '000000123'
|
103
|
+
|
104
|
+
references = Payment::OrderReferences.new
|
105
|
+
references.descriptor = 'Fast and Furry-ous'
|
106
|
+
references.invoice_data = invoice_data
|
107
|
+
references.merchant_order_id = 123456
|
108
|
+
references.merchant_reference = 'AcmeOrder0001'
|
109
|
+
|
99
110
|
items = []
|
100
111
|
|
101
112
|
item1_amount_of_money = Definitions::AmountOfMoney.new
|
@@ -128,21 +139,14 @@ def example
|
|
128
139
|
|
129
140
|
items << item2
|
130
141
|
|
131
|
-
|
132
|
-
|
133
|
-
invoice_data.invoice_number = '000000123'
|
134
|
-
|
135
|
-
references = Payment::OrderReferences.new
|
136
|
-
references.descriptor = 'Fast and Furry-ous'
|
137
|
-
references.invoice_data = invoice_data
|
138
|
-
references.merchant_order_id = 123456
|
139
|
-
references.merchant_reference = 'AcmeOrder0001'
|
142
|
+
shopping_cart = Payment::ShoppingCart.new
|
143
|
+
shopping_cart.items = items
|
140
144
|
|
141
145
|
order = Payment::Order.new
|
142
146
|
order.amount_of_money = amount_of_money
|
143
147
|
order.customer = customer
|
144
|
-
order.items = items
|
145
148
|
order.references = references
|
149
|
+
order.shopping_cart = shopping_cart
|
146
150
|
|
147
151
|
body = Payment::CreatePaymentRequest.new
|
148
152
|
body.card_payment_method_specific_input = card_payment_method_specific_input
|
@@ -11,6 +11,7 @@ require 'ingenico/connect/sdk/domain/definitions/bank_account_iban'
|
|
11
11
|
require 'ingenico/connect/sdk/domain/definitions/company_information'
|
12
12
|
require 'ingenico/connect/sdk/domain/definitions/contact_details_base'
|
13
13
|
require 'ingenico/connect/sdk/domain/payment/personal_name'
|
14
|
+
require 'ingenico/connect/sdk/domain/payout/bank_transfer_payout_method_specific_input'
|
14
15
|
require 'ingenico/connect/sdk/domain/payout/create_payout_request'
|
15
16
|
require 'ingenico/connect/sdk/domain/payout/payout_customer'
|
16
17
|
require 'ingenico/connect/sdk/domain/payout/payout_references'
|
@@ -55,17 +56,20 @@ def example
|
|
55
56
|
customer.contact_details = contact_details
|
56
57
|
customer.name = name
|
57
58
|
|
59
|
+
bank_transfer_payout_method_specific_input = Payout::BankTransferPayoutMethodSpecificInput.new
|
60
|
+
bank_transfer_payout_method_specific_input.bank_account_iban = bank_account_iban
|
61
|
+
bank_transfer_payout_method_specific_input.customer = customer
|
62
|
+
bank_transfer_payout_method_specific_input.payout_date = '20150102'
|
63
|
+
bank_transfer_payout_method_specific_input.payout_text = 'Payout Acme'
|
64
|
+
bank_transfer_payout_method_specific_input.swift_code = 'swift'
|
65
|
+
|
58
66
|
references = Payout::PayoutReferences.new
|
59
67
|
references.merchant_reference = 'AcmeOrder001'
|
60
68
|
|
61
69
|
body = Payout::CreatePayoutRequest.new
|
62
70
|
body.amount_of_money = amount_of_money
|
63
|
-
body.
|
64
|
-
body.customer = customer
|
65
|
-
body.payout_date = '20150102'
|
66
|
-
body.payout_text = 'Payout Acme'
|
71
|
+
body.bank_transfer_payout_method_specific_input = bank_transfer_payout_method_specific_input
|
67
72
|
body.references = references
|
68
|
-
body.swift_code = 'swift'
|
69
73
|
|
70
74
|
begin
|
71
75
|
response = client.merchant('merchantId').payouts().create(body)
|
@@ -1,11 +1,11 @@
|
|
1
1
|
module Ingenico::Connect::SDK
|
2
2
|
|
3
3
|
# Base class for many exceptions raised by the SDK.
|
4
|
-
# It is raised when an error response is received from the
|
4
|
+
# It is raised when an error response is received from the Ingenico ePayments platform.
|
5
5
|
# It contains data about the returned response.
|
6
6
|
class ApiException < RuntimeError
|
7
7
|
|
8
|
-
# Creates a new ApiException that reports an error response from the
|
8
|
+
# Creates a new ApiException that reports an error response from the Ingenico ePayments platform.
|
9
9
|
# It reports the following:
|
10
10
|
# status_code:: HTTP status code the response
|
11
11
|
# response_body:: HTTP response body
|
@@ -13,7 +13,7 @@ module Ingenico::Connect::SDK
|
|
13
13
|
# errors:: A list of errors that occurred, may be empty
|
14
14
|
# message:: Error message to include
|
15
15
|
def initialize(status_code, response_body, error_id, errors,
|
16
|
-
message='the
|
16
|
+
message='the Ingenico ePayments platform returned an error response')
|
17
17
|
super(message)
|
18
18
|
@status_code = status_code
|
19
19
|
@response_body = response_body
|
@@ -34,7 +34,7 @@ module Ingenico::Connect::SDK
|
|
34
34
|
# An error id corresponding to the error that occurred, if available.
|
35
35
|
attr_reader :error_id
|
36
36
|
|
37
|
-
# A list of errors received from the
|
37
|
+
# A list of errors received from the Ingenico ePayments platform;
|
38
38
|
# may be empty but never _nil_
|
39
39
|
attr_reader :errors
|
40
40
|
|
@@ -2,8 +2,8 @@ require 'ingenico/connect/sdk/domain/errors/error_response'
|
|
2
2
|
|
3
3
|
module Ingenico::Connect::SDK
|
4
4
|
|
5
|
-
# Base class of all
|
6
|
-
# Provides shared functionality to facilitate communication with the
|
5
|
+
# Base class of all Ingenico ePayments platform API resources.
|
6
|
+
# Provides shared functionality to facilitate communication with the Ingenico ePayments platform.
|
7
7
|
class ApiResource
|
8
8
|
|
9
9
|
# Creates a new ApiResource.
|
@@ -36,7 +36,7 @@ module Ingenico::Connect::SDK
|
|
36
36
|
end
|
37
37
|
end
|
38
38
|
|
39
|
-
# {Ingenico::Connect::SDK::Communicator} instance that provides communication with the
|
39
|
+
# {Ingenico::Connect::SDK::Communicator} instance that provides communication with the Ingenico ePayments platform.
|
40
40
|
attr_reader :communicator
|
41
41
|
|
42
42
|
# JSON string containing client info specific to the current client.
|
@@ -1,6 +1,6 @@
|
|
1
1
|
module Ingenico::Connect::SDK
|
2
2
|
|
3
|
-
# Abstract class that is responsible for authenticating requests sent to the
|
3
|
+
# Abstract class that is responsible for authenticating requests sent to the Ingenico ePayments platform.
|
4
4
|
class Authenticator
|
5
5
|
|
6
6
|
# Creates a signature to authenticate a request.
|
@@ -1,12 +1,12 @@
|
|
1
1
|
module Ingenico::Connect::SDK
|
2
2
|
|
3
|
-
# This exception is thrown when a request sent to the
|
3
|
+
# This exception is thrown when a request sent to the Ingenico ePayments platform is not correctly authenticated.
|
4
4
|
# Corresponds to a HTTP status code of 403.
|
5
5
|
# @see ApiException#initialize
|
6
6
|
class AuthorizationException < ApiException
|
7
7
|
|
8
8
|
def initialize(status_code, response_body, error_id, errors,
|
9
|
-
message='the
|
9
|
+
message='the Ingenico ePayments platform returned an authorization error response')
|
10
10
|
super(status_code, response_body, error_id, errors, message)
|
11
11
|
end
|
12
12
|
end
|
@@ -19,7 +19,7 @@ module Ingenico::Connect::SDK
|
|
19
19
|
# and only the first request will be processed.
|
20
20
|
attr_reader :idempotence_key
|
21
21
|
|
22
|
-
# If two or more requests arrive at the
|
22
|
+
# If two or more requests arrive at the Ingenico ePayments platform with the same _idempotence_key_,
|
23
23
|
# the _idempotence_request_timestamp_ will be set to the arrival time of the first of these requests.
|
24
24
|
attr_accessor :idempotence_request_timestamp
|
25
25
|
end
|
@@ -1,6 +1,6 @@
|
|
1
1
|
module Ingenico::Connect::SDK
|
2
2
|
|
3
|
-
# This exception is used when an error occurs during network communication with the
|
3
|
+
# This exception is used when an error occurs during network communication with the Ingenico ePayments platform.
|
4
4
|
# A common cause is a timeout while connecting or when receiving or sending data.
|
5
5
|
class CommunicationException < RuntimeError
|
6
6
|
|
@@ -2,7 +2,7 @@ require 'uri'
|
|
2
2
|
|
3
3
|
module Ingenico::Connect::SDK
|
4
4
|
|
5
|
-
# Class responsible for facilitating communication with the
|
5
|
+
# Class responsible for facilitating communication with the Ingenico ePayments platform.
|
6
6
|
# It combines the following classes to provide communication functionality:
|
7
7
|
#
|
8
8
|
# session:: {Ingenico::Connect::SDK::Session} that stores data for network communication and facilitates network communication
|
@@ -27,13 +27,13 @@ module Ingenico::Connect::SDK
|
|
27
27
|
@marshaller = marshaller
|
28
28
|
end
|
29
29
|
|
30
|
-
# Performs a GET request to the
|
30
|
+
# Performs a GET request to the Ingenico ePayments platform and returns the response as a {Ingenico::Connect::SDK::Response} object.
|
31
31
|
#
|
32
32
|
# Throws:
|
33
33
|
# ResponseException:: Thrown if the request could not be fulfilled successfully.
|
34
34
|
# This occurs for example if the request is not authenticated correctly
|
35
35
|
# NotFoundException:: Thrown if the requested resource is not found
|
36
|
-
# CommunicationException:: Thrown if there is an error in communicating with the
|
36
|
+
# CommunicationException:: Thrown if there is an error in communicating with the Ingenico ePayments platform.
|
37
37
|
# This occurs for example if a timeout occurs.
|
38
38
|
def get(relative_path, request_headers, request_parameters, response_type, context)
|
39
39
|
connection = @session.connection
|
@@ -51,13 +51,13 @@ module Ingenico::Connect::SDK
|
|
51
51
|
process_response(response, response_type, relative_path, context)
|
52
52
|
end
|
53
53
|
|
54
|
-
# Performs a DELETE request to the
|
54
|
+
# Performs a DELETE request to the Ingenico ePayments platform and returns the response as a {Ingenico::Connect::SDK::Response} object.
|
55
55
|
#
|
56
56
|
# Throws:
|
57
57
|
# ResponseException:: Thrown if the request could not be fulfilled successfully.
|
58
58
|
# This occurs for example if the request is not authenticated correctly.
|
59
59
|
# NotFoundException:: Thrown if the referred resource is not found.
|
60
|
-
# CommunicationException:: Thrown if there is an error in communicating with the
|
60
|
+
# CommunicationException:: Thrown if there is an error in communicating with the Ingenico ePayments platform.
|
61
61
|
# This occurs for example if a timeout occurs.
|
62
62
|
def delete(relative_path, request_headers, request_parameters, response_type, context)
|
63
63
|
connection = @session.connection
|
@@ -75,13 +75,13 @@ module Ingenico::Connect::SDK
|
|
75
75
|
process_response(response, response_type, relative_path, context)
|
76
76
|
end
|
77
77
|
|
78
|
-
# Performs a POST request to the
|
78
|
+
# Performs a POST request to the Ingenico ePayments platform and returns the response as a {Ingenico::Connect::SDK::Response} object.
|
79
79
|
#
|
80
80
|
# Throws:
|
81
81
|
# ResponseException:: Thrown if the request could not be fulfilled successfully.
|
82
82
|
# This occurs for example if the request is not authenticated correctly.
|
83
83
|
# NotFoundException:: Thrown if the referred resource is not found.
|
84
|
-
# CommunicationException:: Thrown if there is an error in communicating with the
|
84
|
+
# CommunicationException:: Thrown if there is an error in communicating with the Ingenico ePayments platform.
|
85
85
|
# This occurs for example if a timeout occurs.
|
86
86
|
def post(relative_path, request_headers, request_parameters, request_body,
|
87
87
|
response_type, context)
|
@@ -105,13 +105,13 @@ module Ingenico::Connect::SDK
|
|
105
105
|
process_response(response, response_type, relative_path, context)
|
106
106
|
end
|
107
107
|
|
108
|
-
# Performs a PUT request to the
|
108
|
+
# Performs a PUT request to the Ingenico ePayments platform and returns the response as a {Ingenico::Connect::SDK::Response} object.
|
109
109
|
#
|
110
110
|
# Throws:
|
111
111
|
# ResponseException:: Thrown if the request could not be fulfilled successfully.
|
112
112
|
# This occurs for example if the request is not authenticated correctly.
|
113
113
|
# NotFoundException:: Thrown if the referred resource is not found.
|
114
|
-
# CommunicationException:: Thrown if there is an error in communicating with the
|
114
|
+
# CommunicationException:: Thrown if there is an error in communicating with the Ingenico ePayments platform.
|
115
115
|
# This occurs for example if a timeout occurs.
|
116
116
|
def put(relative_path, request_headers, request_parameters, request_body,
|
117
117
|
response_type, context)
|
@@ -209,7 +209,7 @@ module Ingenico::Connect::SDK
|
|
209
209
|
# Adds several standard headers to the http headers.
|
210
210
|
#
|
211
211
|
# http_method:: 'GET', 'DELETE', 'POST' or 'PUT' depending on the HTTP method being used
|
212
|
-
# uri:: The full URI as a URI object to the
|
212
|
+
# uri:: The full URI as a URI object to the Ingenico ePayments platform,
|
213
213
|
# including the relative path and request parameters.
|
214
214
|
# request_headers:: List of {Ingenico::Connect::SDK::RequestHeader} in which which new headers will be added
|
215
215
|
# context:: {Ingenico::Connect::SDK::CallContext} object that will be used to produce
|
@@ -2,14 +2,14 @@ module Ingenico::Connect::SDK
|
|
2
2
|
|
3
3
|
# A CommunicatorConfiguration stores all data used to initialize an {Ingenico::Connect::SDK::Communicator}. It stores the following:
|
4
4
|
#
|
5
|
-
# api_endpoint:: The base url to the
|
5
|
+
# api_endpoint:: The base url to the Ingenico ePayments platform.
|
6
6
|
# api_key_id:: The identifier of the _secret_api_key_ used to authenticate requests.
|
7
|
-
# secret_api_key:: The key used to authenticate requests sent to the
|
7
|
+
# secret_api_key:: The key used to authenticate requests sent to the Ingenico ePayments platform.
|
8
8
|
# authorization_type:: String describing the authorization protocol to follow.
|
9
|
-
# connect_timeout:: The number of seconds before a connection attempt with the
|
9
|
+
# connect_timeout:: The number of seconds before a connection attempt with the Ingenico ePayments platform times out.
|
10
10
|
# socket_timeout:: The number of seconds before a timeout occurs
|
11
|
-
# when transmitting data to or from the
|
12
|
-
# max_connections:: The number of connections with the
|
11
|
+
# when transmitting data to or from the Ingenico ePayments platform.
|
12
|
+
# max_connections:: The number of connections with the Ingenico ePayments platform
|
13
13
|
# that are kept alive in the connection pool. These connections will be reused when possible.
|
14
14
|
# proxy_configuration:: {Ingenico::Connect::SDK::ProxyConfiguration} instance that stores the url to a proxy to be used in all communication,
|
15
15
|
# or nil if no proxy should be used.
|
@@ -22,14 +22,14 @@ module Ingenico::Connect::SDK
|
|
22
22
|
# properties:: A hash that may contain any of the other parameters.
|
23
23
|
# If a parameter is given in both the _properties_ and separately,
|
24
24
|
# the separate value takes precedence.
|
25
|
-
# api_endpoint:: The base url to the
|
25
|
+
# api_endpoint:: The base url to the Ingenico ePayments platform.
|
26
26
|
# api_key_id:: The identifier of the _secret_api_key_ used to authenticate requests.
|
27
|
-
# secret_api_key:: The key used to authenticate requests sent to the
|
27
|
+
# secret_api_key:: The key used to authenticate requests sent to the Ingenico ePayments platform.
|
28
28
|
# authorization_type:: String describing the authorization protocol to follow.
|
29
|
-
# connect_timeout:: The number of seconds before a connection attempt with the
|
29
|
+
# connect_timeout:: The number of seconds before a connection attempt with the Ingenico ePayments platform times out.
|
30
30
|
# socket_timeout:: The number of seconds before a timeout occurs
|
31
|
-
# when transmitting data to or from the
|
32
|
-
# max_connections:: The number of connections with the
|
31
|
+
# when transmitting data to or from the Ingenico ePayments platform.
|
32
|
+
# max_connections:: The number of connections with the Ingenico ePayments platform
|
33
33
|
# that are kept alive in the connection pool. These connections will be reused when possible.
|
34
34
|
# proxy_configuration:: {Ingenico::Connect::SDK::ProxyConfiguration} instance that stores the url to a proxy to be used in all communication,
|
35
35
|
# or nil if no proxy should be used.
|
@@ -83,7 +83,7 @@ module Ingenico::Connect::SDK
|
|
83
83
|
end
|
84
84
|
end
|
85
85
|
|
86
|
-
# Base URL to the
|
86
|
+
# Base URL to the Ingenico ePayments platform
|
87
87
|
attr_accessor :api_endpoint
|
88
88
|
|
89
89
|
# Identifier of the _secret_api_key_ used in authentication.
|
@@ -1,6 +1,6 @@
|
|
1
1
|
module Ingenico::Connect::SDK
|
2
2
|
|
3
|
-
# Indicates that a payment is declined by the
|
3
|
+
# Indicates that a payment is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
|
4
4
|
class DeclinedPaymentException < DeclinedTransactionException
|
5
5
|
|
6
6
|
# Create a new DeclinedPaymentException.
|
@@ -15,7 +15,7 @@ module Ingenico::Connect::SDK
|
|
15
15
|
@errors = errors
|
16
16
|
end
|
17
17
|
|
18
|
-
# The declined payment result returned by the
|
18
|
+
# The declined payment result returned by the Ingenico ePayments platform.
|
19
19
|
# Given as a {Ingenico::Connect::SDK::Domain::Payment::CreatePaymentResult} object.
|
20
20
|
def payment_result
|
21
21
|
if @errors.nil?
|
@@ -34,7 +34,7 @@ module Ingenico::Connect::SDK
|
|
34
34
|
payment = nil
|
35
35
|
end
|
36
36
|
if payment.nil?
|
37
|
-
'the
|
37
|
+
'the Ingenico ePayments platform returned a declined payment response'
|
38
38
|
else
|
39
39
|
"declined payment '" + payment.id + "' with status '" +
|
40
40
|
payment.status + "'"
|
@@ -1,6 +1,6 @@
|
|
1
1
|
module Ingenico::Connect::SDK
|
2
2
|
|
3
|
-
# Indicates that a payout is declined by the
|
3
|
+
# Indicates that a payout is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
|
4
4
|
class DeclinedPayoutException < DeclinedTransactionException
|
5
5
|
|
6
6
|
# Create a new DeclinedPayoutException.
|
@@ -15,7 +15,7 @@ module Ingenico::Connect::SDK
|
|
15
15
|
@errors = errors
|
16
16
|
end
|
17
17
|
|
18
|
-
# The declined payout result as returned by the
|
18
|
+
# The declined payout result as returned by the Ingenico ePayments platform.
|
19
19
|
# Given as a {Ingenico::Connect::SDK::Domain::Payout::PayoutResult} object.
|
20
20
|
def payout_result
|
21
21
|
if @errors.nil?
|
@@ -34,7 +34,7 @@ module Ingenico::Connect::SDK
|
|
34
34
|
payout = nil
|
35
35
|
end
|
36
36
|
if payout.nil?
|
37
|
-
'the
|
37
|
+
'the Ingenico ePayments platform returned a declined payout response'
|
38
38
|
else
|
39
39
|
"declined payment '" + payout.id + "' with status '" +
|
40
40
|
payout.status + "'"
|
@@ -2,7 +2,7 @@ require 'ingenico/connect/sdk/declined_transaction_exception'
|
|
2
2
|
|
3
3
|
module Ingenico::Connect::SDK
|
4
4
|
|
5
|
-
# Indicates that a refund is declined by the
|
5
|
+
# Indicates that a refund is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
|
6
6
|
class DeclinedRefundException < DeclinedTransactionException
|
7
7
|
|
8
8
|
# Create a new DeclinedRefundException
|
@@ -17,7 +17,7 @@ module Ingenico::Connect::SDK
|
|
17
17
|
@errors = errors
|
18
18
|
end
|
19
19
|
|
20
|
-
# The declined refund result as returned by the
|
20
|
+
# The declined refund result as returned by the Ingenico ePayments platform.
|
21
21
|
# Given as a {Ingenico::Connect::SDK::Domain::Refund::RefundResult} object.
|
22
22
|
def refund_result
|
23
23
|
if @errors.nil?
|
@@ -36,7 +36,7 @@ module Ingenico::Connect::SDK
|
|
36
36
|
refund = nil
|
37
37
|
end
|
38
38
|
if refund.nil?
|
39
|
-
'the
|
39
|
+
'the Ingenico ePayments platform returned a declined refund response'
|
40
40
|
else
|
41
41
|
"declined refund '" + refund.id + "' with status '" +
|
42
42
|
refund.status + "'"
|
@@ -1,6 +1,6 @@
|
|
1
1
|
module Ingenico::Connect::SDK
|
2
2
|
|
3
|
-
# Indicates that a transaction is declined by the
|
3
|
+
# Indicates that a transaction is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
|
4
4
|
class DeclinedTransactionException < ApiException
|
5
5
|
|
6
6
|
# Create a new DeclinedTransactionException.
|
@@ -4,7 +4,7 @@ require 'base64'
|
|
4
4
|
module Ingenico::Connect::SDK
|
5
5
|
module DefaultImpl
|
6
6
|
|
7
|
-
# Authenticates requests made to the
|
7
|
+
# Authenticates requests made to the Ingenico ePayments platform using the HMAC algorithm.
|
8
8
|
class DefaultAuthenticator < Authenticator
|
9
9
|
|
10
10
|
# HMAC algorithm used to generate the signature
|