first_data_gateway 1.0.1

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.
Files changed (176) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +123 -0
  4. data/Rakefile +8 -0
  5. data/docs/AccessTokenResponse.md +11 -0
  6. data/docs/Address.md +14 -0
  7. data/docs/Airline.md +21 -0
  8. data/docs/AirlineAncillaryServiceCategory.md +8 -0
  9. data/docs/AirlineTravelRoute.md +16 -0
  10. data/docs/Amount.md +10 -0
  11. data/docs/AmountComponents.md +14 -0
  12. data/docs/AuthenticationApi.md +68 -0
  13. data/docs/AuthenticationResponseVerification.md +10 -0
  14. data/docs/BasketItem.md +11 -0
  15. data/docs/Billing.md +13 -0
  16. data/docs/CarRental.md +15 -0
  17. data/docs/CarRentalExtraCharges.md +8 -0
  18. data/docs/CardVerificationsTransaction.md +9 -0
  19. data/docs/ClientLocale.md +9 -0
  20. data/docs/Contact.md +11 -0
  21. data/docs/Error.md +10 -0
  22. data/docs/ErrorDetails.md +9 -0
  23. data/docs/ErrorResponse.md +11 -0
  24. data/docs/Expiration.md +9 -0
  25. data/docs/Frequency.md +9 -0
  26. data/docs/IndustrySpecificExtensions.md +10 -0
  27. data/docs/InstallmentOptions.md +10 -0
  28. data/docs/Lodging.md +12 -0
  29. data/docs/LodgingExtraCharges.md +8 -0
  30. data/docs/Order.md +10 -0
  31. data/docs/OrderApi.md +148 -0
  32. data/docs/PayPal.md +8 -0
  33. data/docs/PaymentApi.md +345 -0
  34. data/docs/PaymentCard.md +15 -0
  35. data/docs/PaymentCardAuthenticationRequest.md +8 -0
  36. data/docs/PaymentCardAuthenticationResult.md +12 -0
  37. data/docs/PaymentMethod.md +11 -0
  38. data/docs/PaymentSchedulesRequest.md +21 -0
  39. data/docs/PaymentSchedulesResponse.md +11 -0
  40. data/docs/PaymentUrlRequest.md +11 -0
  41. data/docs/PaymentUrlResponse.md +13 -0
  42. data/docs/PrimaryTransaction.md +18 -0
  43. data/docs/PrimaryTransactionAdditionalDetails.md +14 -0
  44. data/docs/ProcessorData.md +10 -0
  45. data/docs/ResponseType.md +7 -0
  46. data/docs/SecondaryTransaction.md +9 -0
  47. data/docs/Sepa.md +12 -0
  48. data/docs/SepaMandate.md +11 -0
  49. data/docs/Shipping.md +10 -0
  50. data/docs/SplitShipment.md +9 -0
  51. data/docs/StoredCredential.md +11 -0
  52. data/docs/TransactionErrorResponse.md +28 -0
  53. data/docs/TransactionResponse.md +27 -0
  54. data/docs/TransactionResponseAuthenticationRedirect.md +10 -0
  55. data/docs/TransactionResponseAuthenticationRedirectParams.md +10 -0
  56. data/docs/TransactionType.md +7 -0
  57. data/first_data_gateway.gemspec +45 -0
  58. data/git_push.sh +55 -0
  59. data/lib/simple/client_context.rb +15 -0
  60. data/lib/simple/gateway.rb +155 -0
  61. data/lib/simple/merchant_credentials.rb +10 -0
  62. data/lib/simple/signature.rb +52 -0
  63. data/lib/simple_client.rb +4 -0
  64. data/lib/swagger_client.rb +91 -0
  65. data/lib/swagger_client/api/authentication_api.rb +111 -0
  66. data/lib/swagger_client/api/order_api.rb +229 -0
  67. data/lib/swagger_client/api/payment_api.rb +517 -0
  68. data/lib/swagger_client/api_client.rb +390 -0
  69. data/lib/swagger_client/api_error.rb +38 -0
  70. data/lib/swagger_client/configuration.rb +202 -0
  71. data/lib/swagger_client/models/access_token_response.rb +252 -0
  72. data/lib/swagger_client/models/address.rb +361 -0
  73. data/lib/swagger_client/models/airline.rb +487 -0
  74. data/lib/swagger_client/models/airline_ancillary_service_category.rb +221 -0
  75. data/lib/swagger_client/models/airline_travel_route.rb +406 -0
  76. data/lib/swagger_client/models/amount.rb +217 -0
  77. data/lib/swagger_client/models/amount_components.rb +242 -0
  78. data/lib/swagger_client/models/authentication_response_verification.rb +239 -0
  79. data/lib/swagger_client/models/basket_item.rb +218 -0
  80. data/lib/swagger_client/models/billing.rb +282 -0
  81. data/lib/swagger_client/models/car_rental.rb +317 -0
  82. data/lib/swagger_client/models/car_rental_extra_charges.rb +221 -0
  83. data/lib/swagger_client/models/card_verifications_transaction.rb +203 -0
  84. data/lib/swagger_client/models/client_locale.rb +209 -0
  85. data/lib/swagger_client/models/contact.rb +279 -0
  86. data/lib/swagger_client/models/error.rb +211 -0
  87. data/lib/swagger_client/models/error_details.rb +199 -0
  88. data/lib/swagger_client/models/error_response.rb +218 -0
  89. data/lib/swagger_client/models/expiration.rb +207 -0
  90. data/lib/swagger_client/models/frequency.rb +270 -0
  91. data/lib/swagger_client/models/industry_specific_extensions.rb +206 -0
  92. data/lib/swagger_client/models/installment_options.rb +259 -0
  93. data/lib/swagger_client/models/lodging.rb +245 -0
  94. data/lib/swagger_client/models/lodging_extra_charges.rb +221 -0
  95. data/lib/swagger_client/models/order.rb +206 -0
  96. data/lib/swagger_client/models/pay_pal.rb +213 -0
  97. data/lib/swagger_client/models/payment_card.rb +294 -0
  98. data/lib/swagger_client/models/payment_card_authentication_request.rb +222 -0
  99. data/lib/swagger_client/models/payment_card_authentication_result.rb +336 -0
  100. data/lib/swagger_client/models/payment_method.rb +254 -0
  101. data/lib/swagger_client/models/payment_schedules_request.rb +398 -0
  102. data/lib/swagger_client/models/payment_schedules_response.rb +267 -0
  103. data/lib/swagger_client/models/payment_url_request.rb +232 -0
  104. data/lib/swagger_client/models/payment_url_response.rb +286 -0
  105. data/lib/swagger_client/models/primary_transaction.rb +298 -0
  106. data/lib/swagger_client/models/primary_transaction_additional_details.rb +244 -0
  107. data/lib/swagger_client/models/processor_data.rb +216 -0
  108. data/lib/swagger_client/models/response_type.rb +37 -0
  109. data/lib/swagger_client/models/secondary_transaction.rb +197 -0
  110. data/lib/swagger_client/models/sepa.rb +321 -0
  111. data/lib/swagger_client/models/sepa_mandate.rb +321 -0
  112. data/lib/swagger_client/models/shipping.rb +222 -0
  113. data/lib/swagger_client/models/split_shipment.rb +201 -0
  114. data/lib/swagger_client/models/stored_credential.rb +290 -0
  115. data/lib/swagger_client/models/transaction_error_response.rb +445 -0
  116. data/lib/swagger_client/models/transaction_response.rb +436 -0
  117. data/lib/swagger_client/models/transaction_response_authentication_redirect.rb +239 -0
  118. data/lib/swagger_client/models/transaction_response_authentication_redirect_params.rb +206 -0
  119. data/lib/swagger_client/models/transaction_type.rb +36 -0
  120. data/lib/swagger_client/version.rb +15 -0
  121. data/spec/api/authentication_api_spec.rb +51 -0
  122. data/spec/api/order_api_spec.rb +73 -0
  123. data/spec/api/payment_api_spec.rb +126 -0
  124. data/spec/api_client_spec.rb +226 -0
  125. data/spec/configuration_spec.rb +42 -0
  126. data/spec/models/access_token_response_spec.rb +64 -0
  127. data/spec/models/address_spec.rb +78 -0
  128. data/spec/models/airline_ancillary_service_category_spec.rb +46 -0
  129. data/spec/models/airline_spec.rb +124 -0
  130. data/spec/models/airline_travel_route_spec.rb +94 -0
  131. data/spec/models/amount_components_spec.rb +78 -0
  132. data/spec/models/amount_spec.rb +54 -0
  133. data/spec/models/authentication_response_verification_spec.rb +58 -0
  134. data/spec/models/basket_item_spec.rb +60 -0
  135. data/spec/models/billing_spec.rb +76 -0
  136. data/spec/models/car_rental_extra_charges_spec.rb +46 -0
  137. data/spec/models/car_rental_spec.rb +84 -0
  138. data/spec/models/card_verifications_transaction_spec.rb +48 -0
  139. data/spec/models/client_locale_spec.rb +48 -0
  140. data/spec/models/contact_spec.rb +60 -0
  141. data/spec/models/error_details_spec.rb +48 -0
  142. data/spec/models/error_response_spec.rb +60 -0
  143. data/spec/models/error_spec.rb +54 -0
  144. data/spec/models/expiration_spec.rb +48 -0
  145. data/spec/models/frequency_spec.rb +52 -0
  146. data/spec/models/industry_specific_extensions_spec.rb +54 -0
  147. data/spec/models/installment_options_spec.rb +54 -0
  148. data/spec/models/lodging_extra_charges_spec.rb +46 -0
  149. data/spec/models/lodging_spec.rb +66 -0
  150. data/spec/models/order_spec.rb +54 -0
  151. data/spec/models/pay_pal_spec.rb +42 -0
  152. data/spec/models/payment_card_authentication_request_spec.rb +46 -0
  153. data/spec/models/payment_card_authentication_result_spec.rb +78 -0
  154. data/spec/models/payment_card_spec.rb +88 -0
  155. data/spec/models/payment_method_spec.rb +64 -0
  156. data/spec/models/payment_schedules_request_spec.rb +124 -0
  157. data/spec/models/payment_schedules_response_spec.rb +64 -0
  158. data/spec/models/payment_url_request_spec.rb +60 -0
  159. data/spec/models/payment_url_response_spec.rb +76 -0
  160. data/spec/models/primary_transaction_additional_details_spec.rb +78 -0
  161. data/spec/models/primary_transaction_spec.rb +102 -0
  162. data/spec/models/processor_data_spec.rb +54 -0
  163. data/spec/models/response_type_spec.rb +36 -0
  164. data/spec/models/secondary_transaction_spec.rb +48 -0
  165. data/spec/models/sepa_mandate_spec.rb +64 -0
  166. data/spec/models/sepa_spec.rb +66 -0
  167. data/spec/models/shipping_spec.rb +54 -0
  168. data/spec/models/split_shipment_spec.rb +48 -0
  169. data/spec/models/stored_credential_spec.rb +68 -0
  170. data/spec/models/transaction_error_response_spec.rb +170 -0
  171. data/spec/models/transaction_response_authentication_redirect_params_spec.rb +54 -0
  172. data/spec/models/transaction_response_authentication_redirect_spec.rb +58 -0
  173. data/spec/models/transaction_response_spec.rb +164 -0
  174. data/spec/models/transaction_type_spec.rb +36 -0
  175. data/spec/spec_helper.rb +111 -0
  176. metadata +457 -0
