first_data_gateway 1.4.0 → 1.5.0

data/docs/PaymentDeviceDisbursementTransaction.md

@@ -0,0 +1,19 @@
+# OpenapiClient::PaymentDeviceDisbursementTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_method** | [**PaymentDevicePaymentMethod**](PaymentDevicePaymentMethod.md) |  | 
+**disbursement** | [**Disbursement**](Disbursement.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentDeviceDisbursementTransaction.new(payment_method: null,
+                                 disbursement: null)
+```
+
+

data/docs/PaymentDeviceDisbursementTransactionAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::PaymentDeviceDisbursementTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_method** | [**PaymentDevicePaymentMethod**](PaymentDevicePaymentMethod.md) |  | 
+**disbursement** | [**Disbursement**](Disbursement.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentDeviceDisbursementTransactionAllOf.new(payment_method: null,
+                                 disbursement: null)
+```
+
+

data/docs/PaymentDevicePaymentMethod.md

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

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,25 @@
+# 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] 
+
+## 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)
+```
+
+

data/docs/PaymentDevicePreAuthTransactionAllOf.md

@@ -0,0 +1,25 @@
+# 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] 
+
+## 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)
+```
+
+

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/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/PaymentTokenApi.md

@@ -28,7 +28,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 +53,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] 

data/docs/PaymentURLApi.md

@@ -5,6 +5,8 @@ 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** /payment-url | Create a payment URL.
+[**delete_payment_url**](PaymentURLApi.md#delete_payment_url) | **DELETE** /payment-url | Delete a payment URL.
+[**payment_url_detail**](PaymentURLApi.md#payment_url_detail) | **GET** /payment-url | Retrieve the state of payment URL.
 
 
 
@@ -68,3 +70,143 @@ No authorization required
 - **Content-Type**: application/json
 - **Accept**: application/json
 
+
+## delete_payment_url
+
+> PaymentUrlResponse delete_payment_url(content_type, client_request_id, api_key, timestamp, opts)
+
+Delete a payment URL.
+
+Use this to delete 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 | 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).
+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 | 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.
+  transaction_id: 'transaction_id_example', # String | Gateway transaction identifier as returned in the parameter ipgTransactionId.
+  order_id: 'order_id_example', # String | Gateway order identifier as returned in the parameter orderId.
+  payment_url_id: 'payment_url_id_example', # String | The ID code from the payment URL.
+  transaction_time: 'transaction_time_example' # String | The transaction time in seconds since epoch.
+}
+
+begin
+  #Delete a payment URL.
+  result = api_instance.delete_payment_url(content_type, client_request_id, api_key, timestamp, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PaymentURLApi->delete_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**| 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). | 
+ **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] 
+ **transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId. | [optional] 
+ **order_id** | **String**| Gateway order identifier as returned in the parameter orderId. | [optional] 
+ **payment_url_id** | **String**| The ID code from the payment URL. | [optional] 
+ **transaction_time** | **String**| The transaction time in seconds since epoch. | [optional] 
+
+### Return type
+
+[**PaymentUrlResponse**](PaymentUrlResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## payment_url_detail
+
+> PaymentUrlDetailResponse payment_url_detail(content_type, client_request_id, api_key, timestamp, from_date, to_date, opts)
+
+Retrieve the state of payment URL.
+
+Use this query to get the current state of an existing paymentURL.
+
+### 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 | 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).
+from_date = 'from_date_example' # String | The start date for payment URL in seconds since epoch.
+to_date = 'to_date_example' # String | The end date for payment URL search query in seconds since epoch.
+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 | 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.
+  order_id: 'order_id_example', # String | Gateway order identifier as returned in the parameter orderId.
+  merchant_transaction_id: 'merchant_transaction_id_example', # String | Gateway merchant identifier as returned in the parameter merchantTransactionId.
+  status: 'status_example' # String | The status of payment URL.
+}
+
+begin
+  #Retrieve the state of payment URL.
+  result = api_instance.payment_url_detail(content_type, client_request_id, api_key, timestamp, from_date, to_date, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PaymentURLApi->payment_url_detail: #{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). | 
+ **from_date** | **String**| The start date for payment URL in seconds since epoch. | 
+ **to_date** | **String**| The end date for payment URL search query in seconds since epoch. | 
+ **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] 
+ **order_id** | **String**| Gateway order identifier as returned in the parameter orderId. | [optional] 
+ **merchant_transaction_id** | **String**| Gateway merchant identifier as returned in the parameter merchantTransactionId. | [optional] 
+ **status** | **String**| The status of payment URL. | [optional] 
+
+### Return type
+
+[**PaymentUrlDetailResponse**](PaymentUrlDetailResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PaymentUrlDetail.md

@@ -0,0 +1,25 @@
+# OpenapiClient::PaymentUrlDetail
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_url** | **String** | URL for embedded payment link. | [optional] 
+**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request, if supplied. | [optional] 
+**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**request_time** | **Integer** | The transaction time in seconds since epoch. | [optional] 
+**status** | [**PaymentUrlStatus**](PaymentUrlStatus.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentUrlDetail.new(payment_url: https://api.firstdata.com/connect/gateway/processing?storename=123456789&oid=R-96cdbaa4-c22e-4598-a2f1-c2b5fed79ef1&paymentUrlId=d3eb74fe-cf63-47e1-b89f-52ba0cc7965c,
+                                 merchant_transaction_id: lsk23532djljff3,
+                                 order_id: 123456,
+                                 request_time: 1518811817,
+                                 status: null)
+```
+
+