first_data_gateway 1.8.0 → 1.12.0

data/docs/Secure3DAuthenticationResultAllOf.md

@@ -0,0 +1,27 @@
+# OpenapiClient::Secure3DAuthenticationResultAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cavv** | **String** | The Cardholder Authentication Verification Value (CAVV) is a cryptographic value derived by the issuer during payment authentication that can provide evidence of the results of payment authentication during an online purchase. | [optional] 
+**xid** | **String** | The transaction identifier (XID) is a unique tracking number set by the merchant. | [optional] 
+**ds_transaction_id** | **String** | The response transaction UUID from the DS (directory server) | [optional] 
+**authentication_response** | **String** | The result of authentication attempt returned by the 3D Secure authentication process (ARes). | [optional] 
+**transaction_status** | **String** | The transaction status as returned by the 3D Secure authentication process. (CRes) | [optional] 
+**message_category** | **String** | Indicates the message category of 3d secure authentication version 2.X. 01 = Payment Authentication 02 = Non-Payment Authentication 80 = Mastercard Data Only  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Secure3DAuthenticationResultAllOf.new(cavv: AAABCZIhcQAAAABZlyFxAAAAAAA,
+                                 xid: MfhxI43NrkuWQYLCoRWitYRDMYo,
+                                 ds_transaction_id: f38e6948-5388-41a6-bca4-b49723c19437,
+                                 authentication_response: A,
+                                 transaction_status: A,
+                                 message_category: 01)
+```
+
+

data/docs/Secure3DAuthenticationUpdateRequest.md

@@ -0,0 +1,19 @@
+# OpenapiClient::Secure3DAuthenticationUpdateRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**method_notification_status** | **String** | Indicates how the merchant received the 3DS method. | [optional] 
+**acs_response** | [**ACSResponse**](ACSResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Secure3DAuthenticationUpdateRequest.new(method_notification_status: RECEIVED,
+                                 acs_response: null)
+```
+
+

data/docs/SepaCredit.md

@@ -0,0 +1,19 @@
+# OpenapiClient::SepaCredit
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**iban** | **String** | Bank account in IBAN format. | 
+**name** | **String** | The name of the Account Holder. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::SepaCredit.new(iban: DE34500100600032121604,
+                                 name: John Doe)
+```
+
+

data/docs/{Borders.md → SepaCreditPaymentMethod.md}

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

data/docs/SepaCreditPaymentMethodAllOf.md

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

data/docs/SepaCreditTransaction.md

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

data/docs/SepaCreditTransactionAllOf.md

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

data/docs/SepaMandate.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **reference** | **String** | Existing mandate reference, managed by merchant. Must match [A-Za-z0-9:?/+(),. -]{1,35} and not start with two slashes (\"//\"). Also known as the mandate ID. | 
-**url** | **String** | Valid URL pointing to the SEPA mandate (PDF / HTML format recommended). | 
+**url** | **String** | Valid URL pointing to the SEPA mandate (PDF / HTML format recommended). When your store is enabled for SEPA Direct Debit as part of the Local Payments offering, this field allows you to transmit a valid URL of SEPA Direct Debit mandate to enable the Risk and Compliance department to access the details. Please note that it is mandatory to submit a mandateReference and a mandateDate together with a mandateUrl in case you manage SEPA Direct Debit mandates on your side in the combination with the Local Payments offering. | [optional] 
 **signature_date** | **Date** | Date of mandate signature. | 
 **type** | **String** | Sequence type of the direct debit. This defaults to 'SINGLE' if not provided. | [default to 'SINGLE']
 

data/docs/{Sepa.md → SepaSale.md}

@@ -1,4 +1,4 @@
-# OpenapiClient::Sepa
+# OpenapiClient::SepaSale
 
 ## Properties
 
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::Sepa.new(iban: DE34500100600032121604,
+instance = OpenapiClient::SepaSale.new(iban: DE34500100600032121604,
                                  name: John Doe,
                                  country: DEU,
                                  email: john.doe@test.com,

data/docs/{Body.md → SepaSalePaymentMethod.md}

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

data/docs/{Content.md → SepaSalePaymentMethodAllOf.md}

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

data/docs/SepaSaleTransaction.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payment_method** | [**SepaPaymentMethod**](SepaPaymentMethod.md) |  | 
+**payment_method** | [**SepaSalePaymentMethod**](SepaSalePaymentMethod.md) |  | 
 
 ## Code Sample
 

data/docs/SepaSaleTransactionAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payment_method** | [**SepaPaymentMethod**](SepaPaymentMethod.md) |  | 
+**payment_method** | [**SepaSalePaymentMethod**](SepaSalePaymentMethod.md) |  | 
 
 ## Code Sample
 

data/docs/StandInDetails.md

@@ -0,0 +1,27 @@
+# OpenapiClient::StandInDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stand_in_type** | **String** | Indicates standin instruction type. | 
+**number_of_debits** | **String** | Indicates number of standin instruction debits.Possible values can be two digit number or UN (Until it is cancelled) or ND (Not defined). | 
+**si_validated** | **Boolean** | Indicates standin instruction validation flag, it can be true or false. \"false\" - Not validated, \"true\" - Validated. | 
+**maximum_transaction_amount** | **Float** | Maximum debit amount per standin instruction transaction. | 
+**si_hub_id** | **String** | Unique identifier for standin instruction. | 
+**frequency** | **String** | Indicates frequency of the standin instruction debit. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StandInDetails.new(stand_in_type: FIXED_AMOUNT,
+                                 number_of_debits: 12,
+                                 si_validated: true,
+                                 maximum_transaction_amount: 1800,
+                                 si_hub_id: Y3PCO6QGHT,
+                                 frequency: MONTHLY)
+```
+
+

