yapstone-payments 1.0.0

data/docs/PaymentInstrumentResponse.md

@@ -0,0 +1,19 @@
+# Yapstone::PaymentInstrumentResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**instrument_type** | **String** |  | [optional] 
+**token** | [**Token**](Token.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PaymentInstrumentResponse.new(instrument_type: null,
+                                 token: null)
+```
+
+

data/docs/PaymentPayment.md

@@ -0,0 +1,27 @@
+# Yapstone::PaymentPayment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_id** | **String** | Unique identifier for a payment. Payments contain transactions associated with that payment. Multiple payments can be associated through a master payment.  | [optional] 
+**total_amount** | [**Money**](Money.md) |  | [optional] 
+**line_items** | **Array<Object>** |  | [optional] 
+**payin_transactions** | **Array<Object>** |  | [optional] 
+**payout_transactions** | **Array<Object>** |  | [optional] 
+**deposit_details** | [**Array<DepositDetails>**](DepositDetails.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PaymentPayment.new(payment_id: null,
+                                 total_amount: null,
+                                 line_items: null,
+                                 payin_transactions: null,
+                                 payout_transactions: null,
+                                 deposit_details: null)
+```
+
+

data/docs/PaymentPaymentAllOf.md

@@ -0,0 +1,27 @@
+# Yapstone::PaymentPaymentAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_id** | **String** | Unique identifier for a payment. Payments contain transactions associated with that payment. Multiple payments can be associated through a master payment.  | [optional] 
+**total_amount** | [**Money**](Money.md) |  | [optional] 
+**line_items** | **Array<Object>** |  | [optional] 
+**payin_transactions** | **Array<Object>** |  | [optional] 
+**payout_transactions** | **Array<Object>** |  | [optional] 
+**deposit_details** | [**Array<DepositDetails>**](DepositDetails.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PaymentPaymentAllOf.new(payment_id: null,
+                                 total_amount: null,
+                                 line_items: null,
+                                 payin_transactions: null,
+                                 payout_transactions: null,
+                                 deposit_details: null)
+```
+
+

data/docs/PaymentResponse.md

@@ -0,0 +1,33 @@
+# Yapstone::PaymentResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **String** | The action that was taken for this phase of the payment.  | [optional] 
+**client_correlation_id** | **String** | Optionally provide your system's internal identifier for this entity, for use later if you need to correlate data across systems or consolidate records.  | [optional] 
+**client_unique_transaction_id** | **String** | This is the unique transaction ID for one transaction to do with a payment being processed. You can use this to retrieve a specific transaction vs. a set of associated transactions (which is what you would use the clientCorrelationId for).  | [optional] 
+**payment_id** | **String** | The payment ID allows you to reference the payment if you need to cancel it or retrieve it.  | [optional] 
+**payment** | [**Payment**](Payment.md) |  | [optional] 
+**customer** | [**CustomerDetails**](CustomerDetails.md) |  | [optional] 
+**marketplace** | [**Merketplace**](Merketplace.md) |  | [optional] 
+**custom_data** | **Hash<String, String>** |  | [optional] 
+**refund_id** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PaymentResponse.new(action: null,
+                                 client_correlation_id: a92afbb6-9599-48f1-b80b-acc6184d7a11,
+                                 client_unique_transaction_id: 4ed13361-5d66-4b76-8c6c-b462d5f638a7,
+                                 payment_id: null,
+                                 payment: null,
+                                 customer: null,
+                                 marketplace: null,
+                                 custom_data: null,
+                                 refund_id: null)
+```
+
+

data/docs/PaymentsApi.md

@@ -0,0 +1,447 @@
+# Yapstone::PaymentsApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_payment**](PaymentsApi.md#cancel_payment) | **DELETE** /v2/payments/payment/{paymentId} | Cancel Payment by payment Id
+[**cancel_transaction**](PaymentsApi.md#cancel_transaction) | **DELETE** /v2/payments/transaction/{transactionId} | Cancel Transaction by TransactionId
+[**capture_payment**](PaymentsApi.md#capture_payment) | **PATCH** /v2/payments/payment/{paymentId} | Capture a prior authorized payment
+[**create_payment**](PaymentsApi.md#create_payment) | **POST** /v2/payments/payment | Process Payment
+[**get_payment**](PaymentsApi.md#get_payment) | **GET** /v2/payments/payment/{paymentId} | Get with Payment Id
+[**get_transaction**](PaymentsApi.md#get_transaction) | **GET** /v2/payments/transaction/{transactionId} | Get Transaction by Transaction Id
+[**verify_payment_instrument**](PaymentsApi.md#verify_payment_instrument) | **POST** /v2/payments/instrument/verify | Verify payment instrument
+
+
+
+## cancel_payment
+
+> PaymentCancelResponse cancel_payment(authorization, x_yapstone_ip_address, payment_id, opts)
+
+Cancel Payment by payment Id
+
+Use a DELETE request to send a payment ID to this endpoint in order to cancel the payment. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::PaymentsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | Ip Address of the client
+payment_id = 'payment_id_example' # String | paymentId
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  x_yapstone_fpsid: 'x_yapstone_fpsid_example' # String | Device Finger Print Id
+}
+
+begin
+  #Cancel Payment by payment Id
+  result = api_instance.cancel_payment(authorization, x_yapstone_ip_address, payment_id, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PaymentsApi->cancel_payment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| Ip Address of the client | 
+ **payment_id** | **String**| paymentId | 
+ **x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.  | [optional] 
+ **x_yapstone_fpsid** | **String**| Device Finger Print Id | [optional] 
+
+### Return type
+
+[**PaymentCancelResponse**](PaymentCancelResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## cancel_transaction
+
+> PaymentCancelTransactionResponse cancel_transaction(authorization, x_yapstone_ip_address, transaction_id, opts)
+
+Cancel Transaction by TransactionId
+
+Use a transaction identifier to cancel a transaction. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::PaymentsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | Ip Address of the client
+transaction_id = 'transaction_id_example' # String | The transaction ID for the transaction you would like to cancel. 
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  x_yapstone_fpsid: 'x_yapstone_fpsid_example' # String | Device Finger Print Id
+}
+
+begin
+  #Cancel Transaction by TransactionId
+  result = api_instance.cancel_transaction(authorization, x_yapstone_ip_address, transaction_id, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PaymentsApi->cancel_transaction: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| Ip Address of the client | 
+ **transaction_id** | **String**| The transaction ID for the transaction you would like to cancel.  | 
+ **x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.  | [optional] 
+ **x_yapstone_fpsid** | **String**| Device Finger Print Id | [optional] 
+
+### Return type
+
+[**PaymentCancelTransactionResponse**](PaymentCancelTransactionResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## capture_payment
+
+> PaymentResponse capture_payment(authorization, x_yapstone_ip_address, payment_id, opts)
+
+Capture a prior authorized payment
+
+Capture a prior authorized payment. This endpoint is used after a payment is authorized. Once a payment is authorized, you must capture it so that money can be transferred from the customer's account to the merchant's account. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::PaymentsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | Ip Address of the client
+payment_id = 'payment_id_example' # String | The payment ID associated with the payment. You can use this to retrieve a payment or chance its status. 
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  x_yapstone_fpsid: 'x_yapstone_fpsid_example', # String | Device Finger Print Id
+  capture_payment_request: Yapstone::CapturePaymentRequest.new # CapturePaymentRequest | 
+}
+
+begin
+  #Capture a prior authorized payment
+  result = api_instance.capture_payment(authorization, x_yapstone_ip_address, payment_id, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PaymentsApi->capture_payment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| Ip Address of the client | 
+ **payment_id** | **String**| The payment ID associated with the payment. You can use this to retrieve a payment or chance its status.  | 
+ **x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.  | [optional] 
+ **x_yapstone_fpsid** | **String**| Device Finger Print Id | [optional] 
+ **capture_payment_request** | [**CapturePaymentRequest**](CapturePaymentRequest.md)|  | [optional] 
+
+### Return type
+
+[**PaymentResponse**](PaymentResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_payment
+
+> PaymentResponse create_payment(authorization, x_yapstone_ip_address, process_payment, opts)
+
+Process Payment
+
+The payment endpoint lets you create a payment and send information identifying the customer device the payment comes from. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::PaymentsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | This is the IP address of the client. 
+process_payment = Yapstone::ProcessPayment.new # ProcessPayment | processPayment
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  x_yapstone_fpsid: 'x_yapstone_fpsid_example' # String | A device fingerprint is information gathered about the hardware and software of a website visitor combined with browser information. The fingerprint can be used to help retrieve particular sessions later, and it provides details about whoever is making a payment. 
+}
+
+begin
+  #Process Payment
+  result = api_instance.create_payment(authorization, x_yapstone_ip_address, process_payment, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PaymentsApi->create_payment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| This is the IP address of the client.  | 
+ **process_payment** | [**ProcessPayment**](ProcessPayment.md)| processPayment | 
+ **x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.  | [optional] 
+ **x_yapstone_fpsid** | **String**| A device fingerprint is information gathered about the hardware and software of a website visitor combined with browser information. The fingerprint can be used to help retrieve particular sessions later, and it provides details about whoever is making a payment.  | [optional] 
+
+### Return type
+
+[**PaymentResponse**](PaymentResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_payment
+
+> PaymentResponse get_payment(authorization, x_yapstone_ip_address, payment_id, opts)
+
+Get with Payment Id
+
+This endpoint lets you send a GET request containing a payment ID. The associated payment is returned to you in the response. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::PaymentsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | IP Address of the client
+payment_id = 'payment_id_example' # String | paymentId
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example' # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+}
+
+begin
+  #Get with Payment Id
+  result = api_instance.get_payment(authorization, x_yapstone_ip_address, payment_id, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PaymentsApi->get_payment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| IP Address of the client | 
+ **payment_id** | **String**| paymentId | 
+ **x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.  | [optional] 
+
+### Return type
+
+[**PaymentResponse**](PaymentResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_transaction
+
+> OrderTransactions get_transaction(authorization, x_yapstone_ip_address, transaction_id, opts)
+
+Get Transaction by Transaction Id
+
+Retrieve information about a specific transaction. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::PaymentsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | IP Address of the client
+transaction_id = 'transaction_id_example' # String | The transaction identifier for the transaction you want to retrieve details about. 
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example' # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+}
+
+begin
+  #Get Transaction by Transaction Id
+  result = api_instance.get_transaction(authorization, x_yapstone_ip_address, transaction_id, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PaymentsApi->get_transaction: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| IP Address of the client | 
+ **transaction_id** | **String**| The transaction identifier for the transaction you want to retrieve details about.  | 
+ **x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.  | [optional] 
+
+### Return type
+
+[**OrderTransactions**](OrderTransactions.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## verify_payment_instrument
+
+> InstrumentVerificationResponse verify_payment_instrument(authorization, x_yapstone_ip_address, verify_instrument_request, opts)
+
+Verify payment instrument
+
+Use this endpoint to verify that a customer's payment instrument is valid and associated with them. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::PaymentsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | IP Address of the client
+verify_instrument_request = Yapstone::VerifyInstrumentRequest.new # VerifyInstrumentRequest | verifyInstrumentRequest
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  x_yapstone_fpsid: 'x_yapstone_fpsid_example' # String | Device Finger Print Id
+}
+
+begin
+  #Verify payment instrument
+  result = api_instance.verify_payment_instrument(authorization, x_yapstone_ip_address, verify_instrument_request, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling PaymentsApi->verify_payment_instrument: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| IP Address of the client | 
+ **verify_instrument_request** | [**VerifyInstrumentRequest**](VerifyInstrumentRequest.md)| verifyInstrumentRequest | 
+ **x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.  | [optional] 
+ **x_yapstone_fpsid** | **String**| Device Finger Print Id | [optional] 
+
+### Return type
+
+[**InstrumentVerificationResponse**](InstrumentVerificationResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+