first_data_gateway 1.1.0 → 1.2.0

data/docs/PaymentSchedulesApi.md

@@ -1,13 +1,13 @@
 # OpenapiClient::PaymentSchedulesApi
 
-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
 ------------- | ------------- | -------------
-[**cancel_payment_schedule**](PaymentSchedulesApi.md#cancel_payment_schedule) | **DELETE** /v1/payment-schedules/{order-id} | Cancel a gateway payment schedule.
-[**create_payment_schedule**](PaymentSchedulesApi.md#create_payment_schedule) | **POST** /v1/payment-schedules | Use this to create a gateway payment schedule.
-[**inquiry_payment_schedule**](PaymentSchedulesApi.md#inquiry_payment_schedule) | **GET** /v1/payment-schedules/{order-id} | View a gateway payment schedule.
-[**update_payment_schedule**](PaymentSchedulesApi.md#update_payment_schedule) | **PATCH** /v1/payment-schedules/{order-id} | Update a gateway payment schedule.
+[**cancel_payment_schedule**](PaymentSchedulesApi.md#cancel_payment_schedule) | **DELETE** /payment-schedules/{order-id} | Cancel a gateway payment schedule.
+[**create_payment_schedule**](PaymentSchedulesApi.md#create_payment_schedule) | **POST** /payment-schedules | Create gateway payment schedule.
+[**inquiry_payment_schedule**](PaymentSchedulesApi.md#inquiry_payment_schedule) | **GET** /payment-schedules/{order-id} | View a gateway payment schedule.
+[**update_payment_schedule**](PaymentSchedulesApi.md#update_payment_schedule) | **PATCH** /payment-schedules/{order-id} | Update a gateway payment schedule.
 
 
 # **cancel_payment_schedule**
@@ -23,15 +23,15 @@ Use this to cancel an existing gateway payment schedule.
 require 'openapi_client'
 
 api_instance = OpenapiClient::PaymentSchedulesApi.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).
-order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId
+order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId.
 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
@@ -47,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). | 
- **order_id** | **String**| Gateway order identifier as returned in the parameter orderId | 
- **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] 
+ **order_id** | **String**| Gateway order identifier as returned in the parameter orderId. | 
+ **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
 
@@ -74,9 +74,9 @@ No authorization required
 # **create_payment_schedule**
 > PaymentSchedulesResponse create_payment_schedule(content_type, client_request_id, api_key, timestamp, payment_schedules_request, opts)
 
-Use this to create a gateway payment schedule.
+Create gateway payment schedule.
 
-This can be used to create a gateway payment schedule.
+Use this to create a gateway payment schedule.
 
 ### Example
 ```ruby
@@ -84,18 +84,18 @@ This can be used to create a gateway payment schedule.
 require 'openapi_client'
 
 api_instance = OpenapiClient::PaymentSchedulesApi.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).
-payment_schedules_request = OpenapiClient::PaymentSchedulesRequest.new # PaymentSchedulesRequest | 
+payment_schedules_request = OpenapiClient::PaymentSchedulesRequest.new # PaymentSchedulesRequest | Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest.
 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
-  #Use this to create a gateway payment schedule.
+  #Create gateway payment schedule.
   result = api_instance.create_payment_schedule(content_type, client_request_id, api_key, timestamp, payment_schedules_request, opts)
   p result
 rescue OpenapiClient::ApiError => e
@@ -107,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). | 
- **payment_schedules_request** | [**PaymentSchedulesRequest**](PaymentSchedulesRequest.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] 
+ **payment_schedules_request** | [**PaymentSchedulesRequest**](PaymentSchedulesRequest.md)| Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest. | 
+ **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
 
@@ -135,7 +135,7 @@ No authorization required
 
 View a gateway payment schedule.
 
-This can be used to view an existing gateway payment schedule.
+Use this to view an existing gateway payment schedule.
 
 ### Example
 ```ruby
@@ -143,15 +143,15 @@ This can be used to view an existing gateway payment schedule.
 require 'openapi_client'
 
 api_instance = OpenapiClient::PaymentSchedulesApi.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).
-order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId
+order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId.
 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
@@ -167,14 +167,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). | 
- **order_id** | **String**| Gateway order identifier as returned in the parameter orderId | 
- **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] 
+ **order_id** | **String**| Gateway order identifier as returned in the parameter orderId. | 
+ **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
 
@@ -196,7 +196,7 @@ No authorization required
 
 Update a gateway payment schedule.
 
-This can be used to update a gateway payment schedule.
+Use this to update a gateway payment schedule.
 
 ### Example
 ```ruby
@@ -204,16 +204,16 @@ This can be used to update a gateway payment schedule.
 require 'openapi_client'
 
 api_instance = OpenapiClient::PaymentSchedulesApi.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).
-order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId
-payment_schedules_request = OpenapiClient::PaymentSchedulesRequest.new # PaymentSchedulesRequest | 
+order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId.
+payment_schedules_request = OpenapiClient::PaymentSchedulesRequest.new # PaymentSchedulesRequest | Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest.
 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
@@ -229,15 +229,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). | 
- **order_id** | **String**| Gateway order identifier as returned in the parameter orderId | 
- **payment_schedules_request** | [**PaymentSchedulesRequest**](PaymentSchedulesRequest.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] 
+ **order_id** | **String**| Gateway order identifier as returned in the parameter orderId. | 
+ **payment_schedules_request** | [**PaymentSchedulesRequest**](PaymentSchedulesRequest.md)| Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest. | 
+ **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/PaymentSchedulesErrorResponse.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
 **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
-**response_type** | [**ResponseType**](ResponseType.md) |  | 
+**response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
 **request_status** | **String** | Result of requested operation. If it's anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details. | [optional] 
 **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
 **transaction_response** | [**TransactionResponse**](TransactionResponse.md) |  | [optional] 

data/docs/PaymentSchedulesRequest.md

@@ -3,18 +3,17 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**request_type** | **String** | Object name of the payment schedules request. | 
 **store_id** | **String** | Store ID number. | [optional] 
-**referenced_order_id** | **String** | Order ID used to create recurring payment from existing transaction. | [optional] 
-**start_date** | **Date** | Date of mandate signature. | [optional] 
-**number_of_payments** | **Integer** | Number of times the recurring pament will process. | [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) |  | [optional] 
-**payment_method** | [**PaymentMethod**](PaymentMethod.md) |  | [optional] 
-**amount** | [**Amount**](Amount.md) |  | [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] 

data/docs/PaymentSchedulesResponse.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
 **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
-**response_type** | [**ResponseType**](ResponseType.md) |  | 
+**response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
 **request_status** | **String** | Result of requested operation. If it's anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details. | [optional] 
 **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
 **transaction_response** | [**TransactionResponse**](TransactionResponse.md) |  | [optional] 

data/docs/PaymentTokenApi.md

@@ -1,11 +1,11 @@
 # OpenapiClient::PaymentTokenApi
 
-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
 ------------- | ------------- | -------------
-[**create_payment_token**](PaymentTokenApi.md#create_payment_token) | **POST** /v1/payment-tokens | Create a payment token from a payment card.
-[**delete_payment_token**](PaymentTokenApi.md#delete_payment_token) | **DELETE** /v1/payment-tokens/{token-id} | Delete a payment token.
+[**create_payment_token**](PaymentTokenApi.md#create_payment_token) | **POST** /payment-tokens | Create a payment token from a payment card.
+[**delete_payment_token**](PaymentTokenApi.md#delete_payment_token) | **DELETE** /payment-tokens/{token-id} | Delete a payment token.
 
 
 # **create_payment_token**
@@ -21,15 +21,15 @@ Use this to create a payment token from a payment card.
 require 'openapi_client'
 
 api_instance = OpenapiClient::PaymentTokenApi.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).
-payment_tokenization_request = OpenapiClient::PaymentTokenizationRequest.new # PaymentTokenizationRequest | 
+payment_tokenization_request = OpenapiClient::PaymentTokenizationRequest.new # PaymentTokenizationRequest | Accepted request types: PaymentCardPaymentTokenizationRequest and ReferencedOrderPaymentTokenizationRequest.
 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.
+  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.
   authorization: 'authorization_example', # String | The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'.
-  region: 'region_example' # String | The region where client wants to process the transaction
+  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
@@ -45,14 +45,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). | 
- **payment_tokenization_request** | [**PaymentTokenizationRequest**](PaymentTokenizationRequest.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] 
+ **payment_tokenization_request** | [**PaymentTokenizationRequest**](PaymentTokenizationRequest.md)| Accepted request types: PaymentCardPaymentTokenizationRequest and ReferencedOrderPaymentTokenizationRequest. | 
+ **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] 
  **authorization** | **String**| The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'. | [optional] 
- **region** | **String**| The region where client wants to process the transaction | [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
 
@@ -82,15 +82,15 @@ Use this to delete a payment token.
 require 'openapi_client'
 
 api_instance = OpenapiClient::PaymentTokenApi.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).
-token_id = 'token_id_example' # String | Identifies a payment token
+token_id = 'token_id_example' # String | Identifies a payment token.
 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.
+  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.
   authorization: 'authorization_example', # String | The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'.
-  region: 'region_example', # String | The region where client wants to process the transaction
+  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 | 
 }
 
@@ -107,14 +107,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). | 
- **token_id** | **String**| Identifies a payment token | 
- **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] 
+ **token_id** | **String**| Identifies a payment token. | 
+ **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] 
  **authorization** | **String**| The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'. | [optional] 
- **region** | **String**| The region where client wants to process the transaction | [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**|  | [optional] 
 
 ### Return type

data/docs/PaymentTokenCreditTransaction.md

@@ -0,0 +1,15 @@
+# OpenapiClient::PaymentTokenCreditTransaction
+
+## 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** | [**PaymentTokenPaymentMethod**](PaymentTokenPaymentMethod.md) |  | 
+**currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
+
+

data/docs/PaymentTokenDetails.md

@@ -0,0 +1,14 @@
+# OpenapiClient::PaymentTokenDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | Client-supplied payment token value. Only applicable for DataVault tokenization scheme. | [optional] 
+**reusable** | **BOOLEAN** | If the token is reusable. | [optional] [default to true]
+**decline_duplicates** | **BOOLEAN** | Decline duplicate payment info if client token is supplied. | [optional] [default to false]
+**last4** | **String** | The last 4 numbers of a payment card. | [optional] 
+**brand** | **String** | Card brand, only for tokenization with payment. | [optional] 
+**account_verification** | **BOOLEAN** | If the account the token was created from has been verified. | [optional] 
+**type** | **String** | Inidcates the type of tokenization source. | [optional] 
+
+

data/docs/PaymentTokenPaymentMethod.md

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

data/docs/PaymentTokenPreAuthTransaction.md

@@ -0,0 +1,17 @@
+# OpenapiClient::PaymentTokenPreAuthTransaction
+
+## 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** | [**PaymentTokenPaymentMethod**](PaymentTokenPaymentMethod.md) |  | 
+**stored_credentials** | [**StoredCredential**](StoredCredential.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/PaymentTokenSaleTransaction.md

@@ -0,0 +1,17 @@
+# OpenapiClient::PaymentTokenSaleTransaction
+
+## 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** | [**PaymentTokenPaymentMethod**](PaymentTokenPaymentMethod.md) |  | 
+**stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
+**settlement_split** | [**Array<SubMerchantSplit>**](SubMerchantSplit.md) | Settle with multiple sub-merchants, sale and preAuth only. | [optional] 
+**currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
+
+

data/docs/PaymentTokenizationErrorResponse.md

@@ -4,15 +4,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
-**api_trace_id** | **String** | Echoes back the value in the request header. | [optional] 
-**response_type** | [**ResponseType**](ResponseType.md) |  | 
-**request_status** | **String** | The status of the request | [optional] 
-**request_time** | **String** | Time of the request | [optional] 
+**api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
+**response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
+**request_status** | **String** | The status of the request. | [optional] 
+**request_time** | **Integer** | Time of the request. | [optional] 
 **avs_response** | [**AVSResponse**](AVSResponse.md) |  | [optional] 
-**security_code_response** | **String** | Optional security code check response | [optional] 
-**brand** | **String** | Card brand | [optional] 
-**country** | **String** | Country of the card issued | [optional] 
-**payment_token** | [**PaymentTokenization**](PaymentTokenization.md) |  | [optional] 
+**security_code_response** | **String** | Security code check response. | [optional] 
+**brand** | **String** | Card brand. | [optional] 
+**country** | **String** | Country of the card issued. | [optional] 
+**payment_token** | [**PaymentTokenDetails**](PaymentTokenDetails.md) |  | [optional] 
 **payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 
 

data/docs/PaymentTokenizationRequest.md

@@ -3,9 +3,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | Use this to indicate the type of tokenization source | 
-**payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
-**referenced_order** | [**ReferencedOrder**](ReferencedOrder.md) |  | [optional] 
+**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]
 
 

data/docs/PaymentTokenizationResponse.md

@@ -4,15 +4,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
-**api_trace_id** | **String** | Echoes back the value in the request header. | [optional] 
-**response_type** | [**ResponseType**](ResponseType.md) |  | 
-**request_status** | **String** | The status of the request | [optional] 
-**request_time** | **String** | Time of the request | [optional] 
+**api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
+**response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
+**request_status** | **String** | The status of the request. | [optional] 
+**request_time** | **Integer** | Time of the request. | [optional] 
 **avs_response** | [**AVSResponse**](AVSResponse.md) |  | [optional] 
-**security_code_response** | **String** | Optional security code check response | [optional] 
-**brand** | **String** | Card brand | [optional] 
-**country** | **String** | Country of the card issued | [optional] 
-**payment_token** | [**PaymentTokenization**](PaymentTokenization.md) |  | [optional] 
+**security_code_response** | **String** | Security code check response. | [optional] 
+**brand** | **String** | Card brand. | [optional] 
+**country** | **String** | Country of the card issued. | [optional] 
+**payment_token** | [**PaymentTokenDetails**](PaymentTokenDetails.md) |  | [optional] 
 **payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
 
 

data/docs/PaymentURLApi.md

@@ -1,10 +1,10 @@
 # OpenapiClient::PaymentURLApi
 
-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
 ------------- | ------------- | -------------
-[**create_payment_url**](PaymentURLApi.md#create_payment_url) | **POST** /v1/payment-url | Create a payment URL.
+[**create_payment_url**](PaymentURLApi.md#create_payment_url) | **POST** /payment-url | Create a payment URL.
 
 
 # **create_payment_url**
@@ -20,14 +20,14 @@ Use this to generate an embedding payment link.
 require 'openapi_client'
 
 api_instance = OpenapiClient::PaymentURLApi.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).
-payment_url_request = OpenapiClient::PaymentUrlRequest.new # PaymentUrlRequest | 
+payment_url_request = OpenapiClient::PaymentUrlRequest.new # PaymentUrlRequest | Accepted request type: PaymentUrlRequest.
 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
@@ -43,13 +43,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). | 
- **payment_url_request** | [**PaymentUrlRequest**](PaymentUrlRequest.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] 
+ **payment_url_request** | [**PaymentUrlRequest**](PaymentUrlRequest.md)| Accepted request type: PaymentUrlRequest. | 
+ **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
 

data/docs/PaymentUrlErrorResponse.md

@@ -5,10 +5,10 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
 **api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional] 
-**response_type** | [**ResponseType**](ResponseType.md) |  | 
+**response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
 **request_status** | **String** | Request status. If it is anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details. | [optional] 
-**order_id** | **String** | Client Order ID if supplied by client, otherwise the Order ID. | [optional] 
-**payment_url** | **String** | URL for embedded payment link | [optional] 
+**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**payment_url** | **String** | URL for embedded payment link. | [optional] 
 **transaction_id** | **String** | ID code from the transaction. | [optional] 
 **error** | [**Error**](Error.md) |  | [optional]