first_data_gateway 1.7.1 → 1.11.0

data/docs/PaymentCardSaleTransactionAllOf.md

@@ -4,7 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_type** | **String** |  | [optional] 
 **payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
 **stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
 **settlement_split** | [**Array<SubMerchantSplit>**](SubMerchantSplit.md) | Settle with multiple sub-merchants, sale and preAuth only. | [optional] 
@@ -18,8 +17,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::PaymentCardSaleTransactionAllOf.new(request_type: null,
-                                 payment_method: null,
+instance = OpenapiClient::PaymentCardSaleTransactionAllOf.new(payment_method: null,
                                  stored_credentials: null,
                                  settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}],
                                  create_token: null,

data/docs/PaymentSchedulesErrorResponse.md

@@ -8,7 +8,7 @@ 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] 
 **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] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **transaction_response** | [**TransactionResponse**](TransactionResponse.md) |  | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 
 

data/docs/PaymentSchedulesRequest.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **frequency** | [**Frequency**](Frequency.md) |  | 
 **transaction_amount** | [**Amount**](Amount.md) |  | 
 **client_locale** | [**ClientLocale**](ClientLocale.md) |  | [optional] 
-**order_id** | **String** | Client order ID if supplied by client. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **billing** | [**Billing**](Billing.md) |  | [optional] 
 **shipping** | [**Shipping**](Shipping.md) |  | [optional] 
 **comments** | **String** | User supplied comments. | [optional] 

data/docs/PaymentSchedulesResponse.md

@@ -8,7 +8,7 @@ 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] 
 **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] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **transaction_response** | [**TransactionResponse**](TransactionResponse.md) |  | [optional] 
 
 ## Code Sample

data/docs/{FontFace.md → PaymentStepRequest.md}

@@ -1,4 +1,4 @@
-# OpenapiClient::FontFace
+# OpenapiClient::PaymentStepRequest
 
 ## Properties
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::FontFace.new()
+instance = OpenapiClient::PaymentStepRequest.new()
 ```
 
 

data/docs/{ConnectMode.md → PaymentStepResponse.md}

@@ -1,4 +1,4 @@
-# OpenapiClient::ConnectMode
+# OpenapiClient::PaymentStepResponse
 
 ## Properties
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::ConnectMode.new()
+instance = OpenapiClient::PaymentStepResponse.new()
 ```
 
 

data/docs/PaymentTokenizationErrorResponse.md

@@ -14,7 +14,9 @@ Name | Type | Description | Notes
 **payment_token** | [**PaymentTokenDetails**](PaymentTokenDetails.md) |  | [optional] 
 **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] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [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,7 @@ 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
@@ -21,6 +22,7 @@ instance = OpenapiClient::PaymentTokenizationRequest.new(request_type: PaymentCa
                                  billing_address: null,
                                  create_token: null,
                                  account_verification: true,
+                                 merchant_transaction_id: lsk23532djljff3,
                                  additional_details: null)
 ```
 

data/docs/PaymentTokenizationResponse.md

@@ -14,7 +14,9 @@ Name | Type | Description | Notes
 **payment_token** | [**PaymentTokenDetails**](PaymentTokenDetails.md) |  | [optional] 
 **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] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [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/PaymentUrlDetail.md

@@ -6,7 +6,7 @@ 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] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **request_time** | **Integer** | The transaction time in seconds since epoch. | [optional] 
 **status** | [**PaymentUrlStatus**](PaymentUrlStatus.md) |  | [optional] 
 

data/docs/PaymentUrlErrorResponse.md

@@ -8,7 +8,7 @@ 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] 
 **request_status** | **String** | Request status. If it is anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details. | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **payment_url** | **String** | URL for embedded payment link. | [optional] 
 **transaction_id** | **String** | ID code from the transaction. | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 

data/docs/PaymentUrlRequest.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **client_locale** | [**ClientLocale**](ClientLocale.md) |  | [optional] 
 **transaction_amount** | [**Amount**](Amount.md) |  | 
 **transaction_type** | [**TransactionType**](TransactionType.md) |  | 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **billing** | [**Billing**](Billing.md) |  | [optional] 
 **shipping** | [**Shipping**](Shipping.md) |  | [optional] 
 **transaction_notification_url** | **String** | URL for notifying merchant of payment result. | [optional] 
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **purchase_order_number** | **String** | Purchase order number. | [optional] 
 **hosted_payment_page_text** | **String** | The text to be displayed to the payer on the hosted payment page. | [optional] 
 **ip** | **String** | IPv4 or IPv6 network address. | [optional] 
+**revolving_options** | [**RevolvingOptions**](RevolvingOptions.md) |  | [optional] 
 
 ## Code Sample
 
@@ -39,7 +40,8 @@ instance = OpenapiClient::PaymentUrlRequest.new(store_id: 12345500000,
                                  invoice_number: 96126098,
                                  purchase_order_number: 123055342,
                                  hosted_payment_page_text: This is a payment for x,
-                                 ip: 264.31.73.24)
+                                 ip: 264.31.73.24,
+                                 revolving_options: null)
 ```
 
 

data/docs/PaymentUrlResponse.md

@@ -8,7 +8,7 @@ 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] 
 **request_status** | **String** | Request status. If it is anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details. | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **payment_url** | **String** | URL for embedded payment link. | [optional] 
 **transaction_id** | **String** | ID code from the transaction. | [optional] 
 

