first_data_gateway 1.2.0 → 1.3.0

data/docs/PaymentTokenizationRequest.md

@@ -1,12 +1,25 @@
 # OpenapiClient::PaymentTokenizationRequest
 
 ## 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]
+**account_verification** | **Boolean** | If the account should be verified prior to token creation. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentTokenizationRequest.new(request_type: PaymentCardPaymentTokenizationRequest,
+                                 store_id: 12345500000,
+                                 billing_address: null,
+                                 create_token: null,
+                                 account_verification: true)
+```
 
 

data/docs/PaymentTokenizationResponse.md

@@ -1,6 +1,7 @@
 # OpenapiClient::PaymentTokenizationResponse
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
@@ -8,11 +9,29 @@ Name | Type | Description | Notes
 **response_type** | [**ResponseType**](ResponseType.md) |  | [optional] 
 **request_status** | **String** | The status of the request. | [optional] 
 **request_time** | **Integer** | Time of the request. | [optional] 
-**avs_response** | [**AVSResponse**](AVSResponse.md) |  | [optional] 
-**security_code_response** | **String** | Security code check response. | [optional] 
 **brand** | **String** | Card brand. | [optional] 
 **country** | **String** | Country of the card issued. | [optional] 
 **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] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentTokenizationResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 request_status: DELETED,
+                                 request_time: 1554308829345,
+                                 brand: VISA,
+                                 country: Germany,
+                                 payment_token: null,
+                                 payment_card: null,
+                                 processor: null,
+                                 order_id: R-44df6542-ae0b-4415-88e8-7f3e62cc9e5d)
+```
 
 

data/docs/PaymentURLApi.md

@@ -7,7 +7,9 @@ Method | HTTP request | Description
 [**create_payment_url**](PaymentURLApi.md#create_payment_url) | **POST** /payment-url | Create a payment URL.
 
 
-# **create_payment_url**
+
+## create_payment_url
+
 > PaymentUrlResponse create_payment_url(content_type, client_request_id, api_key, timestamp, payment_url_request, opts)
 
 Create a payment URL.
@@ -15,6 +17,7 @@ Create a payment URL.
 Use this to generate an embedding payment link.
 
 ### Example
+
 ```ruby
 # load the gem
 require 'openapi_client'
@@ -41,6 +44,7 @@ end
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **content_type** | **String**| Content type. | [default to 'application/json']
@@ -61,8 +65,6 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
+- **Content-Type**: application/json
+- **Accept**: application/json
 

data/docs/PaymentUrlErrorResponse.md

@@ -1,6 +1,7 @@
 # OpenapiClient::PaymentUrlErrorResponse
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
@@ -12,4 +13,19 @@ Name | Type | Description | Notes
 **transaction_id** | **String** | ID code from the transaction. | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentUrlErrorResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 request_status: SUCCESS,
+                                 order_id: 123456,
+                                 payment_url: https://api.firstdata.com/connect/gateway/processing?storename=123456789&oid=R-96cdbaa4-c22e-4598-a2f1-c2b5fed79ef1&paymentUrlId=d3eb74fe-cf63-47e1-b89f-52ba0cc7965c,
+                                 transaction_id: 123978432,
+                                 error: null)
+```
+
 

data/docs/PaymentUrlRequest.md

@@ -1,21 +1,45 @@
 # OpenapiClient::PaymentUrlRequest
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **store_id** | **String** | An optional Outlet ID for clients that support multiple stores in the same developer app. | [optional] 
 **client_locale** | [**ClientLocale**](ClientLocale.md) |  | [optional] 
-**transaction_amount** | [**Amount**](Amount.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] 
 **billing** | [**Billing**](Billing.md) |  | [optional] 
 **shipping** | [**Shipping**](Shipping.md) |  | [optional] 
 **transaction_notification_url** | **String** | URL for notifying merchant of payment result. | [optional] 
 **expiration** | **Integer** | Time until payment URL expires. | [optional] 
-**authenticate_transaction** | **BOOLEAN** | If 3D secure should be applied. | [optional] 
+**authenticate_transaction** | **Boolean** | If 3D secure should be applied. | [optional] 
 **dynamic_merchant_name** | **String** | Dynamic merchant name for the cardholder's statement. | [optional] 
 **invoice_number** | **String** | Invoice number. | [optional] 
 **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] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentUrlRequest.new(store_id: 12345500000,
+                                 client_locale: null,
+                                 transaction_amount: null,
+                                 transaction_type: null,
+                                 order_id: 123456,
+                                 billing: null,
+                                 shipping: null,
+                                 transaction_notification_url: https://showmethepaymentresult.com,
+                                 expiration: 1518811817,
+                                 authenticate_transaction: true,
+                                 dynamic_merchant_name: MyWebsite,
+                                 invoice_number: 96126098,
+                                 purchase_order_number: 123055342,
+                                 hosted_payment_page_text: This is a payment for x,
+                                 ip: 264.31.73.24)
+```
+
 

data/docs/PaymentUrlResponse.md

@@ -1,6 +1,7 @@
 # OpenapiClient::PaymentUrlResponse
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
@@ -11,4 +12,18 @@ Name | Type | Description | Notes
 **payment_url** | **String** | URL for embedded payment link. | [optional] 
 **transaction_id** | **String** | ID code from the transaction. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentUrlResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 request_status: SUCCESS,
+                                 order_id: 123456,
+                                 payment_url: https://api.firstdata.com/connect/gateway/processing?storename=123456789&oid=R-96cdbaa4-c22e-4598-a2f1-c2b5fed79ef1&paymentUrlId=d3eb74fe-cf63-47e1-b89f-52ba0cc7965c,
+                                 transaction_id: 123978432)
+```
+
 

