first_data_gateway 1.1.0 → 1.2.0

data/docs/PaymentApi.md

@@ -1,19 +1,17 @@
 # OpenapiClient::PaymentApi
 
-All URIs are relative to *https://cert.api.firstdata.com/gateway*
+All URIs are relative to *https://cert.api.firstdata.com/gateway/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**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.
+[**finalize_secure_transaction**](PaymentApi.md#finalize_secure_transaction) | **PATCH** /payments/{transaction-id} | Update a 3DSecure or UnionPay payment and continue processing.
+[**submit_primary_transaction**](PaymentApi.md#submit_primary_transaction) | **POST** /payments | Generate a primary transaction.
+[**submit_secondary_transaction**](PaymentApi.md#submit_secondary_transaction) | **POST** /payments/{transaction-id} | Perform a secondary transaction.
+[**transaction_inquiry**](PaymentApi.md#transaction_inquiry) | **GET** /payments/{transaction-id} | Retrieve the state of a transaction.
 
 
 # **finalize_secure_transaction**
-> TransactionResponse finalize_secure_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, authentication_response_verification_request, opts)
+> TransactionResponse finalize_secure_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, authentication_verification_request, opts)
 
 Update a 3DSecure or UnionPay payment and continue processing.
 
@@ -25,20 +23,20 @@ Use this to handle a 3DSecure redirect response or UnionPay authentication, upda
 require 'openapi_client'
 
 api_instance = OpenapiClient::PaymentApi.new
-content_type = 'application/json' # String | content type
+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 | 
+api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
 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 | 
+transaction_id = 'transaction_id_example' # String | Gateway transaction identifier as returned in the parameter ipgTransactionId.
+authentication_verification_request = OpenapiClient::AuthenticationVerificationRequest.new # AuthenticationVerificationRequest | Accepted request types: Secure3dAuthenticationVerificationRequest and UnionPayAuthenticationVerificationRequest.
 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
+  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 | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
 }
 
 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)
+  result = api_instance.finalize_secure_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, authentication_verification_request, opts)
   p result
 rescue OpenapiClient::ApiError => e
   puts "Exception when calling PaymentApi->finalize_secure_transaction: #{e}"
@@ -49,14 +47,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**|  | 
+ **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. | 
  **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] 
+ **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId. | 
+ **authentication_verification_request** | [**AuthenticationVerificationRequest**](AuthenticationVerificationRequest.md)| Accepted request types: Secure3dAuthenticationVerificationRequest and UnionPayAuthenticationVerificationRequest. | 
+ **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**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional] 
 
 ### Return type
 
@@ -73,75 +71,12 @@ No authorization required
 
 
 
-# **perform_payment_post_authorisation**
-> TransactionResponse perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, transaction_id, secondary_transaction, opts)
-
-Capture/complete a transaction.
-
-Used to capture/complete an existing transaction. Partial postauths are allowed.
-
-### 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
-  #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 OpenapiClient::ApiError => e
-  puts "Exception when calling PaymentApi->perform_payment_post_authorisation: #{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 | 
- **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] 
- **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
-
-[**TransactionResponse**](TransactionResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **primary_payment_transaction**
-> TransactionResponse primary_payment_transaction(content_type, client_request_id, api_key, timestamp, primary_transaction, opts)
+# **submit_primary_transaction**
+> TransactionResponse submit_primary_transaction(content_type, client_request_id, api_key, timestamp, primary_transaction, opts)
 
 Generate a primary transaction.
 
-Use this to originate a financial transaction, like a sale, preauthorization, or credit.
+Use this to originate a financial transaction like a sale, preauthorization, or credit.
 
 ### Example
 ```ruby
@@ -149,22 +84,22 @@ Use this to originate a financial transaction, like a sale, preauthorization, or
 require 'openapi_client'
 
 api_instance = OpenapiClient::PaymentApi.new
-content_type = 'application/json' # String | content type
+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 | 
+api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
 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
+primary_transaction = OpenapiClient::PrimaryTransaction.new # PrimaryTransaction | Accepted request types: AliPaySaleTransaction, ChinaPnRSaleTransaction, PaymentCardCreditTransaction, PaymentCardForcedTicketTransaction, PaymentCardSaleTransaction, PaymentCardPreAuthTransaction, PaymentCardPayerAuthTransaction, PaymentTokenCreditTransaction, PaymentTokenPreAuthTransaction, PaymentTokenSaleTransaction, PaypalCreditTransaction, and SepaSaleTransaction.
 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
+  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 | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
 }
 
 begin
   #Generate a primary transaction.
-  result = api_instance.primary_payment_transaction(content_type, client_request_id, api_key, timestamp, primary_transaction, opts)
+  result = api_instance.submit_primary_transaction(content_type, client_request_id, api_key, timestamp, primary_transaction, opts)
   p result
 rescue OpenapiClient::ApiError => e
-  puts "Exception when calling PaymentApi->primary_payment_transaction: #{e}"
+  puts "Exception when calling PaymentApi->submit_primary_transaction: #{e}"
 end
 ```
 
@@ -172,13 +107,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**|  | 
+ **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. | 
  **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | 
- **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] 
+ **primary_transaction** | [**PrimaryTransaction**](PrimaryTransaction.md)| Accepted request types: AliPaySaleTransaction, ChinaPnRSaleTransaction, PaymentCardCreditTransaction, PaymentCardForcedTicketTransaction, PaymentCardSaleTransaction, PaymentCardPreAuthTransaction, PaymentCardPayerAuthTransaction, PaymentTokenCreditTransaction, PaymentTokenPreAuthTransaction, PaymentTokenSaleTransaction, PaypalCreditTransaction, and SepaSaleTransaction. | 
+ **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**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional] 
 
 ### Return type
 