data/docs/StandinResponseDetails.md

@@ -0,0 +1,27 @@
+# OpenapiClient::StandinResponseDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**secure3_d_enrolment_status** | **String** | Secure 3D Enrolment Status. | [optional] 
+**secure3_deci** | **String** | Secure 3D ECI. | [optional] 
+**secure3_d_authentication_response** | **String** | Secure 3D Authentication Response. | [optional] 
+**authentication_value** | **String** | Secure 3D Authentication Value. | [optional] 
+**x_id** | **String** | Secure 3D XID. | [optional] 
+**authentication_algorithm** | **String** | Secure 3D Authentication Algorithm. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StandinResponseDetails.new(secure3_d_enrolment_status: Y,
+                                 secure3_deci: 05,
+                                 secure3_d_authentication_response: Y,
+                                 authentication_value: AAABBgFWUQAAAAEzZ1ZRAAAAAAA=,
+                                 x_id: cb8QZ9mmkTUqreE89RjjjAtpJpg,
+                                 authentication_algorithm: 2)
+```
+
+

data/docs/{FontWeight.md → StepRequest.md}

@@ -1,16 +1,17 @@
-# OpenapiClient::FontWeight
+# OpenapiClient::StepRequest
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
 
 ## Code Sample
 
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::FontWeight.new()
+instance = OpenapiClient::StepRequest.new(type: provide-detail)
 ```
 
 

data/docs/{SepaPaymentMethod.md → StepResponse.md}

@@ -1,17 +1,17 @@
-# OpenapiClient::SepaPaymentMethod
+# OpenapiClient::StepResponse
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sepa** | [**Sepa**](Sepa.md) |  | 
+**type** | **String** |  | 
 
 ## Code Sample
 
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::SepaPaymentMethod.new(sepa: null)
+instance = OpenapiClient::StepResponse.new(type: provide-detail)
 ```
 
 

data/docs/TransactionErrorResponse.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] 
 **ipg_transaction_id** | **String** | The response transaction ID. | [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_type** | [**TransactionType**](TransactionType.md) |  | [optional] 
 **payment_token** | [**PaymentTokenDetails**](PaymentTokenDetails.md) |  | [optional] 
 **transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
@@ -21,7 +21,9 @@ Name | Type | Description | Notes
 **approved_amount** | [**Amount**](Amount.md) |  | [optional] 
 **transaction_status** | **String** | Represents the status of a transaction immediately following the original processing request. This value is not stored for the transaction and is only available in the response when the transaction is processed. TransactionStatus is not returned on either the transaction inquiry or on the order inquiry. | [optional] 
 **transaction_state** | **String** | Shows the state of the current transaction. | [optional] 
+**payment_account_reference_number** | **String** | Payment Account Reference Number from response, if supplied. | [optional] 
 **secure3d_response** | [**Secure3dResponse**](Secure3dResponse.md) |  | [optional] 
+**standin_response_details** | [**StandinResponseDetails**](StandinResponseDetails.md) |  | [optional] 
 **redirect_url** | **String** | The endpoint redirection URL. | [optional] 
 **authentication_response** | [**Secure3DAuthenticationResponse**](Secure3DAuthenticationResponse.md) |  | [optional] 
 **scheme_transaction_id** | **String** | The transaction ID received from schemes for the initial transaction of card on file flows. | [optional] 
@@ -30,6 +32,7 @@ Name | Type | Description | Notes
 **account_updater_response** | [**AccountUpdaterResponse**](AccountUpdaterResponse.md) |  | [optional] 
 **ach_response** | [**AchResponse**](AchResponse.md) |  | [optional] 
 **currency_conversion_response** | [**CurrencyConversionResponse**](CurrencyConversionResponse.md) |  | [optional] 
+**steps** | [**Array<PaymentStepRequest>**](PaymentStepRequest.md) | Steps to be performed by the payer. | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 
 
 ## Code Sample
@@ -54,7 +57,9 @@ instance = OpenapiClient::TransactionErrorResponse.new(client_request_id: 30dd87
                                  approved_amount: null,
                                  transaction_status: APPROVED,
                                  transaction_state: AUTHORIZED,
+                                 payment_account_reference_number: 1234001AB101112131415161718CV,
                                  secure3d_response: null,
+                                 standin_response_details: null,
                                  redirect_url: http://pay.issuer-bank.com/sessionID=123&sharedKey=456,
                                  authentication_response: null,
                                  scheme_transaction_id: 019078743804756,
@@ -63,6 +68,7 @@ instance = OpenapiClient::TransactionErrorResponse.new(client_request_id: 30dd87
                                  account_updater_response: null,
                                  ach_response: null,
                                  currency_conversion_response: null,
+                                 steps: null,
                                  error: null)
 ```
 