data/docs/PaymentVerification3ds.md

@@ -1,10 +1,21 @@
 # OpenapiClient::PaymentVerification3ds
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **String** | 3DS response code. | 
 **status** | **String** | Interpretation of the response code. | [optional] 
 **scheme** | **String** | Identifier of the scheme. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentVerification3ds.new(code: 4,
+                                 status: approved,
+                                 scheme: 6)
+```
+
 

data/docs/PaymentVerificationAvs.md

@@ -1,10 +1,21 @@
 # OpenapiClient::PaymentVerificationAvs
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **String** | AVS response code. | 
 **status** | **String** | Interpretation of the response code. | [optional] 
 **scheme** | **String** | Identifier of the scheme. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentVerificationAvs.new(code: +Z,
+                                 status: zip match,
+                                 scheme: amex)
+```
+
 

data/docs/PaymentVerificationCvv.md

@@ -1,10 +1,21 @@
 # OpenapiClient::PaymentVerificationCvv
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **String** | CVV response code. | 
 **status** | **String** | Interpretation of the response code. | [optional] 
 **scheme** | **String** | Identifier of the scheme. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaymentVerificationCvv.new(code: 7,
+                                 status: approved,
+                                 scheme: 9)
+```
+
 

data/docs/PaypalCreditTransaction.md

@@ -1,14 +1,17 @@
 # OpenapiClient::PaypalCreditTransaction
 
 ## 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** | [**PayPalPaymentMethod**](PayPalPaymentMethod.md) |  | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PaypalCreditTransaction.new(payment_method: null)
+```
+
 

data/docs/PaypalCreditTransactionAllOf.md

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

data/docs/PostAuthTransaction.md

@@ -1,14 +1,23 @@
 # OpenapiClient::PostAuthTransaction
 
 ## Properties
+
 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] 
-**comments** | **String** | Comment for the secondary transaction. | [optional] 
 **transaction_amount** | [**Amount**](Amount.md) |  | 
 **transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
 **split_shipment** | [**SplitShipment**](SplitShipment.md) |  | [optional] 
 **soft_descriptor** | [**SoftDescriptor**](SoftDescriptor.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PostAuthTransaction.new(transaction_amount: null,
+                                 transaction_origin: null,
+                                 split_shipment: null,
+                                 soft_descriptor: null)
+```
+
 

data/docs/PostAuthTransactionAllOf.md

@@ -0,0 +1,23 @@
+# OpenapiClient::PostAuthTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_amount** | [**Amount**](Amount.md) |  | 
+**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
+**split_shipment** | [**SplitShipment**](SplitShipment.md) |  | [optional] 
+**soft_descriptor** | [**SoftDescriptor**](SoftDescriptor.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PostAuthTransactionAllOf.new(transaction_amount: null,
+                                 transaction_origin: null,
+                                 split_shipment: null,
+                                 soft_descriptor: null)
+```
+
+

data/docs/PrimaryTransaction.md

@@ -1,13 +1,27 @@
 # OpenapiClient::PrimaryTransaction
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **request_type** | **String** | Object name of the primary transaction request. | 
+**transaction_amount** | [**Amount**](Amount.md) |  | 
 **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] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PrimaryTransaction.new(request_type: PaymentCardCreditTransaction,
+                                 transaction_amount: null,
+                                 store_id: 12345500000,
+                                 merchant_transaction_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 transaction_origin: null,
+                                 order: null)
+```
+
 

data/docs/ProcessorData.md

@@ -1,6 +1,7 @@
 # OpenapiClient::ProcessorData
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **reference_number** | **String** | Reference transaction ID. | [optional] 
@@ -13,4 +14,20 @@ Name | Type | Description | Notes
 **security_code_response** | **String** | Code returned for CVV. | [optional] 
 **merchant_advice_code_indicator** | **String** | Code to map merchant advice code to ISO specification. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ProcessorData.new(reference_number: 811720726601,
+                                 authorization_code: OK7118,
+                                 response_code: 00,
+                                 network: NYCE,
+                                 association_response_code: 000,
+                                 response_message: Amount specified exceeds allowable limit.,
+                                 avs_response: null,
+                                 security_code_response: NOT_MATCHED,
+                                 merchant_advice_code_indicator: 01)
+```
+
 

data/docs/PurchaseCards.md

