first_data_gateway 1.0.3 → 1.1.0

data/docs/PaymentApi.md

@@ -1,52 +1,108 @@
-# SwaggerClient::PaymentApi
+# OpenapiClient::PaymentApi
 
 All URIs are relative to *https://cert.api.firstdata.com/gateway*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**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.
-[**primary_payment_transaction**](PaymentApi.md#primary_payment_transaction) | **POST** /v1/payments | Generate a primary transaction
+[**finalize_secure_transaction**](PaymentApi.md#finalize_secure_transaction) | **PATCH** /v1/payments/{transaction-id} | Update a 3DSecure or UnionPay payment and continue processing.
+[**perform_payment_post_authorisation**](PaymentApi.md#perform_payment_post_authorisation) | **POST** /v1/payments/{transaction-id}/postauth | Capture/complete a transaction.
+[**primary_payment_transaction**](PaymentApi.md#primary_payment_transaction) | **POST** /v1/payments | Generate a primary transaction.
 [**return_transaction**](PaymentApi.md#return_transaction) | **POST** /v1/payments/{transaction-id}/return | Return/refund a transaction.
-[**transaction_inquiry**](PaymentApi.md#transaction_inquiry) | **GET** /v1/payments/{transaction-id} | Retrieve the state of a transaction
-[**void_transaction**](PaymentApi.md#void_transaction) | **POST** /v1/payments/{transaction-id}/void | Reverse a previous action on an existing transaction
+[**transaction_inquiry**](PaymentApi.md#transaction_inquiry) | **GET** /v1/payments/{transaction-id} | Retrieve the state of a transaction.
+[**void_transaction**](PaymentApi.md#void_transaction) | **POST** /v1/payments/{transaction-id}/void | Reverse a previous action on an existing transaction.
 
 
-# **perform_payment_post_authorisation**
-> TransactionResponse perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, transaction_id, payload, opts)
+# **finalize_secure_transaction**
+> TransactionResponse finalize_secure_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, authentication_response_verification_request, opts)
 
-Use this to capture/complete a transaction. Partial postauths are allowed.
+Update a 3DSecure or UnionPay payment and continue processing.
 
-This can be used for postauth and partial postauths.
+Use this to handle a 3DSecure redirect response or UnionPay authentication, updating the transaction and continuing processing.
 
 ### Example
 ```ruby
 # load the gem
-require 'swagger_client'
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentApi.new
+content_type = 'application/json' # String | content type
+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.
+api_key = 'api_key_example' # String | 
+timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+transaction_id = 'transaction_id_example' # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
+authentication_response_verification_request = OpenapiClient::AuthenticationResponseVerificationRequest.new # AuthenticationResponseVerificationRequest | 
+opts = {
+  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.
+  region: 'region_example' # String | The region where client wants to process the transaction
+}
+
+begin
+  #Update a 3DSecure or UnionPay payment and continue processing.
+  result = api_instance.finalize_secure_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, authentication_response_verification_request, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PaymentApi->finalize_secure_transaction: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content_type** | **String**| content type | [default to 'application/json']
+ **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. | 
+ **api_key** | **String**|  | 
+ **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | 
+ **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId | 
+ **authentication_response_verification_request** | [**AuthenticationResponseVerificationRequest**](AuthenticationResponseVerificationRequest.md)|  | 
+ **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] 
+ **region** | **String**| The region where client wants to process the transaction | [optional] 
+
+### Return type
+
+[**TransactionResponse**](TransactionResponse.md)
+
+### Authorization
+
+No authorization required
 
-api_instance = SwaggerClient::PaymentApi.new
+### HTTP request headers
 
-content_type = "application/json" # String | content type
+ - **Content-Type**: application/json
+ - **Accept**: application/json
 
-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.
 
-api_key = "api_key_example" # String | 
 
-timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+# **perform_payment_post_authorisation**
+> TransactionResponse perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, transaction_id, secondary_transaction, opts)
 
-transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
+Capture/complete a transaction.
 
-payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction | 
+Used to capture/complete an existing transaction. Partial postauths are allowed.
 
-opts = { 
-  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.
-  store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
+### Example
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentApi.new
+content_type = 'application/json' # String | content type
+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.
+api_key = 'api_key_example' # String | 
+timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+transaction_id = 'transaction_id_example' # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
+secondary_transaction = OpenapiClient::SecondaryTransaction.new # SecondaryTransaction | 
+opts = {
+  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.
+  region: 'region_example', # String | The region where client wants to process the transaction
+  store_id: 'store_id_example' # String | An optional outlet ID for clients that support multiple stores in the same developer app
 }
 
 begin
-  #Use this to capture/complete a transaction. Partial postauths are allowed.
-  result = api_instance.perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, transaction_id, payload, opts)
+  #Capture/complete a transaction.
+  result = api_instance.perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, transaction_id, secondary_transaction, opts)
   p result
-rescue SwaggerClient::ApiError => e
+rescue OpenapiClient::ApiError => e
   puts "Exception when calling PaymentApi->perform_payment_post_authorisation: #{e}"
 end
 ```
@@ -55,14 +111,15 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **content_type** | **String**| content type | [default to application/json]
+ **content_type** | **String**| content type | [default to 'application/json']
  **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. | 
  **api_key** | **String**|  | 
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | 
  **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId | 
- **payload** | [**SecondaryTransaction**](SecondaryTransaction.md)|  | 
+ **secondary_transaction** | [**SecondaryTransaction**](SecondaryTransaction.md)|  | 
  **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] 
- **store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional] 
+ **region** | **String**| The region where client wants to process the transaction | [optional] 
+ **store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app | [optional] 
 
 ### Return type
 
@@ -80,38 +137,33 @@ No authorization required
 
 
 # **primary_payment_transaction**
-> TransactionResponse primary_payment_transaction(content_type, client_request_id, api_key, timestamp, payload, opts)
+> TransactionResponse primary_payment_transaction(content_type, client_request_id, api_key, timestamp, primary_transaction, opts)
 
-Generate a primary transaction
+Generate a primary transaction.
 
 Use this to originate a financial transaction, like a sale, preauthorization, or credit.
 
 ### Example
 ```ruby
 # load the gem
-require 'swagger_client'
-
-api_instance = SwaggerClient::PaymentApi.new
-
-content_type = "application/json" # String | content type
-
-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.
-
-api_key = "api_key_example" # String | 
-
-timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-
-payload = SwaggerClient::PrimaryTransaction.new # PrimaryTransaction | Primary Transaction request
-
-opts = { 
-  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.
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentApi.new
+content_type = 'application/json' # String | content type
+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.
+api_key = 'api_key_example' # String | 
+timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+primary_transaction = OpenapiClient::PrimaryTransaction.new # PrimaryTransaction | Primary Transaction request
+opts = {
+  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.
+  region: 'region_example' # String | The region where client wants to process the transaction
 }
 
 begin
-  #Generate a primary transaction
-  result = api_instance.primary_payment_transaction(content_type, client_request_id, api_key, timestamp, payload, opts)
+  #Generate a primary transaction.
+  result = api_instance.primary_payment_transaction(content_type, client_request_id, api_key, timestamp, primary_transaction, opts)
   p result
-rescue SwaggerClient::ApiError => e
+rescue OpenapiClient::ApiError => e
   puts "Exception when calling PaymentApi->primary_payment_transaction: #{e}"
 end
 ```
@@ -120,12 +172,13 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **content_type** | **String**| content type | [default to application/json]
+ **content_type** | **String**| content type | [default to 'application/json']
  **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. | 
  **api_key** | **String**|  | 
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | 
- **payload** | [**PrimaryTransaction**](PrimaryTransaction.md)| Primary Transaction request | 
+ **primary_transaction** | [**PrimaryTransaction**](PrimaryTransaction.md)| Primary Transaction request | 
  **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] 
+ **region** | **String**| The region where client wants to process the transaction | [optional] 
 
 ### Return type
 
@@ -143,7 +196,7 @@ No authorization required
 
 
 # **return_transaction**
-> TransactionResponse return_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, payload, opts)
+> TransactionResponse return_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, secondary_transaction, opts)
 
 Return/refund a transaction.
 
@@ -152,32 +205,26 @@ Use this to return/refund an existing transaction.  Partial returns are allowed.
 ### Example
 ```ruby
 # load the gem
-require 'swagger_client'
-
-api_instance = SwaggerClient::PaymentApi.new
-
-content_type = "application/json" # String | content type
-
-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.
-
-api_key = "api_key_example" # String | 
-
-timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-
-transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
-
-payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction | 
-
-opts = { 
-  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.
-  store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentApi.new
+content_type = 'application/json' # String | content type
+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.
+api_key = 'api_key_example' # String | 
+timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+transaction_id = 'transaction_id_example' # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
+secondary_transaction = OpenapiClient::SecondaryTransaction.new # SecondaryTransaction | 
+opts = {
+  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.
+  region: 'region_example', # String | The region where client wants to process the transaction
+  store_id: 'store_id_example' # String | An optional outlet ID for clients that support multiple stores in the same developer app
 }
 
 begin
   #Return/refund a transaction.
-  result = api_instance.return_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, payload, opts)
+  result = api_instance.return_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, secondary_transaction, opts)
   p result
-rescue SwaggerClient::ApiError => e
+rescue OpenapiClient::ApiError => e
   puts "Exception when calling PaymentApi->return_transaction: #{e}"
 end
 ```
@@ -186,14 +233,15 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **content_type** | **String**| content type | [default to application/json]
+ **content_type** | **String**| content type | [default to 'application/json']
  **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. | 
  **api_key** | **String**|  | 
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | 
  **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId | 
- **payload** | [**SecondaryTransaction**](SecondaryTransaction.md)|  | 
+ **secondary_transaction** | [**SecondaryTransaction**](SecondaryTransaction.md)|  | 
  **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] 
- **store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional] 
+ **region** | **String**| The region where client wants to process the transaction | [optional] 
+ **store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app | [optional] 
 
 ### Return type
 