@@ -0,0 +1,9 @@
1
+ # SwaggerClient::ErrorDetails
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **field** | **String** | The property or attribute associated with the error. | [optional]
7
+ **message** | **String** | Information specific to a property or attribute. | [optional]
8
+
9
+
@@ -0,0 +1,11 @@
1
+ # SwaggerClient::ErrorResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **client_request_id** | **String** | Echoes back the value from the request header for tracking | [optional]
7
+ **api_trace_id** | **String** | Request identifier in API. Use this to request logs from support. | [optional]
8
+ **response_type** | [**ResponseType**](ResponseType.md) | The schema type returned in the response. | [optional]
9
+ **error** | [**Error**](Error.md) | | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # SwaggerClient::Expiration
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **month** | **String** | |
7
+ **year** | **String** | |
8
+
9
+
data/docs/Frequency.md ADDED
@@ -0,0 +1,9 @@
1
+ # SwaggerClient::Frequency
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **every** | **Integer** | Rate of frequency. |
7
+ **unit** | **String** | Unit which defines the frequency. |
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # SwaggerClient::IndustrySpecificExtensions
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **airline** | [**Airline**](Airline.md) | | [optional]
7
+ **lodging** | [**Lodging**](Lodging.md) | | [optional]
8
+ **car_rental** | [**CarRental**](CarRental.md) | | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # SwaggerClient::InstallmentOptions
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **number_of_installments** | **Integer** | Number of installments for a Sale transaction if the customer pays the total amount in multiple transactions | [optional]
7
+ **installments_interest** | **BOOLEAN** | Indicates whether the installment interest amount has been applied. Possible values are \"yes\" or \"no\". | [optional]
8
+ **installment_delay_months** | **Integer** | The number of months the first installment payment will be delayed | [optional]
9
+
10
+
data/docs/Lodging.md ADDED
@@ -0,0 +1,12 @@
1
+ # SwaggerClient::Lodging
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **arrival_date** | **Date** | Date of arrival | [optional]
7
+ **departure_date** | **Date** | Date of departure | [optional]
8
+ **folio_number** | **String** | Portfolio number | [optional]
9
+ **extra_charges** | [**Array<LodgingExtraCharges>**](LodgingExtraCharges.md) | | [optional]
10
+ **no_show_indicator** | **BOOLEAN** | | [optional]
11
+
12
+
@@ -0,0 +1,8 @@
1
+ # SwaggerClient::LodgingExtraCharges
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **charge_item** | **String** | | [optional]
7
+
8
+
data/docs/Order.md ADDED
@@ -0,0 +1,10 @@
1
+ # SwaggerClient::Order
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **order_id** | **String** | | [optional]
7
+ **billing** | [**Billing**](Billing.md) | | [optional]
8
+ **shipping** | [**Shipping**](Shipping.md) | | [optional]
9
+
10
+
data/docs/OrderApi.md ADDED
@@ -0,0 +1,148 @@
1
+ # SwaggerClient::OrderApi
2
+
3
+ All URIs are relative to *https://cert.api.firstdata.com/gateway*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**perform_payment_post_authorisation**](OrderApi.md#perform_payment_post_authorisation) | **POST** /v1/orders/{order-id}/postauth | Use this to capture/complete a transaction. Partial postauths are allowed.
8
+ [**return_transaction**](OrderApi.md#return_transaction) | **POST** /v1/orders/{order-id}/return | Use this to return/refund on the order. Partial returns are allowed.
9
+
10
+
11
+ # **perform_payment_post_authorisation**
12
+ > TransactionResponse perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, message_signature, order_id, payload, opts)
13
+
14
+ Use this to capture/complete a transaction. Partial postauths are allowed.
15
+
16
+ This can be used for postauth and partial postauths.
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'swagger_client'
22
+
23
+ api_instance = SwaggerClient::OrderApi.new
24
+
25
+ content_type = "application/json" # String | content type
26
+
27
+ client_request_id = "client_request_id_example" # 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.
28
+
29
+ api_key = "api_key_example" # String |
30
+
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
+
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
+ order_id = "order_id_example" # String | Gateway order identifier as returned in the parameter orderId
36
+
37
+ payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
38
+
39
+ opts = {
40
+ store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
41
+ }
42
+
43
+ begin
44
+ #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, message_signature, order_id, payload, opts)
46
+ p result
47
+ rescue SwaggerClient::ApiError => e
48
+ puts "Exception when calling OrderApi->perform_payment_post_authorisation: #{e}"
49
+ end
50
+ ```
51
+
52
+ ### Parameters
53
+
54
+ Name | Type | Description | Notes
55
+ ------------- | ------------- | ------------- | -------------
56
+ **content_type** | **String**| content type | [default to application/json]
57
+ **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
+ **api_key** | **String**| |
59
+ **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
+ **order_id** | **String**| Gateway order identifier as returned in the parameter orderId |
62
+ **payload** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
63
+ **store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
64
+
65
+ ### Return type
66
+
67
+ [**TransactionResponse**](TransactionResponse.md)
68
+
69
+ ### Authorization
70
+
71
+ No authorization required
72
+
73
+ ### HTTP request headers
74
+
75
+ - **Content-Type**: application/json
76
+ - **Accept**: application/json
77
+
78
+
79
+
80
+ # **return_transaction**
81
+ > TransactionResponse return_transaction(content_type, client_request_id, api_key, timestamp, message_signature, order_id, payload, opts)
82
+
83
+ Use this to return/refund on the order. Partial returns are allowed.
84
+
85
+ This can be used for Returns and Partial Returns.
86
+
87
+ ### Example
88
+ ```ruby
89
+ # load the gem
90
+ require 'swagger_client'
91
+
92
+ api_instance = SwaggerClient::OrderApi.new
93
+
94
+ content_type = "application/json" # String | content type
95
+
96
+ client_request_id = "client_request_id_example" # 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.
97
+
98
+ api_key = "api_key_example" # String |
99
+
100
+ 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
+
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
+ order_id = "order_id_example" # String | Gateway order identifier as returned in the parameter orderId
105
+
106
+ payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
107
+
108
+ opts = {
109
+ store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
110
+ }
111
+
112
+ begin
113
+ #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, message_signature, order_id, payload, opts)
115
+ p result
116
+ rescue SwaggerClient::ApiError => e
117
+ puts "Exception when calling OrderApi->return_transaction: #{e}"
118
+ end
119
+ ```
120
+
121
+ ### Parameters
122
+
123
+ Name | Type | Description | Notes
124
+ ------------- | ------------- | ------------- | -------------
125
+ **content_type** | **String**| content type | [default to application/json]
126
+ **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
+ **api_key** | **String**| |
128
+ **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
+ **order_id** | **String**| Gateway order identifier as returned in the parameter orderId |
131
+ **payload** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
132
+ **store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
133
+
134
+ ### Return type
135
+
136
+ [**TransactionResponse**](TransactionResponse.md)
137
+
138
+ ### Authorization
139
+
140
+ No authorization required
141
+
142
+ ### HTTP request headers
143
+
144
+ - **Content-Type**: application/json
145
+ - **Accept**: application/json
146
+
147
+
148
+
data/docs/PayPal.md ADDED
@@ -0,0 +1,8 @@
1
+ # SwaggerClient::PayPal
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **recipient_email** | **String** | Email address of the recipient |
7
+
8
+
@@ -0,0 +1,345 @@
1
+ # SwaggerClient::PaymentApi
2
+
3
+ All URIs are relative to *https://cert.api.firstdata.com/gateway*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**perform_payment_post_authorisation**](PaymentApi.md#perform_payment_post_authorisation) | **POST** /v1/payments/{transaction-id}/postauth | Use this to capture/complete a transaction. Partial postauths are allowed.
8
+ [**primary_payment_transaction**](PaymentApi.md#primary_payment_transaction) | **POST** /v1/payments | Generate a primary transaction
9
+ [**return_transaction**](PaymentApi.md#return_transaction) | **POST** /v1/payments/{transaction-id}/return | Return/refund a transaction.
10
+ [**transaction_inquiry**](PaymentApi.md#transaction_inquiry) | **GET** /v1/payments/{transaction-id} | Retrieve the state of a transaction
11
+ [**void_transaction**](PaymentApi.md#void_transaction) | **POST** /v1/payments/{transaction-id}/void | Reverse a previous action on an existing transaction
12
+
13
+
14
+ # **perform_payment_post_authorisation**
15
+ > TransactionResponse perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, payload, opts)
16
+
17
+ Use this to capture/complete a transaction. Partial postauths are allowed.
18
+
19
+ This can be used for postauth and partial postauths.
20
+
21
+ ### Example
22
+ ```ruby
23
+ # load the gem
24
+ require 'swagger_client'
25
+
26
+ api_instance = SwaggerClient::PaymentApi.new
27
+
28
+ content_type = "application/json" # String | content type
29
+
30
+ client_request_id = "client_request_id_example" # 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.
31
+
32
+ api_key = "api_key_example" # String |
33
+
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
+
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
+ transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
39
+
40
+ payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
41
+
42
+ opts = {
43
+ store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
44
+ }
45
+
46
+ begin
47
+ #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, message_signature, transaction_id, payload, opts)
49
+ p result
50
+ rescue SwaggerClient::ApiError => e
51
+ puts "Exception when calling PaymentApi->perform_payment_post_authorisation: #{e}"
52
+ end
53
+ ```
54
+
55
+ ### Parameters
56
+
57
+ Name | Type | Description | Notes
58
+ ------------- | ------------- | ------------- | -------------
59
+ **content_type** | **String**| content type | [default to application/json]
60
+ **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
+ **api_key** | **String**| |
62
+ **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
+ **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId |
65
+ **payload** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
66
+ **store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
67
+
68
+ ### Return type
69
+
70
+ [**TransactionResponse**](TransactionResponse.md)
71
+
72
+ ### Authorization
73
+
74
+ No authorization required
75
+
76
+ ### HTTP request headers
77
+
78
+ - **Content-Type**: application/json
79
+ - **Accept**: application/json
80
+
81
+
82
+
83
+ # **primary_payment_transaction**
84
+ > TransactionResponse primary_payment_transaction(content_type, client_request_id, api_key, timestamp, message_signature, payload)
85
+
86
+ Generate a primary transaction
87
+
88
+ Use this to originate a financial transaction, like a sale, preauthorization, or credit.
89
+
90
+ ### Example
91
+ ```ruby
92
+ # load the gem
93
+ require 'swagger_client'
94
+
95
+ api_instance = SwaggerClient::PaymentApi.new
96
+
97
+ content_type = "application/json" # String | content type
98
+
99
+ client_request_id = "client_request_id_example" # 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.
100
+
101
+ api_key = "api_key_example" # String |
102
+
103
+ 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
+
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
+ payload = SwaggerClient::PrimaryTransaction.new # PrimaryTransaction | Primary Transaction request
108
+
109
+
110
+ begin
111
+ #Generate a primary transaction
112
+ result = api_instance.primary_payment_transaction(content_type, client_request_id, api_key, timestamp, message_signature, payload)
113
+ p result
114
+ rescue SwaggerClient::ApiError => e
115
+ puts "Exception when calling PaymentApi->primary_payment_transaction: #{e}"
116
+ end
117
+ ```
118
+
119
+ ### Parameters
120
+
121
+ Name | Type | Description | Notes
122
+ ------------- | ------------- | ------------- | -------------
123
+ **content_type** | **String**| content type | [default to application/json]
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
+ **api_key** | **String**| |
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
+ **payload** | [**PrimaryTransaction**](PrimaryTransaction.md)| Primary Transaction request |
129
+
130
+ ### Return type
131
+
132
+ [**TransactionResponse**](TransactionResponse.md)
133
+
134
+ ### Authorization
135
+
136
+ No authorization required
137
+
138
+ ### HTTP request headers
139
+
140
+ - **Content-Type**: application/json
141
+ - **Accept**: application/json
142
+
143
+
144
+
145
+ # **return_transaction**
146
+ > TransactionResponse return_transaction(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, payload, opts)
147
+
148
+ Return/refund a transaction.
149
+
150
+ Use this to return/refund an existing transaction. Partial returns are allowed.
151
+
152
+ ### Example
153
+ ```ruby
154
+ # load the gem
155
+ require 'swagger_client'
156
+
157
+ api_instance = SwaggerClient::PaymentApi.new
158
+
159
+ content_type = "application/json" # String | content type
160
+
161
+ client_request_id = "client_request_id_example" # 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.
162
+
163
+ api_key = "api_key_example" # String |
164
+
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
+
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
+ transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
170
+
171
+ payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
172
+
173
+ opts = {
174
+ store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
175
+ }
176
+
177
+ begin
178
+ #Return/refund a transaction.
179
+ result = api_instance.return_transaction(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, payload, opts)
180
+ p result
181
+ rescue SwaggerClient::ApiError => e
182
+ puts "Exception when calling PaymentApi->return_transaction: #{e}"
183
+ end
184
+ ```
185
+
186
+ ### Parameters
187
+
188
+ Name | Type | Description | Notes
189
+ ------------- | ------------- | ------------- | -------------
190
+ **content_type** | **String**| content type | [default to application/json]
191
+ **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
+ **api_key** | **String**| |
193
+ **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
+ **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId |
196
+ **payload** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
197
+ **store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
198
+
199
+ ### Return type
200
+
201
+ [**TransactionResponse**](TransactionResponse.md)
202
+
203
+ ### Authorization
204
+
205
+ No authorization required
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: application/json
210
+ - **Accept**: application/json
211
+
212
+
213
+
214
+ # **transaction_inquiry**
215
+ > TransactionResponse transaction_inquiry(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, , opts)
216
+
217
+ Retrieve the state of a transaction
218
+
219
+ Use this query to get the current state of an existing transaction.
220
+
221
+ ### Example
222
+ ```ruby
223
+ # load the gem
224
+ require 'swagger_client'
225
+
226
+ api_instance = SwaggerClient::PaymentApi.new
227
+
228
+ content_type = "application/json" # String | content type
229
+
230
+ client_request_id = "client_request_id_example" # 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.
231
+
232
+ api_key = "api_key_example" # String |
233
+
234
+ 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
+
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
+ transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
239
+
240
+ opts = {
241
+ store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
242
+ }
243
+
244
+ begin
245
+ #Retrieve the state of a transaction
246
+ result = api_instance.transaction_inquiry(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, , opts)
247
+ p result
248
+ rescue SwaggerClient::ApiError => e
249
+ puts "Exception when calling PaymentApi->transaction_inquiry: #{e}"
250
+ end
251
+ ```
252
+
253
+ ### Parameters
254
+
255
+ Name | Type | Description | Notes
256
+ ------------- | ------------- | ------------- | -------------
257
+ **content_type** | **String**| content type | [default to application/json]
258
+ **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
+ **api_key** | **String**| |
260
+ **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
+ **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId |
263
+ **store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
264
+
265
+ ### Return type
266
+
267
+ [**TransactionResponse**](TransactionResponse.md)
268
+
269
+ ### Authorization
270
+
271
+ No authorization required
272
+
273
+ ### HTTP request headers
274
+
275
+ - **Content-Type**: application/json
276
+ - **Accept**: application/json
277
+
278
+
279
+
280
+ # **void_transaction**
281
+ > TransactionResponse void_transaction(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, , opts)
282
+
283
+ Reverse a previous action on an existing transaction
284
+
285
+ Use this to reverse a postauth/completion, credit, preauth, or sale.
286
+
287
+ ### Example
288
+ ```ruby
289
+ # load the gem
290
+ require 'swagger_client'
291
+
292
+ api_instance = SwaggerClient::PaymentApi.new
293
+
294
+ content_type = "application/json" # String | content type
295
+
296
+ client_request_id = "client_request_id_example" # 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.
297
+
298
+ api_key = "api_key_example" # String |
299
+
300
+ 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
+
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
+ transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
305
+
306
+ opts = {
307
+ store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
308
+ }
309
+
310
+ begin
311
+ #Reverse a previous action on an existing transaction
312
+ result = api_instance.void_transaction(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, , opts)
313
+ p result
314
+ rescue SwaggerClient::ApiError => e
315
+ puts "Exception when calling PaymentApi->void_transaction: #{e}"
316
+ end
317
+ ```
318
+
319
+ ### Parameters
320
+
321
+ Name | Type | Description | Notes
322
+ ------------- | ------------- | ------------- | -------------
323
+ **content_type** | **String**| content type | [default to application/json]
324
+ **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
+ **api_key** | **String**| |
326
+ **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
+ **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId |
329
+ **store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
330
+
331
+ ### Return type
332
+
333
+ [**TransactionResponse**](TransactionResponse.md)
334
+
335
+ ### Authorization
336
+
337
+ No authorization required
338
+
339
+ ### HTTP request headers
340
+
341
+ - **Content-Type**: application/json
342
+ - **Accept**: application/json
343
+
344
+
345
+