first_data_gateway 1.2.0 → 1.3.0

data/docs/PaymentCardCreditTransaction.md

@@ -1,15 +1,19 @@
 # OpenapiClient::PaymentCardCreditTransaction
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_type** | **String** | Object name of the primary transaction request. | 
-**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
-**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
-**transaction_amount** | [**Amount**](Amount.md) |  | 
-**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
-**order** | [**Order**](Order.md) |  | [optional] 
 **payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
 **currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardCreditTransaction.new(payment_method: null,
+                                 currency_conversion: null)
+```
+
 

data/docs/PaymentCardDisbursementTransaction.md

@@ -0,0 +1,23 @@
+# OpenapiClient::PaymentCardDisbursementTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**disbursement** | [**Disbursement**](Disbursement.md) |  | 
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
+**create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardDisbursementTransaction.new(disbursement: null,
+                                 payment_method: null,
+                                 stored_credentials: null,
+                                 create_token: null)
+```
+
+

data/docs/PaymentCardDisbursementTransactionAllOf.md

@@ -0,0 +1,23 @@
+# OpenapiClient::PaymentCardDisbursementTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**disbursement** | [**Disbursement**](Disbursement.md) |  | 
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
+**create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardDisbursementTransactionAllOf.new(disbursement: null,
+                                 payment_method: null,
+                                 stored_credentials: null,
+                                 create_token: null)
+```
+
+

data/docs/PaymentCardForcedTicketTransaction.md

@@ -1,15 +1,19 @@
 # OpenapiClient::PaymentCardForcedTicketTransaction
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_type** | **String** | Object name of the primary transaction request. | 
-**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
-**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
-**transaction_amount** | [**Amount**](Amount.md) |  | 
-**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
-**order** | [**Order**](Order.md) |  | [optional] 
 **payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
 **reference_number** | **String** | Stores the six-digit reference number you have received as the result of a successful external authorization (e.g. by phone). The gateway needs this number for uniquely mapping a ForcedTicket transaction to a previously performed external authorization. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardForcedTicketTransaction.new(payment_method: null,
+                                 reference_number: 123455)
+```
+
 

data/docs/PaymentCardForcedTicketTransactionAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::PaymentCardForcedTicketTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**reference_number** | **String** | Stores the six-digit reference number you have received as the result of a successful external authorization (e.g. by phone). The gateway needs this number for uniquely mapping a ForcedTicket transaction to a previously performed external authorization. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardForcedTicketTransactionAllOf.new(payment_method: null,
+                                 reference_number: 123455)
+```
+
+

data/docs/PaymentCardPayerAuthTransaction.md

@@ -1,15 +1,19 @@
 # OpenapiClient::PaymentCardPayerAuthTransaction
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_type** | **String** | Object name of the primary transaction request. | 
-**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
-**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
-**transaction_amount** | [**Amount**](Amount.md) |  | 
-**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
-**order** | [**Order**](Order.md) |  | [optional] 
 **payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
 **currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardPayerAuthTransaction.new(payment_method: null,
+                                 currency_conversion: null)
+```
+
 

data/docs/PaymentCardPayerAuthTransactionAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::PaymentCardPayerAuthTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardPayerAuthTransactionAllOf.new(payment_method: null,
+                                 currency_conversion: null)
+```
+
+

data/docs/PaymentCardPaymentMethod.md

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

data/docs/PaymentCardPaymentMethodAllOf.md

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

data/docs/PaymentCardPaymentTokenizationRequest.md

@@ -1,13 +1,17 @@
 # OpenapiClient::PaymentCardPaymentTokenizationRequest
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_type** | **String** | Object name of tokenization request. | 
-**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
-**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]
 **payment_card** | [**PaymentCard**](PaymentCard.md) |  | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardPaymentTokenizationRequest.new(payment_card: null)
+```
+
 

data/docs/PaymentCardPaymentTokenizationRequestAllOf.md

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

data/docs/PaymentCardPreAuthTransaction.md

@@ -1,18 +1,25 @@
 # OpenapiClient::PaymentCardPreAuthTransaction
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_type** | **String** | Object name of the primary transaction request. | 
-**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
-**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
-**transaction_amount** | [**Amount**](Amount.md) |  | 
-**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
-**order** | [**Order**](Order.md) |  | [optional] 
 **payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
 **stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
 **create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
 **split_shipment** | [**SplitShipment**](SplitShipment.md) |  | [optional] 
 **settlement_split** | [**Array<SubMerchantSplit>**](SubMerchantSplit.md) | Settle with multiple sub-merchants, sale and preAuth only. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardPreAuthTransaction.new(payment_method: null,
+                                 stored_credentials: null,
+                                 create_token: null,
+                                 split_shipment: null,
+                                 settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}])
+```
+
 

data/docs/PaymentCardPreAuthTransactionAllOf.md

@@ -0,0 +1,25 @@
+# OpenapiClient::PaymentCardPreAuthTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
+**stored_credentials** | [**StoredCredential**](StoredCredential.md) |  | [optional] 
+**create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
+**split_shipment** | [**SplitShipment**](SplitShipment.md) |  | [optional] 
+**settlement_split** | [**Array<SubMerchantSplit>**](SubMerchantSplit.md) | Settle with multiple sub-merchants, sale and preAuth only. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardPreAuthTransactionAllOf.new(payment_method: null,
+                                 stored_credentials: null,
+                                 create_token: null,
+                                 split_shipment: null,
+                                 settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}])
+```
+
+