@@ -195,12 +130,12 @@ No authorization required
 
 
 
-# **return_transaction**
-> TransactionResponse return_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, secondary_transaction, opts)
+# **submit_secondary_transaction**
+> TransactionResponse submit_secondary_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, secondary_transaction, opts)
 
-Return/refund a transaction.
+Perform a secondary transaction.
 
-Use this to return/refund an existing transaction.  Partial returns are allowed.
+Use this to perform a void, postAuth or return secondary transaction. Partial postAuths and returns are allowed.
 
 ### Example
 ```ruby
@@ -208,24 +143,24 @@ Use this to return/refund an existing transaction.  Partial returns are allowed.
 require 'openapi_client'
 
 api_instance = OpenapiClient::PaymentApi.new
-content_type = 'application/json' # String | content type
+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 | 
+api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
 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 | 
+transaction_id = 'transaction_id_example' # String | Gateway transaction identifier as returned in the parameter ipgTransactionId.
+secondary_transaction = OpenapiClient::SecondaryTransaction.new # SecondaryTransaction | Accepted request types: PostAuthTransaction, VoidTransaction, and ReturnTransaction.
 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
+  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 | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
+  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, secondary_transaction, opts)
+  #Perform a secondary transaction.
+  result = api_instance.submit_secondary_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, secondary_transaction, opts)
   p result
 rescue OpenapiClient::ApiError => e
-  puts "Exception when calling PaymentApi->return_transaction: #{e}"
+  puts "Exception when calling PaymentApi->submit_secondary_transaction: #{e}"
 end
 ```
 
@@ -233,15 +168,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**|  | 
+ **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. | 
  **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 | 
- **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] 
- **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] 
+ **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId. | 
+ **secondary_transaction** | [**SecondaryTransaction**](SecondaryTransaction.md)| Accepted request types: PostAuthTransaction, VoidTransaction, and ReturnTransaction. | 
+ **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**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional] 
+ **store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app. | [optional] 
 
 ### Return type
 
@@ -271,15 +206,15 @@ Use this query to get the current state of an existing transaction.
 require 'openapi_client'
 
 api_instance = OpenapiClient::PaymentApi.new
-content_type = 'application/json' # String | content type
+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 | 
+api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
 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
+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
+  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 | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
+  store_id: 'store_id_example' # String | An optional outlet ID for clients that support multiple stores in the same developer app.
 }
 
 begin
@@ -295,75 +230,14 @@ end
 
 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 | 
