checkbook 1.0.1

data/docs/Payment.md

@@ -0,0 +1,1247 @@
+# Checkbook::Payment
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_check**](Payment.md#delete_check) | **DELETE** /v3/check/{check_id} | Void a payment |
+| [**get_check**](Payment.md#get_check) | **GET** /v3/check/{check_id} | Get payment |
+| [**get_check_attachment**](Payment.md#get_check_attachment) | **GET** /v3/check/{check_id}/attachment | Get attachment for a payment |
+| [**get_check_deposit**](Payment.md#get_check_deposit) | **GET** /v3/check/{check_id}/deposit | Get deposit details |
+| [**get_check_fail**](Payment.md#get_check_fail) | **GET** /v3/check/{check_id}/fail | Get details on failed payment |
+| [**get_check_tracking**](Payment.md#get_check_tracking) | **GET** /v3/check/{check_id}/tracking | Get tracking details on mailed check |
+| [**get_check_verification**](Payment.md#get_check_verification) | **GET** /v3/check/{check_id}/verification | Get verification code |
+| [**get_checks**](Payment.md#get_checks) | **GET** /v3/check | Get sent/received payments |
+| [**post_check_deposit**](Payment.md#post_check_deposit) | **POST** /v3/check/deposit/{check_id} | Deposit a payment |
+| [**post_check_digital**](Payment.md#post_check_digital) | **POST** /v3/check/digital | Create a digital payment |
+| [**post_check_endorse**](Payment.md#post_check_endorse) | **POST** /v3/check/endorse/{check_id} | Endorse a multi-party payment |
+| [**post_check_multi**](Payment.md#post_check_multi) | **POST** /v3/check/multi | Create a multi-party payment |
+| [**post_check_notify**](Payment.md#post_check_notify) | **POST** /v3/check/notify/{check_id} | Resend payment notification |
+| [**post_check_physical**](Payment.md#post_check_physical) | **POST** /v3/check/physical | Create a physical check |
+| [**post_check_preview**](Payment.md#post_check_preview) | **POST** /v3/check/preview | Preview payment |
+| [**post_check_print**](Payment.md#post_check_print) | **POST** /v3/check/print/{check_id} | Print a payment |
+| [**post_check_webhook**](Payment.md#post_check_webhook) | **PUT** /v3/check/webhook/{check_id} | Update a sandbox payment status |
+
+
+## delete_check
+
+> delete_check(check_id)
+
+Void a payment
+
+Void the specified payment
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+check_id = 'check_id_example' # String | 
+
+begin
+  # Void a payment
+  api_instance.delete_check(check_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->delete_check: #{e}"
+end
+```
+
+#### Using the delete_check_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_check_with_http_info(check_id)
+
+```ruby
+begin
+  # Void a payment
+  data, status_code, headers = api_instance.delete_check_with_http_info(check_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->delete_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_check
+
+> <GetCheckResponse> get_check(check_id)
+
+Get payment
+
+Get the specified payment
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+check_id = 'check_id_example' # String | 
+
+begin
+  # Get payment
+  result = api_instance.get_check(check_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_check: #{e}"
+end
+```
+
+#### Using the get_check_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckResponse>, Integer, Hash)> get_check_with_http_info(check_id)
+
+```ruby
+begin
+  # Get payment
+  data, status_code, headers = api_instance.get_check_with_http_info(check_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_id** | **String** |  |  |
+
+### Return type
+
+[**GetCheckResponse**](GetCheckResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_check_attachment
+
+> File get_check_attachment(check_id)
+
+Get attachment for a payment
+
+Get the attachment for a payment
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+check_id = 'check_id_example' # String | 
+
+begin
+  # Get attachment for a payment
+  result = api_instance.get_check_attachment(check_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_check_attachment: #{e}"
+end
+```
+
+#### Using the get_check_attachment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> get_check_attachment_with_http_info(check_id)
+
+```ruby
+begin
+  # Get attachment for a payment
+  data, status_code, headers = api_instance.get_check_attachment_with_http_info(check_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_check_attachment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_id** | **String** |  |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/pdf, application/json
+
+
+## get_check_deposit
+
+> <GetCheckDepositedResponse> get_check_deposit(check_id)
+
+Get deposit details
+
+Get details on a deposited payment
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+check_id = 'check_id_example' # String | 
+
+begin
+  # Get deposit details
+  result = api_instance.get_check_deposit(check_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_check_deposit: #{e}"
+end
+```
+
+#### Using the get_check_deposit_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckDepositedResponse>, Integer, Hash)> get_check_deposit_with_http_info(check_id)
+
+```ruby
+begin
+  # Get deposit details
+  data, status_code, headers = api_instance.get_check_deposit_with_http_info(check_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckDepositedResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_check_deposit_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_id** | **String** |  |  |
+
+### Return type
+
+[**GetCheckDepositedResponse**](GetCheckDepositedResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_check_fail
+
+> <GetCheckFailedResponse> get_check_fail(check_id)
+
+Get details on failed payment
+
+Get details on a failed payment
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+check_id = 'check_id_example' # String | 
+
+begin
+  # Get details on failed payment
+  result = api_instance.get_check_fail(check_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_check_fail: #{e}"
+end
+```
+
+#### Using the get_check_fail_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckFailedResponse>, Integer, Hash)> get_check_fail_with_http_info(check_id)
+
+```ruby
+begin
+  # Get details on failed payment
+  data, status_code, headers = api_instance.get_check_fail_with_http_info(check_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckFailedResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_check_fail_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_id** | **String** |  |  |
+
+### Return type
+
+[**GetCheckFailedResponse**](GetCheckFailedResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_check_tracking
+
+> <GetCheckTrackingResponseExpress> get_check_tracking(check_id)
+
+Get tracking details on mailed check
+
+Get tracking details on a mailed check
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+check_id = 'check_id_example' # String | 
+
+begin
+  # Get tracking details on mailed check
+  result = api_instance.get_check_tracking(check_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_check_tracking: #{e}"
+end
+```
+
+#### Using the get_check_tracking_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckTrackingResponseExpress>, Integer, Hash)> get_check_tracking_with_http_info(check_id)
+
+```ruby
+begin
+  # Get tracking details on mailed check
+  data, status_code, headers = api_instance.get_check_tracking_with_http_info(check_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckTrackingResponseExpress>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_check_tracking_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_id** | **String** |  |  |
+
+### Return type
+
+[**GetCheckTrackingResponseExpress**](GetCheckTrackingResponseExpress.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_check_verification
+
+> <VerifyCheckResponse> get_check_verification(check_id)
+
+Get verification code
+
+Get the verification code
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+check_id = 'check_id_example' # String | 
+
+begin
+  # Get verification code
+  result = api_instance.get_check_verification(check_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_check_verification: #{e}"
+end
+```
+
+#### Using the get_check_verification_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerifyCheckResponse>, Integer, Hash)> get_check_verification_with_http_info(check_id)
+
+```ruby
+begin
+  # Get verification code
+  data, status_code, headers = api_instance.get_check_verification_with_http_info(check_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerifyCheckResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_check_verification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_id** | **String** |  |  |
+
+### Return type
+
+[**VerifyCheckResponse**](VerifyCheckResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_checks
+
+> <GetChecksResponse> get_checks(opts)
+
+Get sent/received payments
+
+Return the sent/received payments
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+opts = {
+  direction: 'INCOMING', # String | Direction
+  end_date: Date.parse('2013-10-20'), # Date | End date
+  page: 1, # Integer | Page number
+  per_page: 10, # Integer | Items per page
+  q: 'payment', # String | Query
+  sort: '+NUMBER', # String | Sort
+  start_date: Date.parse('2013-10-20'), # Date | Start date
+  status: 'PAID' # String | Status
+}
+
+begin
+  # Get sent/received payments
+  result = api_instance.get_checks(opts)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_checks: #{e}"
+end
+```
+
+#### Using the get_checks_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetChecksResponse>, Integer, Hash)> get_checks_with_http_info(opts)
+
+```ruby
+begin
+  # Get sent/received payments
+  data, status_code, headers = api_instance.get_checks_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetChecksResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->get_checks_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **direction** | **String** | Direction | [optional] |
+| **end_date** | **Date** | End date | [optional] |
+| **page** | **Integer** | Page number | [optional][default to 1] |
+| **per_page** | **Integer** | Items per page | [optional][default to 50] |
+| **q** | **String** | Query | [optional] |
+| **sort** | **String** | Sort | [optional] |
+| **start_date** | **Date** | Start date | [optional] |
+| **status** | **String** | Status | [optional] |
+
+### Return type
+
+[**GetChecksResponse**](GetChecksResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_check_deposit
+
+> <GetCheckResponse> post_check_deposit(check_id, deposit_check_request)
+
+Deposit a payment
+
+Deposit a payment
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+check_id = 'check_id_example' # String | 
+deposit_check_request = Checkbook::DepositCheckRequest.new({account: 'account_example'}) # DepositCheckRequest | 
+
+begin
+  # Deposit a payment
+  result = api_instance.post_check_deposit(check_id, deposit_check_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_deposit: #{e}"
+end
+```
+
+#### Using the post_check_deposit_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckResponse>, Integer, Hash)> post_check_deposit_with_http_info(check_id, deposit_check_request)
+
+```ruby
+begin
+  # Deposit a payment
+  data, status_code, headers = api_instance.post_check_deposit_with_http_info(check_id, deposit_check_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_deposit_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_id** | **String** |  |  |
+| **deposit_check_request** | [**DepositCheckRequest**](DepositCheckRequest.md) |  |  |
+
+### Return type
+
+[**GetCheckResponse**](GetCheckResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_check_digital
+
+> <GetCheckResponse> post_check_digital(create_digital_check_request)
+
+Create a digital payment
+
+Create a digital payment  > [!NOTE] > **Common Errors** > > - **`Invalid deposit option`:** If deposit options do not include `PRINT`, `MAIL`, or `BANK`, please ensure the payment is funded by a wallet. If you still encounter this error, please contact support@checkbook.io to ensure the specified payment rails are enabled for your account. > - **`Amount is larger than $2000 and requires signature`:** Please add a signature to the sender using [`v3/user/signature`](#tag/user/post/v3/user/signature). A signature is required for users to send out payments over $2000.
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+create_digital_check_request = Checkbook::CreateDigitalCheckRequest.new({amount: 5.23, name: 'Widgets Inc.', recipient: Checkbook::DigitalRecipient.new({id: 'id_example'})}) # CreateDigitalCheckRequest | 
+
+begin
+  # Create a digital payment
+  result = api_instance.post_check_digital(create_digital_check_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_digital: #{e}"
+end
+```
+
+#### Using the post_check_digital_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckResponse>, Integer, Hash)> post_check_digital_with_http_info(create_digital_check_request)
+
+```ruby
+begin
+  # Create a digital payment
+  data, status_code, headers = api_instance.post_check_digital_with_http_info(create_digital_check_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_digital_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_digital_check_request** | [**CreateDigitalCheckRequest**](CreateDigitalCheckRequest.md) |  |  |
+
+### Return type
+
+[**GetCheckResponse**](GetCheckResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_check_endorse
+
+> post_check_endorse(check_id, endorse_check_request)
+
+Endorse a multi-party payment
+
+Endorse a multi party payment
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+check_id = 'check_id_example' # String | 
+endorse_check_request = Checkbook::EndorseCheckRequest.new({name: 'Johnny Appleseed'}) # EndorseCheckRequest | 
+
+begin
+  # Endorse a multi-party payment
+  api_instance.post_check_endorse(check_id, endorse_check_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_endorse: #{e}"
+end
+```
+
+#### Using the post_check_endorse_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> post_check_endorse_with_http_info(check_id, endorse_check_request)
+
+```ruby
+begin
+  # Endorse a multi-party payment
+  data, status_code, headers = api_instance.post_check_endorse_with_http_info(check_id, endorse_check_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_endorse_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_id** | **String** |  |  |
+| **endorse_check_request** | [**EndorseCheckRequest**](EndorseCheckRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_check_multi
+
+> <GetCheckResponse> post_check_multi(create_multi_check_request)
+
+Create a multi-party payment
+
+Create a new multi party payment
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+create_multi_check_request = Checkbook::CreateMultiCheckRequest.new({amount: 5.23, recipients: [Checkbook::MultiRecipient.new({name: 'Widgets Inc.', recipient: 'testing@example.com or user_id'})]}) # CreateMultiCheckRequest | 
+
+begin
+  # Create a multi-party payment
+  result = api_instance.post_check_multi(create_multi_check_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_multi: #{e}"
+end
+```
+
+#### Using the post_check_multi_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckResponse>, Integer, Hash)> post_check_multi_with_http_info(create_multi_check_request)
+
+```ruby
+begin
+  # Create a multi-party payment
+  data, status_code, headers = api_instance.post_check_multi_with_http_info(create_multi_check_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_multi_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_multi_check_request** | [**CreateMultiCheckRequest**](CreateMultiCheckRequest.md) |  |  |
+
+### Return type
+
+[**GetCheckResponse**](GetCheckResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_check_notify
+
+> post_check_notify(check_id)
+
+Resend payment notification
+
+Resend payment notification
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+check_id = 'check_id_example' # String | 
+
+begin
+  # Resend payment notification
+  api_instance.post_check_notify(check_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_notify: #{e}"
+end
+```
+
+#### Using the post_check_notify_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> post_check_notify_with_http_info(check_id)
+
+```ruby
+begin
+  # Resend payment notification
+  data, status_code, headers = api_instance.post_check_notify_with_http_info(check_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_notify_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_check_physical
+
+> <GetCheckResponse> post_check_physical(create_physical_check_request)
+
+Create a physical check
+
+Create a new paper check
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+create_physical_check_request = Checkbook::CreatePhysicalCheckRequest.new({amount: 5.23, name: 'Widgets Inc.', recipient: Checkbook::PhysicalCheckRecipient.new({city: 'Scranton', line_1: '1234 N. 1st Street', state: 'PA', zip: '55555'})}) # CreatePhysicalCheckRequest | 
+
+begin
+  # Create a physical check
+  result = api_instance.post_check_physical(create_physical_check_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_physical: #{e}"
+end
+```
+
+#### Using the post_check_physical_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckResponse>, Integer, Hash)> post_check_physical_with_http_info(create_physical_check_request)
+
+```ruby
+begin
+  # Create a physical check
+  data, status_code, headers = api_instance.post_check_physical_with_http_info(create_physical_check_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_physical_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_physical_check_request** | [**CreatePhysicalCheckRequest**](CreatePhysicalCheckRequest.md) |  |  |
+
+### Return type
+
+[**GetCheckResponse**](GetCheckResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_check_preview
+
+> <PreviewCheckResponse> post_check_preview(preview_check_request)
+
+Preview payment
+
+Preview a new payment
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+preview_check_request = Checkbook::PreviewCheckRequest.new({amount: 3.56, name: 'Widgets Inc.'}) # PreviewCheckRequest | 
+
+begin
+  # Preview payment
+  result = api_instance.post_check_preview(preview_check_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_preview: #{e}"
+end
+```
+
+#### Using the post_check_preview_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PreviewCheckResponse>, Integer, Hash)> post_check_preview_with_http_info(preview_check_request)
+
+```ruby
+begin
+  # Preview payment
+  data, status_code, headers = api_instance.post_check_preview_with_http_info(preview_check_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PreviewCheckResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_preview_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **preview_check_request** | [**PreviewCheckRequest**](PreviewCheckRequest.md) |  |  |
+
+### Return type
+
+[**PreviewCheckResponse**](PreviewCheckResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_check_print
+
+> File post_check_print(check_id)
+
+Print a payment
+
+Print a check
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+check_id = 'check_id_example' # String | 
+
+begin
+  # Print a payment
+  result = api_instance.post_check_print(check_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_print: #{e}"
+end
+```
+
+#### Using the post_check_print_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> post_check_print_with_http_info(check_id)
+
+```ruby
+begin
+  # Print a payment
+  data, status_code, headers = api_instance.post_check_print_with_http_info(check_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_print_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_id** | **String** |  |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/pdf, application/json
+
+
+## post_check_webhook
+
+> post_check_webhook(check_id, trigger_webhook_request)
+
+Update a sandbox payment status
+
+Update a payment's status in sandbox. Triggers a sandbox check webhook notification.
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Payment.new
+check_id = 'check_id_example' # String | 
+trigger_webhook_request = Checkbook::TriggerWebhookRequest.new({status: 'PAID'}) # TriggerWebhookRequest | 
+
+begin
+  # Update a sandbox payment status
+  api_instance.post_check_webhook(check_id, trigger_webhook_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_webhook: #{e}"
+end
+```
+
+#### Using the post_check_webhook_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> post_check_webhook_with_http_info(check_id, trigger_webhook_request)
+
+```ruby
+begin
+  # Update a sandbox payment status
+  data, status_code, headers = api_instance.post_check_webhook_with_http_info(check_id, trigger_webhook_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Payment->post_check_webhook_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_id** | **String** |  |  |
+| **trigger_webhook_request** | [**TriggerWebhookRequest**](TriggerWebhookRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+