first_data_gateway 1.4.0 → 1.8.0

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)
 ```
 
 

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 or merchantTransactionId.
+  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 or merchantTransactionId. | [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)
+```
+
+

data/docs/PaymentUrlDetailResponse.md

@@ -0,0 +1,23 @@
+# OpenapiClient::PaymentUrlDetailResponse
+
+## 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] 
+**payment_url_details** | [**Array<PaymentUrlDetail>**](PaymentUrlDetail.md) | Array of payment URL details. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentUrlDetailResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 payment_url_details: null)
+```
+
+

data/docs/PaymentUrlRequest.md

@@ -33,7 +33,7 @@ instance = OpenapiClient::PaymentUrlRequest.new(store_id: 12345500000,
                                  billing: null,
                                  shipping: null,
                                  transaction_notification_url: https://showmethepaymentresult.com,
-                                 expiration: 1518811817,
+                                 expiration: 4102358400,
                                  authenticate_transaction: true,
                                  dynamic_merchant_name: MyWebsite,
                                  invoice_number: 96126098,

data/docs/PaymentUrlStatus.md

@@ -0,0 +1,16 @@
+# OpenapiClient::PaymentUrlStatus
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentUrlStatus.new()
+```
+
+

data/docs/{CustomerAddressPhone.md → Phone.md}

@@ -1,4 +1,4 @@
-# OpenapiClient::CustomerAddressPhone
+# OpenapiClient::Phone
 
 ## Properties
 
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::CustomerAddressPhone.new(type: mobile,
+instance = OpenapiClient::Phone.new(type: mobile,
                                  number: 212-515-1212)
 ```
 

data/docs/Primary.md

@@ -0,0 +1,17 @@
+# OpenapiClient::Primary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**color** | **String** | Hexadecimal color value. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Primary.new(color: #FFEE00)
+```
+
+

data/docs/ProcessorData.md

@@ -13,6 +13,9 @@ Name | Type | Description | Notes
 **avs_response** | [**AVSResponse**](AVSResponse.md) |  | [optional] 
 **security_code_response** | **String** | Code returned for CVV. | [optional] 
 **merchant_advice_code_indicator** | **String** | Code to map merchant advice code to ISO specification. | [optional] 
+**response_indicator** | **String** | Indicates whether the transaction was routed through the payment card's own network or through a different network. | [optional] 
+**debit_receipt_number** | **String** | Receipt number from debit network provider. | [optional] 
+**transaction_integrity_class** | **String** | MasterCard provided Transaction Integrity Class for Point of Sale (POS) Purchase and Purchase with Cash Back transactions initiated on the Authorization Platform. | [optional] 
 
 ## Code Sample
 
@@ -27,7 +30,10 @@ instance = OpenapiClient::ProcessorData.new(reference_number: 811720726601,
                                  response_message: Amount specified exceeds allowable limit.,
                                  avs_response: null,
                                  security_code_response: NOT_MATCHED,
-                                 merchant_advice_code_indicator: 01)
+                                 merchant_advice_code_indicator: 01,
+                                 response_indicator: 0100,
+                                 debit_receipt_number: 123456,
+                                 transaction_integrity_class: A1)
 ```
 
 

data/docs/Properties.md

@@ -0,0 +1,25 @@
+# OpenapiClient::Properties
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**font_face** | [**FontFace**](FontFace.md) |  | [optional] 
+**font_size** | **String** | Font size property. | [optional] 
+**font_weight** | [**FontWeight**](FontWeight.md) |  | [optional] 
+**font_color** | **String** | Hexadecimal color value. | [optional] 
+**color** | **String** | Hexadecimal color value. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Properties.new(font_face: null,
+                                 font_size: xx-small,
+                                 font_weight: null,
+                                 font_color: #FFEE00,
+                                 color: #FFEE00)
+```
+
+

data/docs/PurchaseCardsLevel3.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**line_items** | [**Array<PurchaseCardsLevel3LineItems>**](PurchaseCardsLevel3LineItems.md) | Line items. | 
+**line_items** | [**Array<PurchaseCardsLevel3LineItems>**](PurchaseCardsLevel3LineItems.md) | Line items of monitoring and controlling corporate expenditures data. | 
 
 ## Code Sample
 

data/docs/Receipt.md

