first_data_gateway 1.5.0 → 1.8.1

data/docs/PaymentURLApi.md

@@ -94,7 +94,7 @@ 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.
+  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.
@@ -121,7 +121,7 @@ Name | Type | Description  | Notes
  **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] 
+ **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] 

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/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

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **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
 
@@ -31,7 +32,8 @@ instance = OpenapiClient::ProcessorData.new(reference_number: 811720726601,
                                  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/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/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/ResponseAmountComponents.md

@@ -19,8 +19,8 @@ require 'OpenapiClient'
 
 instance = OpenapiClient::ResponseAmountComponents.new(subtotal: 8.0,
                                  vat_amount: 0,
-                                 local_tax: 1.3,
-                                 shipping: 1.0,
+                                 local_tax: 1.0,
+                                 shipping: 1.24,
                                  cashback: 2.0,
                                  tip: 6.0,
                                  convenience_fee: 2.0)

data/docs/ScoreOnlyResponse.md

@@ -4,24 +4,22 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**api_trace_id** | **String** | Unique trace ID for issue triage. | [optional] 
+**correlation_id** | **String** | Unique trace ID for issue triage. | [optional] 
 **transaction_status** | **String** | Please refer to \"Errors Section\" for more info. | [optional] 
 **validation_status** | **String** | If status returned is \"failure\", input validation errors occurred. Please refer to the \"Errors Section\" for more info. Valid values are 'success' and 'failure'. | [optional] 
 **transaction_type** | **String** | The transactionType provided in request. | [optional] 
 **fraud_score** | [**ScoreOnlyResponseFraudScore**](ScoreOnlyResponseFraudScore.md) |  | [optional] 
-**recommended_decision** | **String** | The action that should be taken for the request that was sent. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::ScoreOnlyResponse.new(api_trace_id: 968a1915-210c-4157-a456-98e4773a1124,
+instance = OpenapiClient::ScoreOnlyResponse.new(correlation_id: 228.9404979051319,
                                  transaction_status: Not Processed,
                                  validation_status: success,
                                  transaction_type: transaction/authorization,
-                                 fraud_score: null,
-                                 recommended_decision: accept)
+                                 fraud_score: null)
 ```
 
 

data/docs/ScoreOnlyResponseFraudScore.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **score** | **String** | The score attributed to this request by our machine learning system, ranging from 0 (less likely to be fraud) to 1000 (more likely to be fraud). | [optional] 
 **warnings** | **Array<String>** | A list of non-critical warnings raised while processing the request. Warnings included in this list will have integration and data-quality related messages. | [optional] 
 **explanations** | [**Array<ScoreOnlyResponseFraudScoreExplanations>**](ScoreOnlyResponseFraudScoreExplanations.md) | Explanation of the fraud score applied consisting of a description, type of the explanation, and rule (if applicable). | [optional] 
+**recommended_decision** | **String** | The action that should be taken for the request that was sent. | [optional] 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'OpenapiClient'
 
 instance = OpenapiClient::ScoreOnlyResponseFraudScore.new(score: 1000,
                                  warnings: ["warning1","warning2"],
-                                 explanations: [{"description":"Suspicious transaction amount.","type":"explanation/model"},{"description":"Suspicious pattern compared to number of transactions in the past 1 month for the card.","type":"explanation/rule","rule":"QSR_14"}])
+                                 explanations: [{"description":"Suspicious transaction amount.","type":"explanation/model"},{"description":"Suspicious pattern compared to number of transactions in the past 1 month for the card.","type":"explanation/rule","rule":"QSR_14"}],
+                                 recommended_decision: accept)
 ```
 
 

data/docs/SecondaryTransaction.md

@@ -6,7 +6,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **request_type** | **String** | Object name of the secondary transaction request. | 
 **store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same developer app. | [optional] 
+**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request, if supplied. | [optional] 
 **comments** | **String** | Comment for the secondary transaction. | [optional] 
+**order** | [**Order**](Order.md) |  | [optional] 
 
 ## Code Sample
 
@@ -15,7 +17,9 @@ require 'OpenapiClient'
 
 instance = OpenapiClient::SecondaryTransaction.new(request_type: PostAuthTransaction,
                                  store_id: 12345500000,
-                                 comments: This is a comment)
+                                 merchant_transaction_id: lsk23532djljff3,
+                                 comments: This is a comment,
+                                 order: null)
 ```
 
 

data/docs/Secure3D10AuthenticationRequest.md

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

data/docs/{Secure3dAuthenticationVerificationRequest.md → Secure3D10AuthenticationUpdateRequest.md}

@@ -1,4 +1,4 @@
-# OpenapiClient::Secure3dAuthenticationVerificationRequest
+# OpenapiClient::Secure3D10AuthenticationUpdateRequest
 
 ## Properties
 
@@ -6,14 +6,16 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payer_authentication_response** | **String** | A formatted message providing results of the issuer’s cardholder authentication. | 
 **merchant_data** | **String** | Formatted string encoding transaction time, order ID, and return URL data. | 
+**security_code** | **String** | Card security code if required by merchant. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::Secure3dAuthenticationVerificationRequest.new(payer_authentication_response: eJzVWFm....9f/AhjgEcE=,
-                                 merchant_data: MD__________30002019....85bcd02599)
+instance = OpenapiClient::Secure3D10AuthenticationUpdateRequest.new(payer_authentication_response: eJzVWFm....9f/AhjgEcE=,
+                                 merchant_data: MD__________30002019....85bcd02599,
+                                 security_code: 123)
 ```
 
 