@@ -1,9 +1,19 @@
 # OpenapiClient::PurchaseCards
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **level2** | [**PurchaseCardsLevel2**](PurchaseCardsLevel2.md) |  | [optional] 
 **level3** | [**PurchaseCardsLevel3**](PurchaseCardsLevel3.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PurchaseCards.new(level2: null,
+                                 level3: null)
+```
+
 

data/docs/PurchaseCardsLevel2.md

@@ -1,6 +1,7 @@
 # OpenapiClient::PurchaseCardsLevel2
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **customer_reference_id** | **String** | Customer code/customer reference ID. | [optional] 
@@ -9,4 +10,16 @@ Name | Type | Description | Notes
 **total_discount_amount_and_rate** | [**AdditionalAmountRate**](AdditionalAmountRate.md) |  | [optional] 
 **vat_shipping_amount_and_rate** | [**AdditionalAmountRate**](AdditionalAmountRate.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PurchaseCardsLevel2.new(customer_reference_id: abcdef123xyz,
+                                 supplier_invoice_number: 0000000065348,
+                                 supplier_vat_registration_number: 10001174242,
+                                 total_discount_amount_and_rate: null,
+                                 vat_shipping_amount_and_rate: null)
+```
+
 

data/docs/PurchaseCardsLevel3.md

@@ -1,8 +1,17 @@
 # OpenapiClient::PurchaseCardsLevel3
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **line_items** | [**Array<PurchaseCardsLevel3LineItems>**](PurchaseCardsLevel3LineItems.md) | Line items. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PurchaseCardsLevel3.new(line_items: null)
+```
+
 

data/docs/PurchaseCardsLevel3LineItems.md

@@ -1,6 +1,7 @@
 # OpenapiClient::PurchaseCardsLevel3LineItems
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **commodity_code** | **String** | The commodity code used to classify the item purchased. | [optional] 
@@ -13,4 +14,20 @@ Name | Type | Description | Notes
 **discount_amount_and_rate** | [**AdditionalAmountRate**](AdditionalAmountRate.md) |  | [optional] 
 **line_item_total** | **Float** | Rate amount in 3 decimal 12 bytes total digit. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PurchaseCardsLevel3LineItems.new(commodity_code: ab12,
+                                 product_code: 0001212120888,
+                                 description: Dinner and movie,
+                                 quantity: 5,
+                                 unit_measure: 25,
+                                 unit_price: 30.075,
+                                 vat_amount_and_rate: null,
+                                 discount_amount_and_rate: null,
+                                 line_item_total: 39.075)
+```
+
 

data/docs/ReceiverInfo.md

@@ -0,0 +1,33 @@
+# OpenapiClient::ReceiverInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Receiver name. | 
+**street_address** | **String** | Receiver street address. | 
+**city** | **String** | Receiver city. | 
+**state_code** | **String** | Receiver state. | 
+**country_code** | **String** | Receiver country code. | 
+**postal_code** | **String** | Receiver postal code. | 
+**phone_number** | **String** | Receiver phone number. | 
+**reference_number** | **String** | Receiver reference number. | 
+**account_number** | **String** | Receiver account number. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ReceiverInfo.new(name: George Washington,
+                                 street_address: 5565 Glenridge Connector,
+                                 city: Atlanta,
+                                 state_code: GA,
+                                 country_code: US,
+                                 postal_code: 30342,
+                                 phone_number: 4044040740,
+                                 reference_number: 123456,
+                                 account_number: 135246)
+```
+
+

data/docs/RecurringPaymentDetails.md

@@ -1,6 +1,7 @@
 # OpenapiClient::RecurringPaymentDetails
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **store_id** | **String** | Store ID number. | [optional] 
@@ -17,4 +18,24 @@ Name | Type | Description | Notes
 **state** | **String** | State of the recurring payment. | [optional] 
 **comments** | **String** | User supplied comments. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RecurringPaymentDetails.new(store_id: 1109959991,
+                                 purchase_order_number: 123055342,
+                                 invoice_number: 96126098,
+                                 creation_date: 2018-10-25,
+                                 start_date: 2018-10-25,
+                                 next_attempt_date: 2018-10-25,
+                                 transaction_amount: null,
+                                 payment_method_details: null,
+                                 frequency: null,
+                                 number_of_payments: 10,
+                                 run_count: 10,
+                                 state: Installed,
+                                 comments: This scheduled payment series is to pay for the thing.)
+```
+
 

data/docs/RecurringPaymentDetailsResponse.md

@@ -1,6 +1,7 @@
 # OpenapiClient::RecurringPaymentDetailsResponse
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
@@ -15,4 +16,22 @@ Name | Type | Description | Notes
 **processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
 **recurring_payment_details** | [**RecurringPaymentDetails**](RecurringPaymentDetails.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::RecurringPaymentDetailsResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 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,
+                                 recurring_payment_details: null)
+```
+
 

data/docs/ReferencedOrderPaymentSchedulesRequest.md

@@ -1,24 +1,17 @@
 # OpenapiClient::ReferencedOrderPaymentSchedulesRequest
 
 ## 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] 
 **referenced_order_id** | **String** | Order ID used to create recurring payment from existing transaction. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ReferencedOrderPaymentSchedulesRequest.new(referenced_order_id: R-f9c2c198-b7cc-491a-a711-93d22fd0e589)
+```
+