@@ -0,0 +1,19 @@
+# OpenapiClient::Receipt
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Defines the consumer of the receipt (e.g. cardholder, merchant). | 
+**data** | **Array<String>** | Array of formatted lines that represents the actual receipt data, that can be printed out. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Receipt.new(type: merchant,
+                                 data: ["          MerchantName          ","--------------------------------"])
+```
+
+

data/docs/ReceiptRequestInfo.md

@@ -0,0 +1,21 @@
+# OpenapiClient::ReceiptRequestInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Defines the consumer of the receipt (e.g. cardholder, merchant). | 
+**locale** | **String** | The locale of the receipt. The format has to be a well-formed BCP 47 language tag. | [optional] 
+**linewidth** | **Integer** | The line width of the receipt. Default will be 32 characters. | [optional] [default to 32]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ReceiptRequestInfo.new(type: merchant,
+                                 locale: en-GB,
+                                 linewidth: 48)
+```
+
+

data/docs/RecurringPaymentDetailsResponse.md

@@ -8,12 +8,10 @@ Name | Type | Description | Notes
 **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] 
 **order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
-**transaction_time** | **Integer** | The transaction time in seconds since epoch. | [optional] 
 **billing** | [**Billing**](Billing.md) |  | [optional] 
 **shipping** | [**Shipping**](Shipping.md) |  | [optional] 
-**mandate** | [**SepaMandate**](SepaMandate.md) |  | [optional] 
-**transactions** | [**Array<Transaction>**](Transaction.md) | Required for some payment methods (for example, Klarna). | [optional] 
-**processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
+**transactions** | [**Array<TransactionResponse>**](TransactionResponse.md) | Required for some payment methods (for example, Klarna). | [optional] 
+**additional_details** | [**AdditionalDetails**](AdditionalDetails.md) |  | [optional] 
 **recurring_payment_details** | [**RecurringPaymentDetails**](RecurringPaymentDetails.md) |  | [optional] 
 
 ## Code Sample
@@ -25,12 +23,10 @@ instance = OpenapiClient::RecurringPaymentDetailsResponse.new(client_request_id:
                                  api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
                                  response_type: null,
                                  order_id: 123456,
-                                 transaction_time: 1518811817,
                                  billing: null,
                                  shipping: null,
-                                 mandate: null,
                                  transactions: [{"transactionState":"AUTHORIZED","ipgTransactionId":"838916029301","transactionType":"SALE","transactionAmount":{"total":10.24,"currency":"USD"},"storeId":"1109959991"}],
-                                 processor: null,
+                                 additional_details: null,
                                  recurring_payment_details: null)
 ```
 

data/docs/RegistrationMethod.md

@@ -0,0 +1,29 @@
+# OpenapiClient::RegistrationMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**method_type** | **String** | Unique ID for the payment method type. | 
+**method_id** | **String** | The unique ID of this payment method if it was previously registered with a registration/method or if it is currently being registered. Must be unique for the entire system (not just within a specific merchant or industry). Mandatory if being used inside a registration/method. | [optional] 
+**user_defined** | [**Object**](.md) | A JSON object that carries any additional information that might be helpful for fraud detection. | [optional] 
+**billing_phone_number** | **String** | The address that should be used to send billing information for this payment method. | [optional] 
+**method_alias** | **String** | The address that should be used to send billing information for this payment method. | [optional] 
+**card** | [**FraudRegistrationCard**](FraudRegistrationCard.md) |  | 
+**method_address** | [**FraudAddress**](FraudAddress.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RegistrationMethod.new(method_type: method/card,
+                                 method_id: 300fa792-bf5f-418e-aa74-d5b3c81298d2,
+                                 user_defined: {"failedPinAttempts":3},
+                                 billing_phone_number: 123456789,
+                                 method_alias: card one,
+                                 card: null,
+                                 method_address: null)
+```
+
+

data/docs/RemoveFraudBlockedItemsResponse.md

@@ -0,0 +1,23 @@
+# OpenapiClient::RemoveFraudBlockedItemsResponse
+
+## 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] 
+**status** | **String** | Status from delete fraud blocked items operation. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RemoveFraudBlockedItemsResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 status: SUCCESS. Fraud settings was updated successfully.)
+```
+
+