first_data_gateway 1.5.0 → 1.8.1

data/docs/PaymentCardVerificationRequest.md

@@ -0,0 +1,17 @@
+# OpenapiClient::PaymentCardVerificationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_card** | [**PaymentCard**](PaymentCard.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardVerificationRequest.new(payment_card: null)
+```
+
+

data/docs/PaymentCardVerificationRequestAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::PaymentCardVerificationRequestAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_card** | [**PaymentCard**](PaymentCard.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardVerificationRequestAllOf.new(payment_card: null)
+```
+
+

data/docs/PaymentDevicePreAuthTransaction.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **settlement_split** | [**Array<SubMerchantSplit>**](SubMerchantSplit.md) | Settle with multiple sub-merchants, sale and preAuth only. | [optional] 
 **stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
 **split_shipment** | [**SplitShipment**](SplitShipment.md) |  | [optional] 
+**decremental_flag** | **Boolean** | This flag can only be used in a preAuth transaction that updates the amount of a previous preAuth transaction to either increase the preAuth amount (DecrementalPreAuthFlag = false) or decrease the preAuth amount (DecrementalPreAuthFlag = true). | [optional] [default to false]
 
 ## Code Sample
 
@@ -19,7 +20,8 @@ instance = OpenapiClient::PaymentDevicePreAuthTransaction.new(payment_method: nu
                                  create_token: null,
                                  settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}],
                                  stored_credentials: null,
-                                 split_shipment: null)
+                                 split_shipment: null,
+                                 decremental_flag: false)
 ```
 
 

data/docs/PaymentDevicePreAuthTransactionAllOf.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **settlement_split** | [**Array<SubMerchantSplit>**](SubMerchantSplit.md) | Settle with multiple sub-merchants, sale and preAuth only. | [optional] 
 **stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
 **split_shipment** | [**SplitShipment**](SplitShipment.md) |  | [optional] 
+**decremental_flag** | **Boolean** | This flag can only be used in a preAuth transaction that updates the amount of a previous preAuth transaction to either increase the preAuth amount (DecrementalPreAuthFlag = false) or decrease the preAuth amount (DecrementalPreAuthFlag = true). | [optional] [default to false]
 
 ## Code Sample
 
@@ -19,7 +20,8 @@ instance = OpenapiClient::PaymentDevicePreAuthTransactionAllOf.new(payment_metho
                                  create_token: null,
                                  settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}],
                                  stored_credentials: null,
-                                 split_shipment: null)
+                                 split_shipment: null,
+                                 decremental_flag: false)
 ```
 
 

data/docs/PaymentTokenApi.md

