first_data_gateway 1.0.1 → 1.0.3
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 +3 -3
- data/docs/AuthenticationApi.md +6 -5
- data/docs/OrderApi.md +8 -10
- data/docs/PaymentApi.md +22 -25
- data/lib/simple_client.rb +4 -4
- data/lib/swagger_client/version.rb +1 -1
- data/spec/api/authentication_api_spec.rb +1 -1
- data/spec/api/order_api_spec.rb +2 -2
- data/spec/api/payment_api_spec.rb +5 -5
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 123395bbe5782cd21f1dc1384239ecaf237c6f43
|
4
|
+
data.tar.gz: fb354ad083e3703bda78c25dd4f2be73745c53cc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ff8d2af175bab9311677c7213d543e1617ee112824494b54c9a5db342029d4070711d22a1ed174eb77492911c9af532d7d6dba60830b53388ec563aeefca1ea0
|
7
|
+
data.tar.gz: 2d096dc955280fbef4654693a3d8d3501cc2fc06334d7dd18d92d844c58d28c937fb92f2fdcb3c650c79790f7a3bf1fa74d57323f83e7f88f23b2873dd64eec3
|
data/README.md
CHANGED
@@ -11,7 +11,7 @@ gem install first_api_client
|
|
11
11
|
|
12
12
|
Then add the gem to your Gemfile:
|
13
13
|
|
14
|
-
gem 'first_api_client', '~> 1.0.
|
14
|
+
gem 'first_api_client', '~> 1.0.3'
|
15
15
|
|
16
16
|
### Install from Git
|
17
17
|
|
@@ -56,7 +56,7 @@ p JSON.generate(result.to_hash)
|
|
56
56
|
|
57
57
|
## Documentation for API Endpoints
|
58
58
|
|
59
|
-
All URIs are relative to *https://
|
59
|
+
All URIs are relative to *https://prod.api.firstdata.com/gateway*
|
60
60
|
|
61
61
|
Class | Method | HTTP request | Description
|
62
62
|
------------ | ------------- | ------------- | -------------
|
@@ -120,4 +120,4 @@ Class | Method | HTTP request | Description
|
|
120
120
|
- [SwaggerClient::TransactionResponseAuthenticationRedirect](docs/TransactionResponseAuthenticationRedirect.md)
|
121
121
|
- [SwaggerClient::TransactionResponseAuthenticationRedirectParams](docs/TransactionResponseAuthenticationRedirectParams.md)
|
122
122
|
- [SwaggerClient::TransactionType](docs/TransactionType.md)
|
123
|
-
- [SwaggerClient::TransactionErrorResponse](docs/TransactionErrorResponse.md)
|
123
|
+
- [SwaggerClient::TransactionErrorResponse](docs/TransactionErrorResponse.md)
|
data/docs/AuthenticationApi.md
CHANGED
@@ -8,7 +8,7 @@ Method | HTTP request | Description
|
|
8
8
|
|
9
9
|
|
10
10
|
# **v1_authentication_access_tokens_post**
|
11
|
-
> AccessTokenResponse v1_authentication_access_tokens_post(content_type, client_request_id, api_key, timestamp,
|
11
|
+
> AccessTokenResponse v1_authentication_access_tokens_post(content_type, client_request_id, api_key, timestamp, , opts)
|
12
12
|
|
13
13
|
Generate an access token for user authentication
|
14
14
|
|
@@ -29,12 +29,13 @@ api_key = "api_key_example" # String |
|
|
29
29
|
|
30
30
|
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
31
31
|
|
32
|
-
|
33
|
-
|
32
|
+
opts = {
|
33
|
+
message_signature: "message_signature_example", # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
34
|
+
}
|
34
35
|
|
35
36
|
begin
|
36
37
|
#Generate an access token for user authentication
|
37
|
-
result = api_instance.v1_authentication_access_tokens_post(content_type, client_request_id, api_key, timestamp,
|
38
|
+
result = api_instance.v1_authentication_access_tokens_post(content_type, client_request_id, api_key, timestamp, , opts)
|
38
39
|
p result
|
39
40
|
rescue SwaggerClient::ApiError => e
|
40
41
|
puts "Exception when calling AuthenticationApi->v1_authentication_access_tokens_post: #{e}"
|
@@ -49,7 +50,7 @@ Name | Type | Description | Notes
|
|
49
50
|
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
50
51
|
**api_key** | **String**| |
|
51
52
|
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
52
|
-
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
53
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
|
53
54
|
|
54
55
|
### Return type
|
55
56
|
|
data/docs/OrderApi.md
CHANGED
@@ -9,7 +9,7 @@ Method | HTTP request | Description
|
|
9
9
|
|
10
10
|
|
11
11
|
# **perform_payment_post_authorisation**
|
12
|
-
> TransactionResponse perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp,
|
12
|
+
> TransactionResponse perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, order_id, payload, opts)
|
13
13
|
|
14
14
|
Use this to capture/complete a transaction. Partial postauths are allowed.
|
15
15
|
|
@@ -30,19 +30,18 @@ api_key = "api_key_example" # String |
|
|
30
30
|
|
31
31
|
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
32
32
|
|
33
|
-
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
34
|
-
|
35
33
|
order_id = "order_id_example" # String | Gateway order identifier as returned in the parameter orderId
|
36
34
|
|
37
35
|
payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
|
38
36
|
|
39
37
|
opts = {
|
38
|
+
message_signature: "message_signature_example", # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
40
39
|
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
41
40
|
}
|
42
41
|
|
43
42
|
begin
|
44
43
|
#Use this to capture/complete a transaction. Partial postauths are allowed.
|
45
|
-
result = api_instance.perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp,
|
44
|
+
result = api_instance.perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, order_id, payload, opts)
|
46
45
|
p result
|
47
46
|
rescue SwaggerClient::ApiError => e
|
48
47
|
puts "Exception when calling OrderApi->perform_payment_post_authorisation: #{e}"
|
@@ -57,9 +56,9 @@ Name | Type | Description | Notes
|
|
57
56
|
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
58
57
|
**api_key** | **String**| |
|
59
58
|
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
60
|
-
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
61
59
|
**order_id** | **String**| Gateway order identifier as returned in the parameter orderId |
|
62
60
|
**payload** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
|
61
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
|
63
62
|
**store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
|
64
63
|
|
65
64
|
### Return type
|
@@ -78,7 +77,7 @@ No authorization required
|
|
78
77
|
|
79
78
|
|
80
79
|
# **return_transaction**
|
81
|
-
> TransactionResponse return_transaction(content_type, client_request_id, api_key, timestamp,
|
80
|
+
> TransactionResponse return_transaction(content_type, client_request_id, api_key, timestamp, order_id, payload, opts)
|
82
81
|
|
83
82
|
Use this to return/refund on the order. Partial returns are allowed.
|
84
83
|
|
@@ -99,19 +98,18 @@ api_key = "api_key_example" # String |
|
|
99
98
|
|
100
99
|
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
101
100
|
|
102
|
-
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
103
|
-
|
104
101
|
order_id = "order_id_example" # String | Gateway order identifier as returned in the parameter orderId
|
105
102
|
|
106
103
|
payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
|
107
104
|
|
108
105
|
opts = {
|
106
|
+
message_signature: "message_signature_example", # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
109
107
|
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
110
108
|
}
|
111
109
|
|
112
110
|
begin
|
113
111
|
#Use this to return/refund on the order. Partial returns are allowed.
|
114
|
-
result = api_instance.return_transaction(content_type, client_request_id, api_key, timestamp,
|
112
|
+
result = api_instance.return_transaction(content_type, client_request_id, api_key, timestamp, order_id, payload, opts)
|
115
113
|
p result
|
116
114
|
rescue SwaggerClient::ApiError => e
|
117
115
|
puts "Exception when calling OrderApi->return_transaction: #{e}"
|
@@ -126,9 +124,9 @@ Name | Type | Description | Notes
|
|
126
124
|
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
127
125
|
**api_key** | **String**| |
|
128
126
|
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
129
|
-
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
130
127
|
**order_id** | **String**| Gateway order identifier as returned in the parameter orderId |
|
131
128
|
**payload** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
|
129
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
|
132
130
|
**store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
|
133
131
|
|
134
132
|
### Return type
|
data/docs/PaymentApi.md
CHANGED
@@ -12,7 +12,7 @@ Method | HTTP request | Description
|
|
12
12
|
|
13
13
|
|
14
14
|
# **perform_payment_post_authorisation**
|
15
|
-
> TransactionResponse perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp,
|
15
|
+
> TransactionResponse perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, transaction_id, payload, opts)
|
16
16
|
|
17
17
|
Use this to capture/complete a transaction. Partial postauths are allowed.
|
18
18
|
|
@@ -33,19 +33,18 @@ api_key = "api_key_example" # String |
|
|
33
33
|
|
34
34
|
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
35
35
|
|
36
|
-
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
37
|
-
|
38
36
|
transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
|
39
37
|
|
40
38
|
payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
|
41
39
|
|
42
40
|
opts = {
|
41
|
+
message_signature: "message_signature_example", # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
43
42
|
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
44
43
|
}
|
45
44
|
|
46
45
|
begin
|
47
46
|
#Use this to capture/complete a transaction. Partial postauths are allowed.
|
48
|
-
result = api_instance.perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp,
|
47
|
+
result = api_instance.perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, transaction_id, payload, opts)
|
49
48
|
p result
|
50
49
|
rescue SwaggerClient::ApiError => e
|
51
50
|
puts "Exception when calling PaymentApi->perform_payment_post_authorisation: #{e}"
|
@@ -60,9 +59,9 @@ Name | Type | Description | Notes
|
|
60
59
|
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
61
60
|
**api_key** | **String**| |
|
62
61
|
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
63
|
-
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
64
62
|
**transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId |
|
65
63
|
**payload** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
|
64
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
|
66
65
|
**store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
|
67
66
|
|
68
67
|
### Return type
|
@@ -81,7 +80,7 @@ No authorization required
|
|
81
80
|
|
82
81
|
|
83
82
|
# **primary_payment_transaction**
|
84
|
-
> TransactionResponse primary_payment_transaction(content_type, client_request_id, api_key, timestamp,
|
83
|
+
> TransactionResponse primary_payment_transaction(content_type, client_request_id, api_key, timestamp, payload, opts)
|
85
84
|
|
86
85
|
Generate a primary transaction
|
87
86
|
|
@@ -102,14 +101,15 @@ api_key = "api_key_example" # String |
|
|
102
101
|
|
103
102
|
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
104
103
|
|
105
|
-
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
106
|
-
|
107
104
|
payload = SwaggerClient::PrimaryTransaction.new # PrimaryTransaction | Primary Transaction request
|
108
105
|
|
106
|
+
opts = {
|
107
|
+
message_signature: "message_signature_example", # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
108
|
+
}
|
109
109
|
|
110
110
|
begin
|
111
111
|
#Generate a primary transaction
|
112
|
-
result = api_instance.primary_payment_transaction(content_type, client_request_id, api_key, timestamp,
|
112
|
+
result = api_instance.primary_payment_transaction(content_type, client_request_id, api_key, timestamp, payload, opts)
|
113
113
|
p result
|
114
114
|
rescue SwaggerClient::ApiError => e
|
115
115
|
puts "Exception when calling PaymentApi->primary_payment_transaction: #{e}"
|
@@ -124,8 +124,8 @@ Name | Type | Description | Notes
|
|
124
124
|
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
125
125
|
**api_key** | **String**| |
|
126
126
|
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
127
|
-
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
128
127
|
**payload** | [**PrimaryTransaction**](PrimaryTransaction.md)| Primary Transaction request |
|
128
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
|
129
129
|
|
130
130
|
### Return type
|
131
131
|
|
@@ -143,7 +143,7 @@ No authorization required
|
|
143
143
|
|
144
144
|
|
145
145
|
# **return_transaction**
|
146
|
-
> TransactionResponse return_transaction(content_type, client_request_id, api_key, timestamp,
|
146
|
+
> TransactionResponse return_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, payload, opts)
|
147
147
|
|
148
148
|
Return/refund a transaction.
|
149
149
|
|
@@ -164,19 +164,18 @@ api_key = "api_key_example" # String |
|
|
164
164
|
|
165
165
|
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
166
166
|
|
167
|
-
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
168
|
-
|
169
167
|
transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
|
170
168
|
|
171
169
|
payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
|
172
170
|
|
173
171
|
opts = {
|
172
|
+
message_signature: "message_signature_example", # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
174
173
|
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
175
174
|
}
|
176
175
|
|
177
176
|
begin
|
178
177
|
#Return/refund a transaction.
|
179
|
-
result = api_instance.return_transaction(content_type, client_request_id, api_key, timestamp,
|
178
|
+
result = api_instance.return_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, payload, opts)
|
180
179
|
p result
|
181
180
|
rescue SwaggerClient::ApiError => e
|
182
181
|
puts "Exception when calling PaymentApi->return_transaction: #{e}"
|
@@ -191,9 +190,9 @@ Name | Type | Description | Notes
|
|
191
190
|
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
192
191
|
**api_key** | **String**| |
|
193
192
|
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
194
|
-
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
195
193
|
**transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId |
|
196
194
|
**payload** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
|
195
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
|
197
196
|
**store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
|
198
197
|
|
199
198
|
### Return type
|
@@ -212,7 +211,7 @@ No authorization required
|
|
212
211
|
|
213
212
|
|
214
213
|
# **transaction_inquiry**
|
215
|
-
> TransactionResponse transaction_inquiry(content_type, client_request_id, api_key, timestamp,
|
214
|
+
> TransactionResponse transaction_inquiry(content_type, client_request_id, api_key, timestamp, transaction_id, , opts)
|
216
215
|
|
217
216
|
Retrieve the state of a transaction
|
218
217
|
|
@@ -233,17 +232,16 @@ api_key = "api_key_example" # String |
|
|
233
232
|
|
234
233
|
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
235
234
|
|
236
|
-
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
237
|
-
|
238
235
|
transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
|
239
236
|
|
240
237
|
opts = {
|
238
|
+
message_signature: "message_signature_example", # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
241
239
|
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
242
240
|
}
|
243
241
|
|
244
242
|
begin
|
245
243
|
#Retrieve the state of a transaction
|
246
|
-
result = api_instance.transaction_inquiry(content_type, client_request_id, api_key, timestamp,
|
244
|
+
result = api_instance.transaction_inquiry(content_type, client_request_id, api_key, timestamp, transaction_id, , opts)
|
247
245
|
p result
|
248
246
|
rescue SwaggerClient::ApiError => e
|
249
247
|
puts "Exception when calling PaymentApi->transaction_inquiry: #{e}"
|
@@ -258,8 +256,8 @@ Name | Type | Description | Notes
|
|
258
256
|
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
259
257
|
**api_key** | **String**| |
|
260
258
|
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
261
|
-
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
262
259
|
**transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId |
|
260
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
|
263
261
|
**store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
|
264
262
|
|
265
263
|
### Return type
|
@@ -278,7 +276,7 @@ No authorization required
|
|
278
276
|
|
279
277
|
|
280
278
|
# **void_transaction**
|
281
|
-
> TransactionResponse void_transaction(content_type, client_request_id, api_key, timestamp,
|
279
|
+
> TransactionResponse void_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, , opts)
|
282
280
|
|
283
281
|
Reverse a previous action on an existing transaction
|
284
282
|
|
@@ -299,17 +297,16 @@ api_key = "api_key_example" # String |
|
|
299
297
|
|
300
298
|
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
301
299
|
|
302
|
-
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
303
|
-
|
304
300
|
transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
|
305
301
|
|
306
302
|
opts = {
|
303
|
+
message_signature: "message_signature_example", # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
307
304
|
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
308
305
|
}
|
309
306
|
|
310
307
|
begin
|
311
308
|
#Reverse a previous action on an existing transaction
|
312
|
-
result = api_instance.void_transaction(content_type, client_request_id, api_key, timestamp,
|
309
|
+
result = api_instance.void_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, , opts)
|
313
310
|
p result
|
314
311
|
rescue SwaggerClient::ApiError => e
|
315
312
|
puts "Exception when calling PaymentApi->void_transaction: #{e}"
|
@@ -324,8 +321,8 @@ Name | Type | Description | Notes
|
|
324
321
|
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
325
322
|
**api_key** | **String**| |
|
326
323
|
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
327
|
-
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
328
324
|
**transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId |
|
325
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
|
329
326
|
**store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
|
330
327
|
|
331
328
|
### Return type
|
data/lib/simple_client.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
1
|
+
require 'simple/gateway'
|
2
|
+
require 'simple/client_context'
|
3
|
+
require 'simple/merchant_credentials'
|
4
|
+
require 'simple/signature'
|
@@ -39,8 +39,8 @@ describe 'AuthenticationApi' do
|
|
39
39
|
# @param client_request_id A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
40
40
|
# @param api_key
|
41
41
|
# @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
42
|
-
# @param message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
43
42
|
# @param [Hash] opts the optional parameters
|
43
|
+
# @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
44
44
|
# @return [AccessTokenResponse]
|
45
45
|
describe 'v1_authentication_access_tokens_post test' do
|
46
46
|
it "should work" do
|
data/spec/api/order_api_spec.rb
CHANGED
@@ -39,10 +39,10 @@ describe 'OrderApi' do
|
|
39
39
|
# @param client_request_id A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
40
40
|
# @param api_key
|
41
41
|
# @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
42
|
-
# @param message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
43
42
|
# @param order_id Gateway order identifier as returned in the parameter orderId
|
44
43
|
# @param payload
|
45
44
|
# @param [Hash] opts the optional parameters
|
45
|
+
# @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
46
46
|
# @option opts [String] :store_id an optional outlet id for clients that support multiple store in the same developer app
|
47
47
|
# @return [TransactionResponse]
|
48
48
|
describe 'perform_payment_post_authorisation test' do
|
@@ -58,10 +58,10 @@ describe 'OrderApi' do
|
|
58
58
|
# @param client_request_id A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
59
59
|
# @param api_key
|
60
60
|
# @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
61
|
-
# @param message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
62
61
|
# @param order_id Gateway order identifier as returned in the parameter orderId
|
63
62
|
# @param payload
|
64
63
|
# @param [Hash] opts the optional parameters
|
64
|
+
# @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
65
65
|
# @option opts [String] :store_id an optional outlet id for clients that support multiple store in the same developer app
|
66
66
|
# @return [TransactionResponse]
|
67
67
|
describe 'return_transaction test' do
|
@@ -39,10 +39,10 @@ describe 'PaymentApi' do
|
|
39
39
|
# @param client_request_id A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
40
40
|
# @param api_key
|
41
41
|
# @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
42
|
-
# @param message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
43
42
|
# @param transaction_id Gateway transaction identifier as returned in the parameter ipgTransactionId
|
44
43
|
# @param payload
|
45
44
|
# @param [Hash] opts the optional parameters
|
45
|
+
# @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
46
46
|
# @option opts [String] :store_id an optional outlet id for clients that support multiple store in the same developer app
|
47
47
|
# @return [TransactionResponse]
|
48
48
|
describe 'perform_payment_post_authorisation test' do
|
@@ -58,9 +58,9 @@ describe 'PaymentApi' do
|
|
58
58
|
# @param client_request_id A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
59
59
|
# @param api_key
|
60
60
|
# @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
61
|
-
# @param message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
62
61
|
# @param payload Primary Transaction request
|
63
62
|
# @param [Hash] opts the optional parameters
|
63
|
+
# @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
64
64
|
# @return [TransactionResponse]
|
65
65
|
describe 'primary_payment_transaction test' do
|
66
66
|
it "should work" do
|
@@ -75,10 +75,10 @@ describe 'PaymentApi' do
|
|
75
75
|
# @param client_request_id A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
76
76
|
# @param api_key
|
77
77
|
# @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
78
|
-
# @param message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
79
78
|
# @param transaction_id Gateway transaction identifier as returned in the parameter ipgTransactionId
|
80
79
|
# @param payload
|
81
80
|
# @param [Hash] opts the optional parameters
|
81
|
+
# @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
82
82
|
# @option opts [String] :store_id an optional outlet id for clients that support multiple store in the same developer app
|
83
83
|
# @return [TransactionResponse]
|
84
84
|
describe 'return_transaction test' do
|
@@ -94,9 +94,9 @@ describe 'PaymentApi' do
|
|
94
94
|
# @param client_request_id A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
95
95
|
# @param api_key
|
96
96
|
# @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
97
|
-
# @param message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
98
97
|
# @param transaction_id Gateway transaction identifier as returned in the parameter ipgTransactionId
|
99
98
|
# @param [Hash] opts the optional parameters
|
99
|
+
# @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
100
100
|
# @option opts [String] :store_id an optional outlet id for clients that support multiple store in the same developer app
|
101
101
|
# @return [TransactionResponse]
|
102
102
|
describe 'transaction_inquiry test' do
|
@@ -112,9 +112,9 @@ describe 'PaymentApi' do
|
|
112
112
|
# @param client_request_id A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
113
113
|
# @param api_key
|
114
114
|
# @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
115
|
-
# @param message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
116
115
|
# @param transaction_id Gateway transaction identifier as returned in the parameter ipgTransactionId
|
117
116
|
# @param [Hash] opts the optional parameters
|
117
|
+
# @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
118
118
|
# @option opts [String] :store_id an optional outlet id for clients that support multiple store in the same developer app
|
119
119
|
# @return [TransactionResponse]
|
120
120
|
describe 'void_transaction test' do
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: first_data_gateway
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Eric Margules
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-11-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|