data/docs/{Secure3dAuthenticationVerificationRequestAllOf.md → Secure3D10AuthenticationUpdateRequestAllOf.md}

@@ -1,4 +1,4 @@
-# OpenapiClient::Secure3dAuthenticationVerificationRequestAllOf
+# OpenapiClient::Secure3D10AuthenticationUpdateRequestAllOf
 
 ## Properties
 
@@ -6,14 +6,16 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payer_authentication_response** | **String** | A formatted message providing results of the issuer’s cardholder authentication. | 
 **merchant_data** | **String** | Formatted string encoding transaction time, order ID, and return URL data. | 
+**security_code** | **String** | Card security code if required by merchant. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'OpenapiClient'
 
-instance = OpenapiClient::Secure3dAuthenticationVerificationRequestAllOf.new(payer_authentication_response: eJzVWFm....9f/AhjgEcE=,
-                                 merchant_data: MD__________30002019....85bcd02599)
+instance = OpenapiClient::Secure3D10AuthenticationUpdateRequestAllOf.new(payer_authentication_response: eJzVWFm....9f/AhjgEcE=,
+                                 merchant_data: MD__________30002019....85bcd02599,
+                                 security_code: 123)
 ```
 
 

data/docs/Secure3D21AuthenticationRequest.md

@@ -0,0 +1,23 @@
+# OpenapiClient::Secure3D21AuthenticationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**term_url** | **String** | The result of the authentication will be sent to this URL. If not provided, a term URL will be dynamically generated. Note this must be a valid URL (special characters should be URL-encoded). | [optional] 
+**method_notification_url** | **String** | The 3DS method iframe and transaction ID will be sent here. Note this must be a valid URL (special characters should be URL-encoded). | [optional] 
+**challenge_indicator** | **String** | Indicates whether or not a challenge should be performed. 01 = No preference (You have no preference whether a challenge should be performed. This is the default value) 02 = No challenge requested (You prefer that no challenge should be performed) 03 = Challenge requested: 3DS Requestor Preference (You prefer that a challenge should be performed) 04 = Challenge requested: Mandate (There are local or regional mandates that mean that a challenge must be performed)  | [optional] [default to '01']
+**challenge_window_size** | **String** | Defines the size of the challenge window displayed to customers during authentication. 01 = 250 x 400 02 = 390 x 400 03 = 500 x 600 04 = 600 x 400 05 = Full screen  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Secure3D21AuthenticationRequest.new(term_url: https://www.mywebshop.com/process3dSecure,
+                                 method_notification_url: https://www.mywebshop.com/process3dSecureMethodNotification?transactionReferenceNumber=ffffffff-ba0b-539f-8000-016b2343ad7e,
+                                 challenge_indicator: 01,
+                                 challenge_window_size: 01)
+```
+
+

data/docs/Secure3D21AuthenticationRequestAllOf.md