@@ -211,39 +259,34 @@ No authorization required
 
 
 # **transaction_inquiry**
-> TransactionResponse transaction_inquiry(content_type, client_request_id, api_key, timestamp, transaction_id, , opts)
+> TransactionResponse transaction_inquiry(content_type, client_request_id, api_key, timestamp, transaction_id, opts)
 
-Retrieve the state of a transaction
+Retrieve the state of a transaction.
 
 Use this query to get the current state of an existing transaction.
 
 ### Example
 ```ruby
 # load the gem
-require 'swagger_client'
-
-api_instance = SwaggerClient::PaymentApi.new
-
-content_type = "application/json" # String | content type
-
-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.
-
-api_key = "api_key_example" # String | 
-
-timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-
-transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
-
-opts = { 
-  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.
-  store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentApi.new
+content_type = 'application/json' # String | content type
+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.
+api_key = 'api_key_example' # String | 
+timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+transaction_id = 'transaction_id_example' # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
+opts = {
+  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.
+  region: 'region_example', # String | The region where client wants to process the transaction
+  store_id: 'store_id_example' # String | An optional outlet ID for clients that support multiple stores in the same developer app
 }
 
 begin
-  #Retrieve the state of a transaction
-  result = api_instance.transaction_inquiry(content_type, client_request_id, api_key, timestamp, transaction_id, , opts)
+  #Retrieve the state of a transaction.
+  result = api_instance.transaction_inquiry(content_type, client_request_id, api_key, timestamp, transaction_id, opts)
   p result
-rescue SwaggerClient::ApiError => e
+rescue OpenapiClient::ApiError => e
   puts "Exception when calling PaymentApi->transaction_inquiry: #{e}"
 end
 ```