@@ -6,6 +6,8 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**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.
+[**get_payment_token_details**](PaymentTokenApi.md#get_payment_token_details) | **GET** /payment-tokens/{token-id} | Get payment card details associated with token.
+[**update_payment_token**](PaymentTokenApi.md#update_payment_token) | **PATCH** /payment-tokens | Update one or more payment tokens.
 
 
 
@@ -136,3 +138,131 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## get_payment_token_details
+
+> PaymentTokenizationResponse get_payment_token_details(content_type, client_request_id, api_key, timestamp, token_id, opts)
+
+Get payment card details associated with token.
+
+Get payment card details associated with 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 | 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.
+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 | 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 | 
+}
+
+begin
+  #Get payment card details associated with token.
+  result = api_instance.get_payment_token_details(content_type, client_request_id, api_key, timestamp, token_id, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PaymentTokenApi->get_payment_token_details: #{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**| 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] 
+ **authorization** | **String**| The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'. | [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
+
+[**PaymentTokenizationResponse**](PaymentTokenizationResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_payment_token
+
+> PaymentTokenUpdateResponse update_payment_token(content_type, client_request_id, api_key, timestamp, payment_card_payment_token_update_request, opts)
+
+Update one or more payment tokens.
+
+Use this update one or more payment tokens.
+
+### 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 | 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_card_payment_token_update_request = OpenapiClient::PaymentCardPaymentTokenUpdateRequest.new # PaymentCardPaymentTokenUpdateRequest | Accepted request type: PaymentCardPaymentTokenUpdateRequest.
+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 | 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 one or more payment tokens.
+  result = api_instance.update_payment_token(content_type, client_request_id, api_key, timestamp, payment_card_payment_token_update_request, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PaymentTokenApi->update_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**| 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_card_payment_token_update_request** | [**PaymentCardPaymentTokenUpdateRequest**](PaymentCardPaymentTokenUpdateRequest.md)| Accepted request type: PaymentCardPaymentTokenUpdateRequest. | 
+ **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**| 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
+
+[**PaymentTokenUpdateResponse**](PaymentTokenUpdateResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PaymentTokenInfoLookupRequest.md

@@ -0,0 +1,17 @@
+# OpenapiClient::PaymentTokenInfoLookupRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_token** | [**UsePaymentToken**](UsePaymentToken.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentTokenInfoLookupRequest.new(payment_token: null)
+```
+
+

data/docs/PaymentTokenInfoLookupRequestAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::PaymentTokenInfoLookupRequestAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_token** | [**UsePaymentToken**](UsePaymentToken.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentTokenInfoLookupRequestAllOf.new(payment_token: null)
+```
+
+

data/docs/PaymentTokenPreAuthTransaction.md

@@ -8,6 +8,9 @@ Name | Type | Description | Notes
 **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] 
+**authentication_request** | [**AuthenticationRequest**](AuthenticationRequest.md) |  | [optional] 
+**authentication_result** | [**AuthenticationResult**](AuthenticationResult.md) |  | [optional] 
+**decremental_flag** | **Boolean** | This flag can only be used in a preAuth transaction that updates the amount of a previous preAuth transaction to either increase the preAuth amount (DecrementalPreAuthFlag = false) or decrease the preAuth amount (DecrementalPreAuthFlag = true). | [optional] [default to false]
 
 ## Code Sample
 
@@ -17,7 +20,10 @@ require 'OpenapiClient'
 instance = OpenapiClient::PaymentTokenPreAuthTransaction.new(payment_method: null,
                                  stored_credentials: null,
                                  split_shipment: null,
-                                 settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}])
+                                 settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}],
+                                 authentication_request: null,
+                                 authentication_result: null,
+                                 decremental_flag: false)
 ```
 
 

data/docs/PaymentTokenPreAuthTransactionAllOf.md

@@ -8,6 +8,9 @@ Name | Type | Description | Notes
 **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] 
+**authentication_request** | [**AuthenticationRequest**](AuthenticationRequest.md) |  | [optional] 
+**authentication_result** | [**AuthenticationResult**](AuthenticationResult.md) |  | [optional] 
+**decremental_flag** | **Boolean** | This flag can only be used in a preAuth transaction that updates the amount of a previous preAuth transaction to either increase the preAuth amount (DecrementalPreAuthFlag = false) or decrease the preAuth amount (DecrementalPreAuthFlag = true). | [optional] [default to false]
 
 ## Code Sample
 
@@ -17,7 +20,10 @@ require 'OpenapiClient'
 instance = OpenapiClient::PaymentTokenPreAuthTransactionAllOf.new(payment_method: null,
                                  stored_credentials: null,
                                  split_shipment: null,
-                                 settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}])
+                                 settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}],
+                                 authentication_request: null,
+                                 authentication_result: null,
+                                 decremental_flag: false)
 ```
 
 

data/docs/PaymentTokenSaleTransaction.md

@@ -8,6 +8,8 @@ Name | Type | Description | Notes
 **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] 
+**authentication_request** | [**AuthenticationRequest**](AuthenticationRequest.md) |  | [optional] 
+**authentication_result** | [**AuthenticationResult**](AuthenticationResult.md) |  | [optional] 
 
 ## Code Sample
 
@@ -17,7 +19,9 @@ require 'OpenapiClient'
 instance = OpenapiClient::PaymentTokenSaleTransaction.new(payment_method: null,
                                  stored_credentials: null,
                                  settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}],
