first_data_gateway 1.3.0 → 1.7.1

data/docs/PaymentDevicePaymentMethodAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::PaymentDevicePaymentMethodAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_device** | [**PaymentDevice**](PaymentDevice.md) |  | 
+**payment_facilitator** | [**PaymentFacilitator**](PaymentFacilitator.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentDevicePaymentMethodAllOf.new(payment_device: null,
+                                 payment_facilitator: null)
+```
+
+

data/docs/PaymentDevicePaymentTokenizationRequest.md

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

data/docs/PaymentDevicePaymentTokenizationRequestAllOf.md

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

data/docs/PaymentDevicePreAuthTransaction.md

@@ -0,0 +1,27 @@
+# OpenapiClient::PaymentDevicePreAuthTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_method** | [**PaymentDevicePaymentMethod**](PaymentDevicePaymentMethod.md) |  | 
+**create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
+**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
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentDevicePreAuthTransaction.new(payment_method: null,
+                                 create_token: null,
+                                 settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}],
+                                 stored_credentials: null,
+                                 split_shipment: null,
+                                 decremental_flag: false)
+```
+
+

data/docs/PaymentDevicePreAuthTransactionAllOf.md

@@ -0,0 +1,27 @@
+# OpenapiClient::PaymentDevicePreAuthTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_method** | [**PaymentDevicePaymentMethod**](PaymentDevicePaymentMethod.md) |  | 
+**create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
+**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
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentDevicePreAuthTransactionAllOf.new(payment_method: null,
+                                 create_token: null,
+                                 settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}],
+                                 stored_credentials: null,
+                                 split_shipment: null,
+                                 decremental_flag: false)
+```
+
+

data/docs/PaymentDeviceSaleTransaction.md

@@ -0,0 +1,21 @@
+# OpenapiClient::PaymentDeviceSaleTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_method** | [**PaymentDevicePaymentMethod**](PaymentDevicePaymentMethod.md) |  | 
+**create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
+**stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentDeviceSaleTransaction.new(payment_method: null,
+                                 create_token: null,
+                                 stored_credentials: null)
+```
+
+

data/docs/PaymentDeviceSaleTransactionAllOf.md

@@ -0,0 +1,21 @@
+# OpenapiClient::PaymentDeviceSaleTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_method** | [**PaymentDevicePaymentMethod**](PaymentDevicePaymentMethod.md) |  | 
+**create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
+**stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentDeviceSaleTransactionAllOf.new(payment_method: null,
+                                 create_token: null,
+                                 stored_credentials: null)
+```
+
+

data/docs/PaymentRegistration.md

@@ -0,0 +1,39 @@
+# OpenapiClient::PaymentRegistration
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**merchant_ref** | **String** | Merchant reference code. Used by FirstAPI and reflected in settlement records and webhook notifications. Typically, the merchantRef field is the purchase order number or unique sequence value associated to a given transaction. | [optional] 
+**transaction_type** | **String** | Type of transaction merchant wants to process. | 
+**customer** | [**Customer**](Customer.md) |  | 
+**merchant** | [**Merchant**](Merchant.md) |  | 
+**device** | [**FraudRegistrationDevice**](FraudRegistrationDevice.md) |  | [optional] 
+**user_defined** | [**Object**](.md) | A JSON object that can carry any additional information that might be helpful for fraud detection. | [optional] 
+**original_transaction_type** | **String** | Defines the type of the original transaction that is being evaluated for the Fraud Score. | 
+**issuer_response** | [**IssuerResponse**](IssuerResponse.md) |  | [optional] 
+**verification_avs** | [**VerificationAvs**](VerificationAvs.md) |  | [optional] 
+**verification3ds** | [**Verification3ds**](Verification3ds.md) |  | [optional] 
+**verification_cvv** | [**VerificationCvv**](VerificationCvv.md) |  | [optional] 
+**registration_method** | [**RegistrationMethod**](RegistrationMethod.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentRegistration.new(merchant_ref: ffd031516002,
+                                 transaction_type: registration,
+                                 customer: null,
+                                 merchant: null,
+                                 device: null,
+                                 user_defined: {"inauthTransId":"1234"},
+                                 original_transaction_type: registration/method/card,
+                                 issuer_response: null,
+                                 verification_avs: null,
+                                 verification3ds: null,
+                                 verification_cvv: null,
+                                 registration_method: null)
+```
+
+

data/docs/PaymentRegistrationAllOf.md

@@ -0,0 +1,27 @@
+# OpenapiClient::PaymentRegistrationAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**original_transaction_type** | **String** | Defines the type of the original transaction that is being evaluated for the Fraud Score. | [optional] 
+**issuer_response** | [**IssuerResponse**](IssuerResponse.md) |  | [optional] 
+**verification_avs** | [**VerificationAvs**](VerificationAvs.md) |  | [optional] 
+**verification3ds** | [**Verification3ds**](Verification3ds.md) |  | [optional] 
+**verification_cvv** | [**VerificationCvv**](VerificationCvv.md) |  | [optional] 
+**registration_method** | [**RegistrationMethod**](RegistrationMethod.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentRegistrationAllOf.new(original_transaction_type: registration/method/card,
+                                 issuer_response: null,
+                                 verification_avs: null,
+                                 verification3ds: null,
+                                 verification_cvv: null,
+                                 registration_method: null)
+```
+
+

data/docs/PaymentSchedulesRequest.md

@@ -28,7 +28,7 @@ require 'OpenapiClient'
 
 instance = OpenapiClient::PaymentSchedulesRequest.new(request_type: PaymentMethodPaymentSchedulesRequest,
                                  store_id: 1109959991,
-                                 start_date: null,
+                                 start_date: Wed Oct 24 19:00:00 CDT 2018,
                                  number_of_payments: 10,
                                  maximum_failures: 1,
                                  invoice_number: 96126098,

data/docs/PaymentSchedulesResponseAllOf.md

@@ -0,0 +1,21 @@
+# OpenapiClient::PaymentSchedulesResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentSchedulesResponseAllOf.new(request_status: SUCCESS,
+                                 order_id: 123456,
+                                 transaction_response: null)
+```
+
+

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.
 
 
 
@@ -28,7 +30,7 @@ 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_tokenization_request = OpenapiClient::PaymentTokenizationRequest.new # PaymentTokenizationRequest | Accepted request types: PaymentCardPaymentTokenizationRequest and ReferencedOrderPaymentTokenizationRequest.
+payment_tokenization_request = OpenapiClient::PaymentTokenizationRequest.new # PaymentTokenizationRequest | Accepted request types: PaymentCardPaymentTokenizationRequest, PaymentDevicePaymentTokenizationRequest, 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.
   authorization: 'authorization_example', # String | The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'.
@@ -53,7 +55,7 @@ Name | Type | Description  | Notes
  **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_tokenization_request** | [**PaymentTokenizationRequest**](PaymentTokenizationRequest.md)| Accepted request types: PaymentCardPaymentTokenizationRequest and ReferencedOrderPaymentTokenizationRequest. | 
+ **payment_tokenization_request** | [**PaymentTokenizationRequest**](PaymentTokenizationRequest.md)| Accepted request types: PaymentCardPaymentTokenizationRequest, PaymentDevicePaymentTokenizationRequest, 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**| 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] 
@@ -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)
+```
+
+