@@ -252,13 +295,14 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **content_type** | **String**| content type | [default to application/json]
+ **content_type** | **String**| content type | [default to 'application/json']
  **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. | 
  **api_key** | **String**|  | 
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | 
  **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId | 
  **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] 
- **store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional] 
+ **region** | **String**| The region where client wants to process the transaction | [optional] 
+ **store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app | [optional] 
 
 ### Return type
 
@@ -270,45 +314,40 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 
 
 
 # **void_transaction**
-> TransactionResponse void_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, , opts)
+> TransactionResponse void_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, opts)
 
-Reverse a previous action on an existing transaction
+Reverse a previous action on an existing transaction.
 
 Use this to reverse a postauth/completion, credit, preauth, or sale.
 
 ### Example
 ```ruby
 # load the gem
-require 'swagger_client'
-
-api_instance = SwaggerClient::PaymentApi.new
-
-content_type = "application/json" # String | content type
-
-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.
-
-api_key = "api_key_example" # String | 
-
-timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-
-transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
-
-opts = { 
-  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.
-  store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentApi.new
+content_type = 'application/json' # String | content type
+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.
+api_key = 'api_key_example' # String | 
+timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+transaction_id = 'transaction_id_example' # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
+opts = {
+  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.
+  region: 'region_example', # String | The region where client wants to process the transaction
+  store_id: 'store_id_example' # String | An optional outlet ID for clients that support multiple stores in the same developer app
 }
 
 begin
-  #Reverse a previous action on an existing transaction
-  result = api_instance.void_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, , opts)
+  #Reverse a previous action on an existing transaction.
+  result = api_instance.void_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, opts)
   p result
-rescue SwaggerClient::ApiError => e
+rescue OpenapiClient::ApiError => e
   puts "Exception when calling PaymentApi->void_transaction: #{e}"
 end
 ```
@@ -317,13 +356,14 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **content_type** | **String**| content type | [default to application/json]
+ **content_type** | **String**| content type | [default to 'application/json']
  **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. | 
  **api_key** | **String**|  | 
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | 
  **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId | 
  **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] 
- **store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional] 
+ **region** | **String**| The region where client wants to process the transaction | [optional] 
+ **store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app | [optional] 
 
 ### Return type
 
@@ -335,7 +375,7 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 
 

data/docs/PaymentCard.md