data/docs/TransactionResponse.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] 
 **ipg_transaction_id** | **String** | The response transaction ID. | [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_type** | [**TransactionType**](TransactionType.md) |  | [optional] 
 **payment_token** | [**PaymentTokenDetails**](PaymentTokenDetails.md) |  | [optional] 
 **transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
@@ -21,7 +21,9 @@ Name | Type | Description | Notes
 **approved_amount** | [**Amount**](Amount.md) |  | [optional] 
 **transaction_status** | **String** | Represents the status of a transaction immediately following the original processing request. This value is not stored for the transaction and is only available in the response when the transaction is processed. TransactionStatus is not returned on either the transaction inquiry or on the order inquiry. | [optional] 
 **transaction_state** | **String** | Shows the state of the current transaction. | [optional] 
+**payment_account_reference_number** | **String** | Payment Account Reference Number from response, if supplied. | [optional] 
 **secure3d_response** | [**Secure3dResponse**](Secure3dResponse.md) |  | [optional] 
+**standin_response_details** | [**StandinResponseDetails**](StandinResponseDetails.md) |  | [optional] 
 **redirect_url** | **String** | The endpoint redirection URL. | [optional] 
 **authentication_response** | [**Secure3DAuthenticationResponse**](Secure3DAuthenticationResponse.md) |  | [optional] 
 **scheme_transaction_id** | **String** | The transaction ID received from schemes for the initial transaction of card on file flows. | [optional] 
@@ -30,6 +32,7 @@ Name | Type | Description | Notes
 **account_updater_response** | [**AccountUpdaterResponse**](AccountUpdaterResponse.md) |  | [optional] 
 **ach_response** | [**AchResponse**](AchResponse.md) |  | [optional] 
 **currency_conversion_response** | [**CurrencyConversionResponse**](CurrencyConversionResponse.md) |  | [optional] 
+**steps** | [**Array<PaymentStepRequest>**](PaymentStepRequest.md) | Steps to be performed by the payer. | [optional] 
 
 ## Code Sample
 
@@ -53,7 +56,9 @@ instance = OpenapiClient::TransactionResponse.new(client_request_id: 30dd879c-ee
                                  approved_amount: null,
                                  transaction_status: APPROVED,
                                  transaction_state: AUTHORIZED,
+                                 payment_account_reference_number: 1234001AB101112131415161718CV,
                                  secure3d_response: null,
+                                 standin_response_details: null,
                                  redirect_url: http://pay.issuer-bank.com/sessionID=123&sharedKey=456,
                                  authentication_response: null,
                                  scheme_transaction_id: 019078743804756,
@@ -61,7 +66,8 @@ instance = OpenapiClient::TransactionResponse.new(client_request_id: 30dd879c-ee
                                  additional_details: null,
                                  account_updater_response: null,
                                  ach_response: null,
-                                 currency_conversion_response: null)
+                                 currency_conversion_response: null,
+                                 steps: null)
 ```
 
 

data/docs/VoidTransaction.md

@@ -4,13 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**transaction_amount** | [**Amount**](Amount.md) |  | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::VoidTransaction.new()
+instance = OpenapiClient::VoidTransaction.new(transaction_amount: null)
 ```