- **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] 
- **store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app | [optional] 
-
-### Return type
-
-[**TransactionResponse**](TransactionResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **void_transaction**
-> TransactionResponse void_transaction(content_type, client_request_id, api_key, timestamp, transaction_id, opts)
-
-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 '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)
-  p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling PaymentApi->void_transaction: #{e}"
-end
-```
-
-### Parameters
-
-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**|  | 
+ **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. | 
  **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] 
- **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] 
+ **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] 
+ **region** | **String**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional] 
+ **store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app. | [optional] 
 
 ### Return type
 

data/docs/PaymentCard.md

@@ -3,17 +3,14 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**number** | **String** | Payment card number | [optional] 
+**number** | **String** | Payment card number. | 
 **expiry_date** | [**Expiration**](Expiration.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] 
+**security_code** | **String** | Card verification value/number. | [optional] 
+**card_function** | [**CardFunction**](CardFunction.md) |  | [optional] 
+**cardholder_name** | **String** | Name of the cardholder. | [optional] 
+**authentication** | [**Authentication**](Authentication.md) |  | [optional] 
+**bin** | **String** | The payment card BIN. | [optional] 
+**last4** | **String** | The last 4 numbers of a payment card. | [optional] 
+**brand** | **String** | Required only if using dual branded card. | [optional] 
 
 

data/docs/PaymentCardCreditTransaction.md

@@ -0,0 +1,15 @@
+# OpenapiClient::PaymentCardCreditTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_type** | **String** | Object name of the primary transaction request. | 
+**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
+**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
+**transaction_amount** | [**Amount**](Amount.md) |  | 
+**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
+**order** | [**Order**](Order.md) |  | [optional] 
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
+
+

data/docs/PaymentCardForcedTicketTransaction.md

@@ -0,0 +1,15 @@
+# OpenapiClient::PaymentCardForcedTicketTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_type** | **String** | Object name of the primary transaction request. | 
+**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
+**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
+**transaction_amount** | [**Amount**](Amount.md) |  | 
+**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
+**order** | [**Order**](Order.md) |  | [optional] 
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**reference_number** | **String** | Stores the six-digit reference number you have received as the result of a successful external authorization (e.g. by phone). The gateway needs this number for uniquely mapping a ForcedTicket transaction to a previously performed external authorization. | 
+
+

data/docs/PaymentCardPayerAuthTransaction.md

@@ -0,0 +1,15 @@
+# OpenapiClient::PaymentCardPayerAuthTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_type** | **String** | Object name of the primary transaction request. | 
+**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
+**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
+**transaction_amount** | [**Amount**](Amount.md) |  | 
+**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
+**order** | [**Order**](Order.md) |  | [optional] 
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
+
+

data/docs/PaymentCardPaymentMethod.md

@@ -0,0 +1,9 @@
+# OpenapiClient::PaymentCardPaymentMethod
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_card** | [**PaymentCard**](PaymentCard.md) |  | 
+**payment_facilitator** | [**PaymentFacilitator**](PaymentFacilitator.md) |  | [optional] 
+
+

data/docs/PaymentCardPaymentTokenizationRequest.md

@@ -0,0 +1,13 @@
+# OpenapiClient::PaymentCardPaymentTokenizationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_type** | **String** | Object name of tokenization request. | 
+**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
+**billing_address** | [**Address**](Address.md) |  | [optional] 
+**create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | 
+**account_verification** | **BOOLEAN** | If the account should be verified prior to token creation. | [optional] [default to false]
+**payment_card** | [**PaymentCard**](PaymentCard.md) |  | 
+
+

data/docs/PaymentCardPreAuthTransaction.md

@@ -0,0 +1,18 @@
+# OpenapiClient::PaymentCardPreAuthTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_type** | **String** | Object name of the primary transaction request. | 
+**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
+**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
+**transaction_amount** | [**Amount**](Amount.md) |  | 
+**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
+**order** | [**Order**](Order.md) |  | [optional] 
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
+**create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
+**split_shipment** | [**SplitShipment**](SplitShipment.md) |  | [optional] 
+**settlement_split** | [**Array<SubMerchantSplit>**](SubMerchantSplit.md) | Settle with multiple sub-merchants, sale and preAuth only. | [optional] 
+
+

data/docs/PaymentCardSaleTransaction.md

@@ -0,0 +1,18 @@
+# OpenapiClient::PaymentCardSaleTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_type** | **String** | Object name of the primary transaction request. | 
+**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
+**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
+**transaction_amount** | [**Amount**](Amount.md) |  | 
+**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
+**order** | [**Order**](Order.md) |  | [optional] 
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
+**settlement_split** | [**Array<SubMerchantSplit>**](SubMerchantSplit.md) | Settle with multiple sub-merchants, sale and preAuth only. | [optional] 
+**create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
+**currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
+
+

data/docs/PaymentFacilitator.md

@@ -3,10 +3,10 @@
 ## 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 | 
+**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/PaymentMethod.md

@@ -3,12 +3,5 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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/PaymentMethodDetails.md

@@ -0,0 +1,9 @@
+# OpenapiClient::PaymentMethodDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
+**payment_method_type** | [**PaymentMethodType**](PaymentMethodType.md) |  | [optional] 
+
+

data/docs/PaymentMethodPaymentSchedulesRequest.md

@@ -0,0 +1,24 @@
+# OpenapiClient::PaymentMethodPaymentSchedulesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_type** | **String** | Object name of the payment schedules request. | 
+**store_id** | **String** | Store ID number. | [optional] 
+**start_date** | **Date** | Date of mandate signature. | 
+**number_of_payments** | **Integer** | Number of times the recurring payment will process. | [optional] 
+**maximum_failures** | **Integer** | Number of failures that can be encountered before re-tries cease. | [optional] 
+**invoice_number** | **String** | Invoice number. | [optional] 
+**purchase_order_number** | **String** | Purchase order number. | [optional] 
+**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
+**dynamic_merchant_name** | **String** | Dynamic merchant name for the cardholder's statement. | [optional] 
+**frequency** | [**Frequency**](Frequency.md) |  | 
+**transaction_amount** | [**Amount**](Amount.md) |  | 
+**client_locale** | [**ClientLocale**](ClientLocale.md) |  | [optional] 
+**order_id** | **String** | Client order ID if supplied by client. | [optional] 
+**billing** | [**Billing**](Billing.md) |  | [optional] 
+**shipping** | [**Shipping**](Shipping.md) |  | [optional] 
+**comments** | **String** | User supplied comments. | [optional] 
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+
+

data/docs/PaymentMethodType.md

@@ -0,0 +1,7 @@
+# OpenapiClient::PaymentMethodType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/PaymentPayMethod.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **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] 
+**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]