data/docs/PaymentCardSaleTransaction.md

@@ -1,18 +1,25 @@
 # OpenapiClient::PaymentCardSaleTransaction
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_type** | **String** | Object name of the primary transaction request. | 
-**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
-**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
-**transaction_amount** | [**Amount**](Amount.md) |  | 
-**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
-**order** | [**Order**](Order.md) |  | [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] 
 **create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
 **currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentCardSaleTransaction.new(payment_method: null,
+                                 stored_credentials: null,
+                                 settlement_split: [{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}],
+                                 create_token: null,
+                                 currency_conversion: null)
+```
+
 

data/docs/PaymentCardSaleTransactionAllOf.md

@@ -0,0 +1,25 @@
+# OpenapiClient::PaymentCardSaleTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**create_token** | [**CreatePaymentToken**](CreatePaymentToken.md) |  | [optional] 
+**currency_conversion** | [**CurrencyConversion**](CurrencyConversion.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+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,
+                                 currency_conversion: null)
+```
+
+

data/docs/PaymentFacilitator.md

@@ -1,6 +1,7 @@
 # OpenapiClient::PaymentFacilitator
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **external_merchant_id** | **String** | External merchant ID of the payment facilitator. | 
@@ -9,4 +10,16 @@ Name | Type | Description | Notes
 **name** | **String** | Payment facilitator name. | 
 **sub_merchant_data** | [**SubMerchantData**](SubMerchantData.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentFacilitator.new(external_merchant_id: 151623999,
+                                 payment_facilitator_id: 12345678901,
+                                 sale_organization_id: 13579246801,
+                                 name: First Reseller,
+                                 sub_merchant_data: null)
+```
+
 

data/docs/PaymentIssuerResponse.md

@@ -1,10 +1,21 @@
 # OpenapiClient::PaymentIssuerResponse
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **String** | The verification response code, as sent by the verification system. | 
 **status** | **String** | The interpretation of the response code. Valid values are \"approved\" - The verification was conducted and is approved. \"declined\" - The verification was conducted and is not approved. \"disabled\" - The verification was not conducted because it was not requested or disabled in the verification. \"unknown\" - The verification was attempted but it failed due to some system error (e.g. timeout). | [optional] 
 **scheme** | **String** | An identifier of the system/specification from which the code was received, and how the status was derived. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentIssuerResponse.new(code: 100,
+                                 status: approved,
+                                 scheme: visa)
+```
+
 

data/docs/PaymentMethodDetails.md

@@ -1,9 +1,19 @@
 # OpenapiClient::PaymentMethodDetails
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
 **payment_method_type** | [**PaymentMethodType**](PaymentMethodType.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentMethodDetails.new(payment_card: null,
+                                 payment_method_type: null)
+```
+
 

data/docs/PaymentMethodPaymentSchedulesRequest.md

@@ -1,24 +1,17 @@
 # OpenapiClient::PaymentMethodPaymentSchedulesRequest
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_type** | **String** | Object name of the payment schedules request. | 
-**store_id** | **String** | Store ID number. | [optional] 
-**start_date** | **Date** | Date of mandate signature. | 
-**number_of_payments** | **Integer** | Number of times the recurring payment will process. | [optional] 
-**maximum_failures** | **Integer** | Number of failures that can be encountered before re-tries cease. | [optional] 
-**invoice_number** | **String** | Invoice number. | [optional] 
-**purchase_order_number** | **String** | Purchase order number. | [optional] 
-**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
-**dynamic_merchant_name** | **String** | Dynamic merchant name for the cardholder's statement. | [optional] 
-**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] 
-**billing** | [**Billing**](Billing.md) |  | [optional] 
-**shipping** | [**Shipping**](Shipping.md) |  | [optional] 
-**comments** | **String** | User supplied comments. | [optional] 
 **payment_method** | [**PaymentCardPaymentMethod**](PaymentCardPaymentMethod.md) |  | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentMethodPaymentSchedulesRequest.new(payment_method: null)
+```
+
 

data/docs/PaymentMethodPaymentSchedulesRequestAllOf.md

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

data/docs/PaymentMethodType.md

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

data/docs/PaymentPayMethod.md

@@ -1,6 +1,7 @@
 # OpenapiClient::PaymentPayMethod
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **method_type** | **String** | Unique ID for the payment method type. | 
@@ -10,4 +11,17 @@ Name | Type | Description | Notes
 **provider** | **String** | The wallet provider. This field should be normalized before sending through the API. | [optional] 
 **user_defined** | [**Object**](.md) | A JSON object that can carry any additional information about the method that might be helpful for fraud detection. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentPayMethod.new(method_type: method/card,
+                                 method_id: 300fa792-bf5f-418e-aa74-d5b3c81298d2,
+                                 method_alias: card one,
+                                 card: null,
+                                 provider: apple,
+                                 user_defined: {"phoneBrand":"samsung"})
+```
+