masspay_ruby_sdk 1.0.0

data/docs/LoadApi.md

@@ -0,0 +1,621 @@
+# MassPayRubySdk::LoadApi
+
+All URIs are relative to *https://api.masspay.io/v0.1.4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cancel_user_load**](LoadApi.md#cancel_user_load) | **DELETE** /load/{user_token} | Reverse a user load |
+| [**create_autopay_rule**](LoadApi.md#create_autopay_rule) | **POST** /wallet/{user_token}/{wallet_token}/autopay | Add autopay rule |
+| [**delete_autopay_rule**](LoadApi.md#delete_autopay_rule) | **DELETE** /wallet/{user_token}/{wallet_token}/autopay | Delete autopay rule |
+| [**get_autopay_rules**](LoadApi.md#get_autopay_rules) | **GET** /wallet/{user_token}/{wallet_token}/autopay | Get all autopay rules |
+| [**get_user_loads_by_token**](LoadApi.md#get_user_loads_by_token) | **GET** /load/{user_token} | Get history of loads by user token |
+| [**load_user**](LoadApi.md#load_user) | **POST** /load/{user_token} | Initiate a load transaction |
+| [**load_user_token_put**](LoadApi.md#load_user_token_put) | **PUT** /load/{user_token} | Resend Load Notification |
+| [**resend_balance_notification**](LoadApi.md#resend_balance_notification) | **PUT** /wallet/{user_token} | Resend Balance Notification |
+
+
+## cancel_user_load
+
+> cancel_user_load(user_token, load_token, opts)
+
+Reverse a user load
+
+This **DELETE** endpoint is used to reverse a load transaction that was already processed, allowing you to remove funds from a user's wallet. <br> To use this endpoint, you need to provide the `user_token` as a parameter in the URL Path, and the load_token as a parameter in the Query string. <br> The endpoint will then attempt to reverse the specified load transaction. If the load is still in scheduled status, it will be marked as cancelled.
+
+### Examples
+
+```ruby
+require 'time'
+require 'masspay_ruby_sdk'
+# setup authorization
+MassPayRubySdk.configure do |config|
+  # Configure API key authorization: AUTHORIZER_NAME
+  config.api_key['AUTHORIZER_NAME'] = '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['AUTHORIZER_NAME'] = 'Bearer'
+end
+
+api_instance = MassPayRubySdk::LoadApi.new
+user_token = 'user_token_example' # String | Token representing the user to load/fetch loads for
+load_token = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Load token
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Unique key to prevent duplicate processing
+}
+
+begin
+  # Reverse a user load
+  api_instance.cancel_user_load(user_token, load_token, opts)
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->cancel_user_load: #{e}"
+end
+```
+
+#### Using the cancel_user_load_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)> cancel_user_load_with_http_info(user_token, load_token, opts)
+
+```ruby
+begin
+  # Reverse a user load
+  data, status_code, headers = api_instance.cancel_user_load_with_http_info(user_token, load_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->cancel_user_load_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user to load/fetch loads for |  |
+| **load_token** | **String** | Load token |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## create_autopay_rule
+
+> <AutopayResp> create_autopay_rule(user_token, wallet_token, opts)
+
+Add autopay rule
+
+This **POST** endpoint is used to add an autopay rule that will initiate a payout whenever the provided wallet token is loaded. <br> You can use this endpoint to create an autopay rule that automatically sends a percentage of incoming load to a specific destination. <br> To use this endpoint, you need to provide the `user_token` and `wallet_token` as required parameters in the URL Path, and the `destination_token` and percentage of incoming load that should be autopaid to the `destination_token` in the request Body. <br> The response will include a JSON object containing the details of the created autopay rule, including the token, `destination_token` and percentage.
+
+### Examples
+
+```ruby
+require 'time'
+require 'masspay_ruby_sdk'
+# setup authorization
+MassPayRubySdk.configure do |config|
+  # Configure API key authorization: AUTHORIZER_NAME
+  config.api_key['AUTHORIZER_NAME'] = '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['AUTHORIZER_NAME'] = 'Bearer'
+end
+
+api_instance = MassPayRubySdk::LoadApi.new
+user_token = 'user_token_example' # String | Token representing the user who owns the wallet
+wallet_token = 'wallet_token_example' # String | Token representing the wallet
+opts = {
+  autopay_rule: MassPayRubySdk::AutopayRule.new({destination_token: 'dest_d2138fd0-00be-45a8-985f-4f5bde500962', percentage: 50}) # AutopayRule | Autopay rule configuration
+}
+
+begin
+  # Add autopay rule
+  result = api_instance.create_autopay_rule(user_token, wallet_token, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->create_autopay_rule: #{e}"
+end
+```
+
+#### Using the create_autopay_rule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AutopayResp>, Integer, Hash)> create_autopay_rule_with_http_info(user_token, wallet_token, opts)
+
+```ruby
+begin
+  # Add autopay rule
+  data, status_code, headers = api_instance.create_autopay_rule_with_http_info(user_token, wallet_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AutopayResp>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->create_autopay_rule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user who owns the wallet |  |
+| **wallet_token** | **String** | Token representing the wallet |  |
+| **autopay_rule** | [**AutopayRule**](AutopayRule.md) | Autopay rule configuration | [optional] |
+
+### Return type
+
+[**AutopayResp**](AutopayResp.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_autopay_rule
+
+> delete_autopay_rule(user_token, wallet_token, token)
+
+Delete autopay rule
+
+This **DELETE** endpoint is used to delete an existing autopay rule. <br> You can use this endpoint to remove an autopay rule that is no longer needed. <br> To use this endpoint, you need to provide the `user_token` and `wallet_token` as required parameters in the URL Path, and the token of the autopay rule you wish to delete in the request Body. <br> The response will include a message indicating the success of the deletion.
+
+### Examples
+
+```ruby
+require 'time'
+require 'masspay_ruby_sdk'
+# setup authorization
+MassPayRubySdk.configure do |config|
+  # Configure API key authorization: AUTHORIZER_NAME
+  config.api_key['AUTHORIZER_NAME'] = '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['AUTHORIZER_NAME'] = 'Bearer'
+end
+
+api_instance = MassPayRubySdk::LoadApi.new
+user_token = 'user_token_example' # String | Token representing the user who owns the wallet
+wallet_token = 'wallet_token_example' # String | Token representing the wallet
+token = 'autopay_3684cc43-fe3b-4994-8ca1-7dc0db94430f' # String | Autopay token to delete
+
+begin
+  # Delete autopay rule
+  api_instance.delete_autopay_rule(user_token, wallet_token, token)
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->delete_autopay_rule: #{e}"
+end
+```
+
+#### Using the delete_autopay_rule_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_autopay_rule_with_http_info(user_token, wallet_token, token)
+
+```ruby
+begin
+  # Delete autopay rule
+  data, status_code, headers = api_instance.delete_autopay_rule_with_http_info(user_token, wallet_token, token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->delete_autopay_rule_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user who owns the wallet |  |
+| **wallet_token** | **String** | Token representing the wallet |  |
+| **token** | **String** | Autopay token to delete |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_autopay_rules
+
+> <Array<AutopayResp>> get_autopay_rules(user_token, wallet_token)
+
+Get all autopay rules
+
+This **GET** endpoint is used to retrieve all autopay rules currently applied to the provided wallet token. <br> You can use this endpoint to obtain information about the autopay rules associated with the wallet. <br> To use this endpoint, you need to provide the `user_token` and `wallet_token` as required parameters in the URL Path. <br> The response will include a JSON array containing details for each autopay rule, including the token, `destination_token` and percentage.
+
+### Examples
+
+```ruby
+require 'time'
+require 'masspay_ruby_sdk'
+# setup authorization
+MassPayRubySdk.configure do |config|
+  # Configure API key authorization: AUTHORIZER_NAME
+  config.api_key['AUTHORIZER_NAME'] = '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['AUTHORIZER_NAME'] = 'Bearer'
+end
+
+api_instance = MassPayRubySdk::LoadApi.new
+user_token = 'user_token_example' # String | Token representing the user who owns the wallet
+wallet_token = 'wallet_token_example' # String | Token representing the wallet
+
+begin
+  # Get all autopay rules
+  result = api_instance.get_autopay_rules(user_token, wallet_token)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->get_autopay_rules: #{e}"
+end
+```
+
+#### Using the get_autopay_rules_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<AutopayResp>>, Integer, Hash)> get_autopay_rules_with_http_info(user_token, wallet_token)
+
+```ruby
+begin
+  # Get all autopay rules
+  data, status_code, headers = api_instance.get_autopay_rules_with_http_info(user_token, wallet_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<AutopayResp>>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->get_autopay_rules_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user who owns the wallet |  |
+| **wallet_token** | **String** | Token representing the wallet |  |
+
+### Return type
+
+[**Array&lt;AutopayResp&gt;**](AutopayResp.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_user_loads_by_token
+
+> <Array<Loads>> get_user_loads_by_token(user_token, opts)
+
+Get history of loads by user token
+
+This **GET** endpoint is used to retrieve a transaction history of all loads that were made to the provided user token, including scheduled loads. <br> You can use this endpoint to obtain a comprehensive history of loads for the user token, allowing you to track and analyze their incoming payments over time. <br> To use this endpoint, you need to provide the `user_token` as a parameter in the URL Path. <br> The endpoint will then return a JSON array of load transactions, each including transactions details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'masspay_ruby_sdk'
+# setup authorization
+MassPayRubySdk.configure do |config|
+  # Configure API key authorization: AUTHORIZER_NAME
+  config.api_key['AUTHORIZER_NAME'] = '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['AUTHORIZER_NAME'] = 'Bearer'
+end
+
+api_instance = MassPayRubySdk::LoadApi.new
+user_token = 'user_token_example' # String | The user token that needs to be fetched.
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Unique key to prevent duplicate processing
+}
+
+begin
+  # Get history of loads by user token
+  result = api_instance.get_user_loads_by_token(user_token, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->get_user_loads_by_token: #{e}"
+end
+```
+
+#### Using the get_user_loads_by_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Loads>>, Integer, Hash)> get_user_loads_by_token_with_http_info(user_token, opts)
+
+```ruby
+begin
+  # Get history of loads by user token
+  data, status_code, headers = api_instance.get_user_loads_by_token_with_http_info(user_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Loads>>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->get_user_loads_by_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | The user token that needs to be fetched. |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+
+### Return type
+
+[**Array&lt;Loads&gt;**](Loads.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## load_user
+
+> <LoadTxnResp> load_user(user_token, load_txn, opts)
+
+Initiate a load transaction
+
+This **POST** endpoint is used to initiate a load transaction, allowing you to add funds to a user token's wallet. <br> To use this endpoint, you need to provide the `user_token` as a parameter in the URL Path. You also need to provide the `client_load_id`, `source_token`, and amount as JSON parameters in the Request Body. The `client_load_id` is a unique identifier for the transaction that you can use to track it, while the `source_token` is the token or account from which the funds will be loaded. The amount parameter specifies the amount of funds to be loaded into the user's wallet. <br> The response will contain a JSON object indicating the status of the load transaction and any relevant details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'masspay_ruby_sdk'
+# setup authorization
+MassPayRubySdk.configure do |config|
+  # Configure API key authorization: AUTHORIZER_NAME
+  config.api_key['AUTHORIZER_NAME'] = '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['AUTHORIZER_NAME'] = 'Bearer'
+end
+
+api_instance = MassPayRubySdk::LoadApi.new
+user_token = 'user_token_example' # String | Token representing the user to load
+load_txn = MassPayRubySdk::LoadTxn.new({client_load_id: 'aEjn345', source_token: 'ba4275f2-bae1-488d-9d6f-20af1cd83574', amount: 100.5}) # LoadTxn | Load information
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Unique key to prevent duplicate processing
+}
+
+begin
+  # Initiate a load transaction
+  result = api_instance.load_user(user_token, load_txn, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->load_user: #{e}"
+end
+```
+
+#### Using the load_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LoadTxnResp>, Integer, Hash)> load_user_with_http_info(user_token, load_txn, opts)
+
+```ruby
+begin
+  # Initiate a load transaction
+  data, status_code, headers = api_instance.load_user_with_http_info(user_token, load_txn, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LoadTxnResp>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->load_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user to load |  |
+| **load_txn** | [**LoadTxn**](LoadTxn.md) | Load information |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+
+### Return type
+
+[**LoadTxnResp**](LoadTxnResp.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## load_user_token_put
+
+> <ResendBalanceNotification200Response> load_user_token_put(user_token, load_token, opts)
+
+Resend Load Notification
+
+This **PUT** endpoint is used to resend a load notification to the user associated with the provided `user_token` for a specific load transaction. <br> You can use this endpoint to help ensure that users are notified promptly and accurately of any incoming funds or other important payment events. <br> To use this endpoint, you need to provide the `user_token` as a parameter in the URL Path, and the `load_token` as a parameter in the Query string. The endpoint will then resend a notification to the user for the specified load transaction. <br> The response will contain a JSON object indicating the status of the request.
+
+### Examples
+
+```ruby
+require 'time'
+require 'masspay_ruby_sdk'
+# setup authorization
+MassPayRubySdk.configure do |config|
+  # Configure API key authorization: AUTHORIZER_NAME
+  config.api_key['AUTHORIZER_NAME'] = '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['AUTHORIZER_NAME'] = 'Bearer'
+end
+
+api_instance = MassPayRubySdk::LoadApi.new
+user_token = 'user_token_example' # String | Token representing the user to load/fetch loads for
+load_token = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Load token
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Unique key to prevent duplicate processing
+}
+
+begin
+  # Resend Load Notification
+  result = api_instance.load_user_token_put(user_token, load_token, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->load_user_token_put: #{e}"
+end
+```
+
+#### Using the load_user_token_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResendBalanceNotification200Response>, Integer, Hash)> load_user_token_put_with_http_info(user_token, load_token, opts)
+
+```ruby
+begin
+  # Resend Load Notification
+  data, status_code, headers = api_instance.load_user_token_put_with_http_info(user_token, load_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResendBalanceNotification200Response>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->load_user_token_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user to load/fetch loads for |  |
+| **load_token** | **String** | Load token |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+
+### Return type
+
+[**ResendBalanceNotification200Response**](ResendBalanceNotification200Response.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## resend_balance_notification
+
+> <ResendBalanceNotification200Response> resend_balance_notification(user_token, opts)
+
+Resend Balance Notification
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'masspay_ruby_sdk'
+# setup authorization
+MassPayRubySdk.configure do |config|
+  # Configure API key authorization: AUTHORIZER_NAME
+  config.api_key['AUTHORIZER_NAME'] = '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['AUTHORIZER_NAME'] = 'Bearer'
+end
+
+api_instance = MassPayRubySdk::LoadApi.new
+user_token = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Token representing the user who owns the wallet
+opts = {
+  idempotency_key: 'idempotency_key_example', # String | Unique key to prevent duplicate processing
+  wallet_token: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Optional wallet token. If none is provided, select the first wallet available
+}
+
+begin
+  # Resend Balance Notification
+  result = api_instance.resend_balance_notification(user_token, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->resend_balance_notification: #{e}"
+end
+```
+
+#### Using the resend_balance_notification_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResendBalanceNotification200Response>, Integer, Hash)> resend_balance_notification_with_http_info(user_token, opts)
+
+```ruby
+begin
+  # Resend Balance Notification
+  data, status_code, headers = api_instance.resend_balance_notification_with_http_info(user_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResendBalanceNotification200Response>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling LoadApi->resend_balance_notification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user who owns the wallet |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+| **wallet_token** | **String** | Optional wallet token. If none is provided, select the first wallet available | [optional] |
+
+### Return type
+
+[**ResendBalanceNotification200Response**](ResendBalanceNotification200Response.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/LoadTxn.md

@@ -0,0 +1,32 @@
+# MassPayRubySdk::LoadTxn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_load_id** | **String** | A client defined load identifier. This is the unique ID assigned to the load on your system. Max 50 characters. |  |
+| **source_token** | **String** | Token that represents the funding source i.e. bank account, wallet. 36 characters long |  |
+| **amount** | **Float** | The amount to credit the user's wallet in source currency |  |
+| **source_currency_code** | **String** | The currency originating balance is stored in. Using [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. In most cases this value will be USD, and therefore the defaut value if none is provided. There is a special currency case for PNTS - learn more [here] (#Points) | [optional] |
+| **notes** | **String** | A description for the load. Will be visible to the user receiving the load | [optional] |
+| **notify_user** | **Boolean** | Should we notify the user via email that they've received a load? If the user has no existing account, they will receive instructions to establish such account. | [optional][default to true] |
+| **time_to_process** | **String** | Future date/time to process the load on. If none is provided, it is processed right away. Time to be provided in UTC [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) | [optional] |
+| **metadata** | **Object** | Optional JSON object with attributes that can later be searched to locate this load. Do not include PII as this object is not encrypted. | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::LoadTxn.new(
+  client_load_id: aEjn345,
+  source_token: ba4275f2-bae1-488d-9d6f-20af1cd83574,
+  amount: 100.5,
+  source_currency_code: USD,
+  notes: Commission payment for July,
+  notify_user: null,
+  time_to_process: The date/time to process the load. In UTC. 2021-02-25T23:00:00Z,
+  metadata: {"group_id":541}
+)
+```
+

data/docs/LoadTxnResp.md

@@ -0,0 +1,20 @@
+# MassPayRubySdk::LoadTxnResp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **load_token** | **String** | Token that represents the load that was just created. |  |
+| **status** | **String** | Status that indicates whether the transaction was successfully processed. If `COMPLETED`, the load was successfully processed. `CANCELLED` indicates a generic error. and `SCHEDULED` means the load was successfully scheduled |  |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::LoadTxnResp.new(
+  load_token: ba4275f2-bae1-488d-9d6f-20af1cd83574,
+  status: null
+)
+```
+