@@ -0,0 +1,23 @@
+# OpenapiClient::Secure3D21AuthenticationRequestAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**term_url** | **String** | The result of the authentication will be sent to this URL. If not provided, a term URL will be dynamically generated. Note this must be a valid URL (special characters should be URL-encoded). | [optional] 
+**method_notification_url** | **String** | The 3DS method iframe and transaction ID will be sent here. Note this must be a valid URL (special characters should be URL-encoded). | [optional] 
+**challenge_indicator** | **String** | Indicates whether or not a challenge should be performed. 01 = No preference (You have no preference whether a challenge should be performed. This is the default value) 02 = No challenge requested (You prefer that no challenge should be performed) 03 = Challenge requested: 3DS Requestor Preference (You prefer that a challenge should be performed) 04 = Challenge requested: Mandate (There are local or regional mandates that mean that a challenge must be performed)  | [optional] [default to '01']
+**challenge_window_size** | **String** | Defines the size of the challenge window displayed to customers during authentication. 01 = 250 x 400 02 = 390 x 400 03 = 500 x 600 04 = 600 x 400 05 = Full screen  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Secure3D21AuthenticationRequestAllOf.new(term_url: https://www.mywebshop.com/process3dSecure,
+                                 method_notification_url: https://www.mywebshop.com/process3dSecureMethodNotification?transactionReferenceNumber=ffffffff-ba0b-539f-8000-016b2343ad7e,
+                                 challenge_indicator: 01,
+                                 challenge_window_size: 01)
+```
+
+

data/docs/Secure3D21AuthenticationResult.md

@@ -6,8 +6,8 @@ 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] 
-**transaction_id** | **String** | The response transaction ID. Only applicable to MasterCard. | [optional] 
-**authentication_response** | **String** | The result of authentication attempt returned by the 3D Secure authentication process (PaRes). | [optional] 
+**transaction_id** | **String** | The response transaction UUID. Only applicable to MasterCard. | [optional] 
+**authentication_response** | **String** | The result of authentication attempt returned by the 3D Secure authentication process (PaRes). | [optional] [default to 'Y']
 **transaction_status** | **String** | The transaction status as returned by the 3D Secure authentication process. | [optional] 
 
 ## Code Sample

data/docs/Secure3D21AuthenticationResultAllOf.md

@@ -6,8 +6,8 @@ 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] 
-**transaction_id** | **String** | The response transaction ID. Only applicable to MasterCard. | [optional] 
-**authentication_response** | **String** | The result of authentication attempt returned by the 3D Secure authentication process (PaRes). | [optional] 
+**transaction_id** | **String** | The response transaction UUID. Only applicable to MasterCard. | [optional] 
+**authentication_response** | **String** | The result of authentication attempt returned by the 3D Secure authentication process (PaRes). | [optional] [default to 'Y']
 **transaction_status** | **String** | The transaction status as returned by the 3D Secure authentication process. | [optional] 
 
 ## Code Sample

data/docs/Secure3D21AuthenticationUpdateRequest.md

@@ -0,0 +1,19 @@
+# OpenapiClient::Secure3D21AuthenticationUpdateRequest
+
+## 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::Secure3D21AuthenticationUpdateRequest.new(method_notification_status: RECEIVED,
+                                 acs_response: null)
+```
+
+

data/docs/Secure3D21AuthenticationUpdateRequestAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::Secure3D21AuthenticationUpdateRequestAllOf
+
+## 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::Secure3D21AuthenticationUpdateRequestAllOf.new(method_notification_status: RECEIVED,
+                                 acs_response: null)
+```
+
+

data/docs/Secure3DAuthenticationResponse.md

@@ -0,0 +1,23 @@
+# OpenapiClient::Secure3DAuthenticationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of authentication. | [optional] 
+**version** | **String** | The version of 3DS used to authenticate. | [optional] 
+**params** | [**Secure3DAuthenticationResponseParams**](Secure3DAuthenticationResponseParams.md) |  | [optional] 
+**secure3d_method** | [**Secure3DAuthenticationResponseSecure3dMethod**](Secure3DAuthenticationResponseSecure3dMethod.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Secure3DAuthenticationResponse.new(type: 3D_SECURE,
+                                 version: 2.1,
+                                 params: null,
+                                 secure3d_method: null)
+```
+
+

data/docs/Secure3DAuthenticationResponseParams.md

@@ -0,0 +1,27 @@
+# OpenapiClient::Secure3DAuthenticationResponseParams
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payer_authentication_request** | **String** | Message sent from merchant server to authenticate the cardholder. | [optional] 
+**term_url** | **String** | Terminal URL for processing request. | [optional] 
+**merchant_data** | **String** | Formatted string encoding transaction time, order ID, and return URL data. | [optional] 
+**acs_url** | **String** | The URL for the authentication redirect for the merchant. | [optional] 
+**c_req** | **String** | The CReq message initiates cardholder interaction in a 3DS 2.x challenge flow and carries authentication data from the cardholder. | [optional] 
+**session_data** | **String** | Customer web browser session data. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Secure3DAuthenticationResponseParams.new(payer_authentication_request: c7fb83b8ag...73t4a827t4af8738a,
+                                 term_url: https://api.example.com/redirectToAcs,
+                                 merchant_data: MD123...sdfk,
+                                 acs_url: https://3ds-acs.test.modirum.com/mdpayacs/pareq,
+                                 c_req: ewogICAiYWNzVHJhbnNJRCIgOiAiMDAwMDAwMDAtMDAwNS01YTVhLTgwMDAtMDE2ZmE1NTYzODMyIiwKICAgImNoYWxsZW5nZVdpbmRvd1NpemUiIDogIjAzIiwKICAgIm1lc3NhZ2VUeXBlIiA6ICJDUmVxIiwKICAgIm1lc3NhZ2VWZXJzaW9uIiA6ICIyLjEuMCIsCiAgICJ0aHJlZURTU2VydmVyVHJhbnNJRCIgOiAiZGVmOWZiZDgtZjkzNS01YzcyLTgwMDAtMDAwMDAwMDgyOWVkIgp9,
+                                 session_data: 50F2156E03083CA665BCB4..)
+```
+
+