@@ -1,15 +1,19 @@
-# SwaggerClient::PaymentCard
+# OpenapiClient::PaymentCard
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**number** | **String** | Payment card number | 
+**number** | **String** | Payment card number | [optional] 
 **expiry_date** | [**Expiration**](Expiration.md) |  | [optional] 
-**security_code** | **String** | CVV | [optional] 
-**card_function** | **String** |  | [optional] [default to "CREDIT"]
-**cardholder_name** | **String** |  | [optional] 
-**authentication_request** | [**PaymentCardAuthenticationRequest**](PaymentCardAuthenticationRequest.md) |  | [optional] 
+**security_code** | **String** | Card Verification Value/Number | [optional] 
+**payment_tokenization** | [**PaymentTokenization**](PaymentTokenization.md) |  | [optional] 
+**card_function** | **String** | Card function. Optional, valid values are CREDIT or DEBIT. | [optional] 
+**cardholder_name** | **String** | Name of the cardholder on the card | [optional] 
+**authentication_request** | [**AuthenticationRequest**](AuthenticationRequest.md) |  | [optional] 
 **authentication_result** | [**PaymentCardAuthenticationResult**](PaymentCardAuthenticationResult.md) |  | [optional] 
+**bin** | **String** | The payment card BIN | [optional] 
+**last4** | **String** | The last 4 payment card numbers | [optional] 
 **brand** | **String** | Optional, required only if using dual branded card | [optional] 
+**issuing_country** | **String** | The issuing country | [optional] 
 
 

data/docs/PaymentCardAuthenticationResult.md

@@ -1,4 +1,4 @@
-# SwaggerClient::PaymentCardAuthenticationResult
+# OpenapiClient::PaymentCardAuthenticationResult
 
 ## Properties
 Name | Type | Description | Notes

data/docs/PaymentFacilitator.md

@@ -0,0 +1,12 @@
+# OpenapiClient::PaymentFacilitator
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_merchant_id** | **String** | External Merchant ID of the payment facilitator | 
+**payment_facilitator_id** | **String** | Payment Facilitator ID supplied during boarding | 
+**sale_organization_id** | **String** | Independent Sales Organization (ISO) ID provided by Mastercard | [optional] 
+**name** | **String** | Payment facilitator Name | 
+**sub_merchant_data** | [**SubMerchantData**](SubMerchantData.md) |  | [optional] 
+
+

data/docs/PaymentIssuerResponse.md

@@ -0,0 +1,10 @@
+# OpenapiClient::PaymentIssuerResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | The verification response code, as sent by the verification system. | 
+**status** | **String** | The interpretation of the response code. Valid values are \"approved\" - The verification was conducted and is approved. \"declined\" - The verification was conducted and is not approved. \"disabled\" - The verification was not conducted because it was not requested or disabled in the verification. \"unknown\" - The verification was attempted but it failed due to some system error (e.g. timeout). | [optional] 
+**scheme** | **String** | An identifier of the system/specification from which the code was received, and how the status was derived. | 
+
+

data/docs/PaymentMethod.md

@@ -1,11 +1,14 @@
-# SwaggerClient::PaymentMethod
+# OpenapiClient::PaymentMethod
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of payment method. Note that PayPal can only process a 'Credit'  primary transaction with Order.Billing.Contact.email being mandatory. PayPal secondary transactions (void/return/postauth) are processed the same as any other secondary transactions. | 
+**type** | **String** | The type of payment method. Note that PayPal can only process a 'CREDIT' transaction. Note that for requests we are now supporting only PAYMENT_CARD, SEPA, PAYPAL, ALIPAY. All this types are supported for response. | 
 **payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
+**payment_token** | [**PaymentTokenization**](PaymentTokenization.md) |  | [optional] 
 **sepa** | [**Sepa**](Sepa.md) |  | [optional] 
 **pay_pal** | [**PayPal**](PayPal.md) |  | [optional] 
+**ali_pay** | [**AliPay**](AliPay.md) |  | [optional] 
+**china_domestic** | [**ChinaDomestic**](ChinaDomestic.md) |  | [optional] 
 
 

data/docs/PaymentPayMethod.md

@@ -0,0 +1,13 @@
+# OpenapiClient::PaymentPayMethod
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**method_type** | **String** | Unique ID for the payment method type. | 
+**method_id** | **String** | The unique ID of this payment method if it was previously registered with a registration/method or if it is currently being registered. Must be unique for the entire system (not just within a specific merchant or industry). Mandatory if being used inside a registration/method. | [optional] 
+**method_alias** | **String** | The address that should be used to send billing information for this payment method. | [optional] 
+**card** | [**Card**](Card.md) |  | 
+**provider** | **String** | The Wallet provider. This field should be normalized before sending through the API. | [optional] 
+**user_defined** | [**Object**](.md) | A JSON object that can carry any additional information about the method that might be helpful for fraud detection. | [optional] 
+
+