first_data_gateway 1.0.3 → 1.1.0

data/docs/PaymentSchedulesApi.md

@@ -0,0 +1,256 @@
+# OpenapiClient::PaymentSchedulesApi
+
+All URIs are relative to *https://cert.api.firstdata.com/gateway*
+
+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**
+> PaymentSchedulesResponse cancel_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, opts)
+
+Cancel a gateway payment schedule.
+
+Use this to cancel an existing gateway payment schedule.
+
+### Example
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentSchedulesApi.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).
+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
+}
+
+begin
+  #Cancel a gateway payment schedule.
+  result = api_instance.cancel_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PaymentSchedulesApi->cancel_payment_schedule: #{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). | 
+ **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] 
+
+### Return type
+
+[**PaymentSchedulesResponse**](PaymentSchedulesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **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.
+
+This can be used to create a gateway payment schedule.
+
+### Example
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentSchedulesApi.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).
+payment_schedules_request = OpenapiClient::PaymentSchedulesRequest.new # PaymentSchedulesRequest | 
+opts = {
+  message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256  algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
+  region: 'region_example' # String | The region where client wants to process the transaction
+}
+
+begin
+  #Use this to create a 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
+  puts "Exception when calling PaymentSchedulesApi->create_payment_schedule: #{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). | 
+ **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] 
+
+### Return type
+
+[**PaymentSchedulesResponse**](PaymentSchedulesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **inquiry_payment_schedule**
+> RecurringPaymentDetailsResponse inquiry_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, opts)
+
+View a gateway payment schedule.
+
+This can be used to view an existing gateway payment schedule.
+
+### Example
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentSchedulesApi.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).
+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
+}
+
+begin
+  #View a gateway payment schedule.
+  result = api_instance.inquiry_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PaymentSchedulesApi->inquiry_payment_schedule: #{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). | 
+ **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] 
+
+### Return type
+
+[**RecurringPaymentDetailsResponse**](RecurringPaymentDetailsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_payment_schedule**
+> PaymentSchedulesResponse update_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, payment_schedules_request, opts)
+
+Update a gateway payment schedule.
+
+This can be used to update a gateway payment schedule.
+
+### Example
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentSchedulesApi.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).
+order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId
+payment_schedules_request = OpenapiClient::PaymentSchedulesRequest.new # PaymentSchedulesRequest | 
+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
+  #Update a gateway payment schedule.
+  result = api_instance.update_payment_schedule(content_type, client_request_id, api_key, timestamp, order_id, payment_schedules_request, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PaymentSchedulesApi->update_payment_schedule: #{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). | 
+ **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] 
+
+### Return type
+
+[**PaymentSchedulesResponse**](PaymentSchedulesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/PaymentSchedulesErrorResponse.md

@@ -0,0 +1,14 @@
+# OpenapiClient::PaymentSchedulesErrorResponse
+
+## Properties
+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) |  | 
+**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] 
+**error** | [**Error**](Error.md) |  | [optional] 
+
+

data/docs/PaymentSchedulesRequest.md

@@ -1,21 +1,24 @@
-# SwaggerClient::PaymentSchedulesRequest
+# OpenapiClient::PaymentSchedulesRequest
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **store_id** | **String** | Store ID number. | [optional] 
-**reference_order_id** | **String** | Order ID used to create recurring payment from existing transaction. | [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 payment will process. | [optional] 
+**number_of_payments** | **Integer** | Number of times the recurring pament will process. | [optional] 
 **maximum_failures** | **Integer** | Number of failures that can be encountered before re-tries cease. | [optional] 
 **invoice_number** | **String** | Invoice number. | [optional] 
-**po_number** | **String** | Purchase order number. | [optional] 
-**transaction_origin** | **String** | The source of the transaction. The possible values are ECI (if the order was received via email or Internet), MOTO (mail order / telephone order) and RETAIL (face to face). | [optional] 
-**dynamic_merchant_name** | **String** | Dynamic merchant name for the cardholder‘s statement. | [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] 
 **client_locale** | [**ClientLocale**](ClientLocale.md) |  | [optional] 
-**order_id** | **String** | Client Order ID if supplied by client. | [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] 
 
 

data/docs/PaymentSchedulesResponse.md

@@ -1,11 +1,13 @@
-# SwaggerClient::PaymentSchedulesResponse
+# OpenapiClient::PaymentSchedulesResponse
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**client_request_id** | **String** | Echoes back the value in the Request header for tracking. | 
-**api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support. | 
-**transaction_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. | 
-**order_id** | **String** | Client Order ID if supplied by client, otherwise the Order ID. | [optional] 
+**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) |  | 
+**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