-                                 currency_conversion: null)
+                                 currency_conversion: null,
+                                 authentication_request: null,
+                                 authentication_result: null)
 ```
 
 

data/docs/PaymentTokenSaleTransactionAllOf.md

@@ -8,6 +8,8 @@ Name | Type | Description | Notes
 **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] 
+**authentication_request** | [**AuthenticationRequest**](AuthenticationRequest.md) |  | [optional] 
+**authentication_result** | [**AuthenticationResult**](AuthenticationResult.md) |  | [optional] 
 
 ## Code Sample
 
@@ -17,7 +19,9 @@ require 'OpenapiClient'
 instance = OpenapiClient::PaymentTokenSaleTransactionAllOf.new(payment_method: null,
                                  stored_credentials: null,
                                  settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}],
-                                 currency_conversion: null)
+                                 currency_conversion: null,
+                                 authentication_request: null,
+                                 authentication_result: null)
 ```
 
 

data/docs/PaymentTokenUpdateResponse.md

@@ -0,0 +1,27 @@
+# OpenapiClient::PaymentTokenUpdateResponse
+
+## 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) |  | [optional] 
+**request_status** | **String** | The status of the request. | [optional] 
+**request_time** | **Integer** | Time of the request. | [optional] 
+**errors** | [**Array<Error>**](Error.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentTokenUpdateResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 request_status: APPROVED,
+                                 request_time: 1554308829345,
+                                 errors: null)
+```
+
+

data/docs/PaymentTokenVerificationRequest.md

@@ -0,0 +1,17 @@
+# OpenapiClient::PaymentTokenVerificationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_token** | [**UsePaymentToken**](UsePaymentToken.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentTokenVerificationRequest.new(payment_token: null)
+```
+
+

data/docs/PaymentTokenVerificationRequestAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::PaymentTokenVerificationRequestAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_token** | [**UsePaymentToken**](UsePaymentToken.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentTokenVerificationRequestAllOf.new(payment_token: null)
+```
+
+

data/docs/PaymentTokenizationErrorResponse.md

@@ -15,6 +15,8 @@ Name | Type | Description | Notes
 **payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
 **processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
 **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**ipg_transaction_id** | **String** | The response transaction ID. | [optional] 
+**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 
 
 ## Code Sample
@@ -33,6 +35,8 @@ instance = OpenapiClient::PaymentTokenizationErrorResponse.new(client_request_id
                                  payment_card: null,
                                  processor: null,
                                  order_id: R-44df6542-ae0b-4415-88e8-7f3e62cc9e5d,
+                                 ipg_transaction_id: 838916029301,
+                                 merchant_transaction_id: lsk23532djljff3,
                                  error: null)
 ```
 

data/docs/PaymentTokenizationRequest.md

@@ -9,6 +9,8 @@ Name | Type | Description | Notes
 **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]
+**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request, if supplied. | [optional] 
+**additional_details** | [**AdditionalDetails**](AdditionalDetails.md) |  | [optional] 
 
 ## Code Sample
 
@@ -19,7 +21,9 @@ instance = OpenapiClient::PaymentTokenizationRequest.new(request_type: PaymentCa
                                  store_id: 12345500000,
                                  billing_address: null,
                                  create_token: null,
-                                 account_verification: true)
+                                 account_verification: true,
+                                 merchant_transaction_id: lsk23532djljff3,
+                                 additional_details: null)
 ```
 
 

data/docs/PaymentTokenizationResponse.md

@@ -15,6 +15,8 @@ Name | Type | Description | Notes
 **payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
 **processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
 **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**ipg_transaction_id** | **String** | The response transaction ID. | [optional] 
+**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
 
 ## Code Sample
 
@@ -31,7 +33,9 @@ instance = OpenapiClient::PaymentTokenizationResponse.new(client_request_id: 30d
                                  payment_token: null,
                                  payment_card: null,
                                  processor: null,
-                                 order_id: R-44df6542-ae0b-4415-88e8-7f3e62cc9e5d)
+                                 order_id: R-44df6542-ae0b-4415-88e8-7f3e62cc9e5d,
+                                 ipg_transaction_id: 838916029301,
+                                 merchant_transaction_id: lsk23532djljff3)
 ```