data/docs/PreAuthSecondaryTransaction.md

@@ -0,0 +1,19 @@
+# OpenapiClient::PreAuthSecondaryTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_amount** | [**Amount**](Amount.md) |  | 
+**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::PreAuthSecondaryTransaction.new(transaction_amount: null,
+                                 decremental_flag: false)
+```
+
+

data/docs/PreAuthSecondaryTransactionAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::PreAuthSecondaryTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_amount** | [**Amount**](Amount.md) |  | 
+**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::PreAuthSecondaryTransactionAllOf.new(transaction_amount: null,
+                                 decremental_flag: false)
+```
+
+

data/docs/ProcessorData.md

@@ -11,10 +11,12 @@ Name | Type | Description | Notes
 **association_response_code** | **String** | Raw response code from issuer. | [optional] 
 **response_message** | **String** | Message returned from endpoints. | [optional] 
 **avs_response** | [**AVSResponse**](AVSResponse.md) |  | [optional] 
+**cardholder_info_response** | [**CardholderInfoResponse**](CardholderInfoResponse.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
 
@@ -28,10 +30,12 @@ instance = OpenapiClient::ProcessorData.new(reference_number: 811720726601,
                                  association_response_code: 000,
                                  response_message: Amount specified exceeds allowable limit.,
                                  avs_response: null,
+                                 cardholder_info_response: null,
                                  security_code_response: NOT_MATCHED,
                                  merchant_advice_code_indicator: 01,
                                  response_indicator: 0100,
-                                 debit_receipt_number: 123456)
+                                 debit_receipt_number: 123456,
+                                 transaction_integrity_class: A1)
 ```
 
 

data/docs/ProvideDetailPaymentStepRequest.md

@@ -0,0 +1,25 @@
+# OpenapiClient::ProvideDetailPaymentStepRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**hint** | **String** |  | [optional] 
+**java_script_validation_expression** | **String** |  | [optional] 
+**key** | **String** |  | [optional] 
+**label** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ProvideDetailPaymentStepRequest.new(type: provide-detail,
+                                 hint: null,
+                                 java_script_validation_expression: null,
+                                 key: null,
+                                 label: null)
+```
+
+

data/docs/ProvideDetailPaymentStepRequestAllOf.md

@@ -0,0 +1,23 @@
+# OpenapiClient::ProvideDetailPaymentStepRequestAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hint** | **String** |  | [optional] 
+**java_script_validation_expression** | **String** |  | [optional] 
+**key** | **String** |  | [optional] 
+**label** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ProvideDetailPaymentStepRequestAllOf.new(hint: null,
+                                 java_script_validation_expression: null,
+                                 key: null,
+                                 label: null)
+```
+
+

data/docs/ProvideDetailPaymentStepResponse.md

@@ -0,0 +1,21 @@
+# OpenapiClient::ProvideDetailPaymentStepResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**detail_key** | **String** | MerchantIdentifier of the provided detail. | [optional] 
+**detail_value** | **String** | Value provided by the payer or merchant, validated by JavaScript regular expression | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ProvideDetailPaymentStepResponse.new(type: provide-detail,
+                                 detail_key: BLIK_CODE,
+                                 detail_value: 777712)
+```
+
+

data/docs/ProvideDetailPaymentStepResponseAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ProvideDetailPaymentStepResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail_key** | **String** | MerchantIdentifier of the provided detail. | [optional] 
+**detail_value** | **String** | Value provided by the payer or merchant, validated by JavaScript regular expression | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ProvideDetailPaymentStepResponseAllOf.new(detail_key: BLIK_CODE,
+                                 detail_value: 777712)
+```
+
+

data/docs/PurchaseCardsLevel2.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**customer_reference_id** | **String** | Customer code/customer reference ID. | [optional] 
+**customer_reference_id** | **String** | Customer code/customer reference ID. The max length supported for Visa is 12 and MasterCard is 17. | [optional] 
 **supplier_invoice_number** | **String** | Purchase identifier/merchant-related data. | [optional] 
 **supplier_vat_registration_number** | **String** | Merchant VAT registration/single business reference number/merchant tax ID or corporation VAT number. | [optional] 
 **total_discount_amount_and_rate** | [**AdditionalAmountRate**](AdditionalAmountRate.md) |  | [optional] 

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<ReceiptLine>**](ReceiptLine.md) | 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: [{"endOfLine":true,"text":"          MerchantName          "},{"endOfLine":true,"text":"--------------------------------"}])
+```
+
+

data/docs/ReceiptLine.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ReceiptLine
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**end_of_line** | **Boolean** | Flag to indicate if the text ends at the end of this receipt line. | [optional] [default to true]
+**text** | **String** | Text that represents a line of the actual receipt data, that can be printed out. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ReceiptLine.new(end_of_line: true,
+                                 text:           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

@@ -7,7 +7,7 @@ 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] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
+**order_id** | **String** | Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM). | [optional] 
 **billing** | [**Billing**](Billing.md) |  | [optional] 
 **shipping** | [**Shipping**](Shipping.md) |  | [optional] 
 **transactions** | [**Array<TransactionResponse>**](TransactionResponse.md) | Required for some payment methods (for example, Klarna). | [optional]