@@ -0,0 +1,134 @@
+# OpenapiClient::PaymentTokenApi
+
+All URIs are relative to *https://cert.api.firstdata.com/gateway*
+
+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**
+> PaymentTokenizationResponse create_payment_token(content_type, client_request_id, api_key, timestamp, payment_tokenization_request, opts)
+
+Create a payment token from a payment card.
+
+Use this to create a payment token from a payment card.
+
+### Example
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentTokenApi.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).
+payment_tokenization_request = OpenapiClient::PaymentTokenizationRequest.new # PaymentTokenizationRequest | 
+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.
+  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
+}
+
+begin
+  #Create a payment token from a payment card.
+  result = api_instance.create_payment_token(content_type, client_request_id, api_key, timestamp, payment_tokenization_request, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PaymentTokenApi->create_payment_token: #{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). | 
+ **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] 
+ **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] 
+
+### Return type
+
+[**PaymentTokenizationResponse**](PaymentTokenizationResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_payment_token**
+> PaymentTokenizationResponse delete_payment_token(content_type, client_request_id, api_key, timestamp, token_id, opts)
+
+Delete a payment token.
+
+Use this to delete a payment token.
+
+### Example
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentTokenApi.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).
+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.
+  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
+  store_id: 'store_id_example' # String | 
+}
+
+begin
+  #Delete a payment token.
+  result = api_instance.delete_payment_token(content_type, client_request_id, api_key, timestamp, token_id, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PaymentTokenApi->delete_payment_token: #{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). | 
+ **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] 
+ **store_id** | **String**|  | [optional] 
+
+### Return type
+
+[**PaymentTokenizationResponse**](PaymentTokenizationResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/PaymentTokenization.md

@@ -0,0 +1,16 @@
+# OpenapiClient::PaymentTokenization
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**value** | **String** | Client supplied Payment Token value | [optional] 
+**reusable** | **BOOLEAN** | One time or reusable token | [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 payment card numbers | [optional] 
+**brand** | **String** | Only for tokenization with payment | [optional] 
+**country** | **String** | Only for tokenization with payment | [optional] 
+**account_verification** | **BOOLEAN** |  | [optional] [default to false]
+**security_code** | **String** | Card Verification Value/Number | [optional] 
+
+

data/docs/PaymentTokenizationErrorResponse.md

@@ -0,0 +1,19 @@
+# OpenapiClient::PaymentTokenizationErrorResponse
+
+## Properties
+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] 
+**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] 
+**payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
+**error** | [**Error**](Error.md) |  | [optional] 
+
+

data/docs/PaymentTokenizationRequest.md

@@ -0,0 +1,11 @@
+# OpenapiClient::PaymentTokenizationRequest
+
+## 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] 
+**billing_address** | [**Address**](Address.md) |  | [optional] 
+
+

data/docs/PaymentTokenizationResponse.md

@@ -0,0 +1,18 @@
+# OpenapiClient::PaymentTokenizationResponse
+
+## Properties
+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] 
+**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] 
+**payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
+
+

data/docs/PaymentURLApi.md

@@ -0,0 +1,68 @@
+# OpenapiClient::PaymentURLApi
+
+All URIs are relative to *https://cert.api.firstdata.com/gateway*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_payment_url**](PaymentURLApi.md#create_payment_url) | **POST** /v1/payment-url | Create a payment URL.
+
+
+# **create_payment_url**
+> PaymentUrlResponse create_payment_url(content_type, client_request_id, api_key, timestamp, payment_url_request, opts)
+
+Create a payment URL.
+
+Use this to generate an embedding payment link.
+
+### Example
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::PaymentURLApi.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).
+payment_url_request = OpenapiClient::PaymentUrlRequest.new # 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
+}
+
+begin
+  #Create a payment URL.
+  result = api_instance.create_payment_url(content_type, client_request_id, api_key, timestamp, payment_url_request, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PaymentURLApi->create_payment_url: #{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). | 
+ **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] 
+
+### Return type
+
+[**PaymentUrlResponse**](PaymentUrlResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/PaymentUrlErrorResponse.md

@@ -0,0 +1,15 @@
+# OpenapiClient::PaymentUrlErrorResponse
+
+## Properties
+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) |  | 
+**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] 
+**transaction_id** | **String** | ID code from the transaction. | [optional] 
+**error** | [**Error**](Error.md) |  | [optional] 
+
+

data/docs/PaymentUrlRequest.md

@@ -1,11 +1,21 @@
-# SwaggerClient::PaymentUrlRequest
+# OpenapiClient::PaymentUrlRequest
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**store_id** | **String** | An optional outlet id for clients that support multiple store in the same developer app. | 
+**store_id** | **String** | An optional Outlet ID for clients that support multiple stores in the same developer app. | [optional] 
 **client_locale** | [**ClientLocale**](ClientLocale.md) |  | [optional] 
 **amount** | [**Amount**](Amount.md) |  | 
-**order_id** | **String** | Client Order ID if supplied by client, otherwise the Order ID. | 
+**transaction_type** | [**TransactionType**](TransactionType.md) |  | 
+**order_id** | **String** | Client Order ID if supplied by client, otherwise the Order ID. | [optional] 
+**billing** | [**Billing**](Billing.md) |  | [optional] 
+**shipping** | [**Shipping**](Shipping.md) |  | [optional] 
+**transaction_notification_url** | **String** | URL for notifying merchant with payment result. | [optional] 
+**expiration** | **Integer** | Time until payment URL expires. | [optional] 
+**authenticate_transaction** | **BOOLEAN** | If 3D secure should be applied. | [optional] 
+**dynamic_merchant_name** | **String** | Dynamic merchant name for the cardholder's statement. | [optional] 
+**invoice_number** | **String** | Invoice number. | [optional] 
+**purchase_order_number** | **String** | Purchase order number. | [optional] 
+**ip** | **String** | IPv4 or IPv6 network address. | [optional]