masspay_ruby_sdk 1.0.0

data/docs/SpendBackApi.md

@@ -0,0 +1,161 @@
+# MassPayRubySdk::SpendBackApi
+
+All URIs are relative to *https://api.masspay.io/v0.1.4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_user_spendbacks_by_token**](SpendBackApi.md#get_user_spendbacks_by_token) | **GET** /spendback/{user_token} | Get history of spend backs by user token |
+| [**initiate_spendback**](SpendBackApi.md#initiate_spendback) | **POST** /spendback/{user_token} | Initiate a spend back transaction |
+
+
+## get_user_spendbacks_by_token
+
+> <Array<SpendBacks>> get_user_spendbacks_by_token(user_token, opts)
+
+Get history of spend backs by user token
+
+This **GET** endpoint is used to retrieve the history of spendbacks for a specific user token. <br> You can use this endpoint to help manage your payment operations and track the usage of funds by your users. <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 list of all the historical spendbacks for the provided user token. The response will contain a JSON array with details for each spendback transaction.
+
+### 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::SpendBackApi.new
+user_token = 'usr_3f5d3fe8-a9c0-48c7-90ad-a72948730f56' # String | Token representing the user to fetch/initiate spend back
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Unique key to prevent duplicate processing
+}
+
+begin
+  # Get history of spend backs by user token
+  result = api_instance.get_user_spendbacks_by_token(user_token, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling SpendBackApi->get_user_spendbacks_by_token: #{e}"
+end
+```
+
+#### Using the get_user_spendbacks_by_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<SpendBacks>>, Integer, Hash)> get_user_spendbacks_by_token_with_http_info(user_token, opts)
+
+```ruby
+begin
+  # Get history of spend backs by user token
+  data, status_code, headers = api_instance.get_user_spendbacks_by_token_with_http_info(user_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<SpendBacks>>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling SpendBackApi->get_user_spendbacks_by_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user to fetch/initiate spend back |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+
+### Return type
+
+[**Array&lt;SpendBacks&gt;**](SpendBacks.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## initiate_spendback
+
+> <SpendBackTxnResp> initiate_spendback(user_token, opts)
+
+Initiate a spend back transaction
+
+This **POST** endpoint is used to initiate a spendback transaction to a provided user token. <br> You can use this endpoint to enable spendback transactions for your users and help them manage their funds more effectively. <br> To use this endpoint, you need to provide the `user_token` as a parameter in the URL Path, along with the required parameters in the request Body, including `client_spendback_id`, `source_token`, `source_currency_code` and `amount`. <br> The endpoint will then initiate the spendback transaction, transferring funds from the source token to the user token. The response will contain a JSON object indicating the status of the request and any relevant transaction 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::SpendBackApi.new
+user_token = 'usr_3f5d3fe8-a9c0-48c7-90ad-a72948730f56' # String | Token representing the user to fetch/initiate spend back
+opts = {
+  idempotency_key: 'idempotency_key_example', # String | Unique key to prevent duplicate processing
+  spend_back_txn: MassPayRubySdk::SpendBackTxn.new({client_spendback_id: 'aEjn345', source_token: 'source_token_example', source_currency_code: 'USD', amount: 100.5}) # SpendBackTxn | Spend back information
+}
+
+begin
+  # Initiate a spend back transaction
+  result = api_instance.initiate_spendback(user_token, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling SpendBackApi->initiate_spendback: #{e}"
+end
+```
+
+#### Using the initiate_spendback_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SpendBackTxnResp>, Integer, Hash)> initiate_spendback_with_http_info(user_token, opts)
+
+```ruby
+begin
+  # Initiate a spend back transaction
+  data, status_code, headers = api_instance.initiate_spendback_with_http_info(user_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SpendBackTxnResp>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling SpendBackApi->initiate_spendback_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user to fetch/initiate spend back |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+| **spend_back_txn** | [**SpendBackTxn**](SpendBackTxn.md) | Spend back information | [optional] |
+
+### Return type
+
+[**SpendBackTxnResp**](SpendBackTxnResp.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/SpendBackTxn.md

@@ -0,0 +1,28 @@
+# MassPayRubySdk::SpendBackTxn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_spendback_id** | **String** | A client defined spend back 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 |  |
+| **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 | [default to 'USD'] |
+| **amount** | **Float** | The amount to debit the user's wallet in source currency |  |
+| **notes** | **String** | A description for the spend back | [optional] |
+| **metadata** | **Object** | Optional JSON object with attributes that can later be searched to locate this spendback. Do not include PII as this object is not encrypted. | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::SpendBackTxn.new(
+  client_spendback_id: aEjn345,
+  source_token: null,
+  source_currency_code: USD,
+  amount: 100.5,
+  notes: Purchase of Candles. Order #14930,
+  metadata: {"group_id":541}
+)
+```
+

data/docs/SpendBackTxnResp.md

@@ -0,0 +1,22 @@
+# MassPayRubySdk::SpendBackTxnResp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **spendback_token** | **String** | Token that represents the spend back that was just created. |  |
+| **client_spendback_id** | **String** | A client defined spend back identifier. This is the unique ID assigned to the load on your system. Max 50 characters. |  |
+| **status** | **String** | Status that indicates whether the transaction was successfully processed. If `success`, everything was processed correctly. `failure` indicates a generic error. |  |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::SpendBackTxnResp.new(
+  spendback_token: null,
+  client_spendback_id: aEjn345,
+  status: null
+)
+```
+

data/docs/SpendBacks.md

@@ -0,0 +1,34 @@
+# MassPayRubySdk::SpendBacks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **spendback_token** | **String** | Token representing the load token |  |
+| **time_of_spendback** | **String** | The timestamp the spend back was created in the system. Using UTC timestamp.[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) |  |
+| **client_spendback_id** | **String** | A client defined spend back identifier. This is the unique ID assigned to the spend back on your system. Max 50 characters. |  |
+| **source_token** | **String** | Token that represents the funding source i.e. bank account, wallet. 36 characters long |  |
+| **wallet_token** | **String** | Token that represents the wallet that received the funds. 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 |  |
+| **notes** | **String** | A description for the load. Will be visible to the user receiving the load |  |
+| **metadata** | **Object** | Optional JSON object with attributes that can later be searched to locate this spendback. Do not include PII as this object is not encrypted. | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::SpendBacks.new(
+  spendback_token: spnd_bk_4275f2-bae1-488d-9d6f-20af1cd83574,
+  time_of_spendback: 2019-07-07T23:03:05,
+  client_spendback_id: aEjn345,
+  source_token: null,
+  wallet_token: null,
+  amount: 100.5,
+  source_currency_code: USD,
+  notes: Commission payment for July,
+  metadata: {"group_id":541}
+)
+```
+

data/docs/StoredUser.md

@@ -0,0 +1,56 @@
+# MassPayRubySdk::StoredUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user that was just created |  |
+| **status** | **String** | The status of the user |  |
+| **created_on** | **String** | The timestamp the user was created in the system. Using UTC timestamp.[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) |  |
+| **internal_user_id** | **String** | A client-defined identifier for the user. This is the unique ID assigned to the user on your system. Max 75 characters. Allows letters, numbers, and + , - . / _ ~ | |  |
+| **address1** | **String** | The user's street address. | [optional] |
+| **address2** | **String** | The user's street address, line 2. | [optional] |
+| **city** | **String** | The user's city. | [optional] |
+| **state_province** | **String** | The user's state/province. | [optional] |
+| **postal_code** | **String** | The user's postal code. | [optional] |
+| **country** | **String** | The user's country code. ISO_3166-1_alpha-3 code | [optional] |
+| **first_name** | **String** | The user's first name. (If Business account, the first name of the representative) |  |
+| **middle_name** | **String** | The user's middle name. (If Business account, the middle name of the representative) | [optional] |
+| **last_name** | **String** | The user's last name. (If Business account, the last name of the representative) |  |
+| **email** | **String** | The user's e-mail address. Must be unique. Cannot have two users with the same e-mail address. |  |
+| **language** | **String** | The user's preferred language of communication. If not provided, defaults to English (en) | [optional] |
+| **mobile_number** | **String** | (Optional) Mobile number of user. Allows for SMS notifications upon availability of funds | [optional] |
+| **business_name** | **String** | Company legal name (Only if Business account) | [optional] |
+| **timezone** | **String** | User's computed timezone |  |
+| **date_of_birth** | **Date** | Date of birth. (optional). Minimum 18 years old | [optional] |
+| **metadata** | **Object** | Optional JSON object with attributes that can later be searched to locate this user. Do not include PII as this object is not encrypted. | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::StoredUser.new(
+  user_token: null,
+  status: null,
+  created_on: 2019-07-07T23:03:05,
+  internal_user_id: 4324-rOzk,
+  address1: 2000 main st,
+  address2: apt D,
+  city: Santa Monica,
+  state_province: CA,
+  postal_code: 90405,
+  country: USA,
+  first_name: John,
+  middle_name: ,
+  last_name: Doe,
+  email: jdoe@gmail.com,
+  language: en,
+  mobile_number: 16502000226,
+  business_name: ABC Company,
+  timezone: America/Los_Angeles,
+  date_of_birth: Mon Mar 24 01:00:00 CET 1975,
+  metadata: {"group_id":541}
+)
+```
+

data/docs/TaxApi.md

@@ -0,0 +1,81 @@
+# MassPayRubySdk::TaxApi
+
+All URIs are relative to *https://api.masspay.io/v0.1.4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_tax_users**](TaxApi.md#get_tax_users) | **GET** /tax | Get List Of Users Annual Balance |
+
+
+## get_tax_users
+
+> <Array<TaxYearUserResp>> get_tax_users(opts)
+
+Get List Of Users Annual Balance
+
+### 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::TaxApi.new
+opts = {
+  amount_threshold: 8.14, # Float | If specified, only show users whose total balance exceeds the provided amount
+  tax_year: 56 # Integer | The year for which we would like to obtain tax information for. If none provided, defaults to previous year.
+}
+
+begin
+  # Get List Of Users Annual Balance
+  result = api_instance.get_tax_users(opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling TaxApi->get_tax_users: #{e}"
+end
+```
+
+#### Using the get_tax_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<TaxYearUserResp>>, Integer, Hash)> get_tax_users_with_http_info(opts)
+
+```ruby
+begin
+  # Get List Of Users Annual Balance
+  data, status_code, headers = api_instance.get_tax_users_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<TaxYearUserResp>>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling TaxApi->get_tax_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount_threshold** | **Float** | If specified, only show users whose total balance exceeds the provided amount | [optional] |
+| **tax_year** | **Integer** | The year for which we would like to obtain tax information for. If none provided, defaults to previous year. | [optional] |
+
+### Return type
+
+[**Array&lt;TaxYearUserResp&gt;**](TaxYearUserResp.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TaxYearUserResp.md

@@ -0,0 +1,48 @@
+# MassPayRubySdk::TaxYearUserResp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** |  | [optional] |
+| **address1** | **String** |  |  |
+| **address2** | **String** |  | [optional] |
+| **city** | **String** |  |  |
+| **state_province** | **String** |  | [optional] |
+| **postal_code** | **String** |  | [optional] |
+| **country** | **String** |  |  |
+| **first_name** | **String** |  |  |
+| **middle_name** | **String** |  | [optional] |
+| **last_name** | **String** |  |  |
+| **email** | **String** |  | [optional] |
+| **mobile_number** | **String** |  | [optional] |
+| **business_name** | **String** |  | [optional] |
+| **date_of_birth** | **String** |  |  |
+| **balance** | **Float** |  |  |
+| **tax_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::TaxYearUserResp.new(
+  user_token: null,
+  address1: null,
+  address2: null,
+  city: null,
+  state_province: null,
+  postal_code: null,
+  country: null,
+  first_name: null,
+  middle_name: null,
+  last_name: null,
+  email: null,
+  mobile_number: null,
+  business_name: null,
+  date_of_birth: null,
+  balance: null,
+  tax_id: null
+)
+```
+

data/docs/TxnHistoryResp.md

@@ -0,0 +1,52 @@
+# MassPayRubySdk::TxnHistoryResp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | Token represnting the transaction |  |
+| **type** | **String** | Type of transaction |  |
+| **time_of_txn** | **Time** | Time the transaction was created. In UTC |  |
+| **source_amount** | **Float** | Source amount |  |
+| **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 | [default to 'USD'] |
+| **destination_amount** | **Float** | The amount that was received in `destination_currency_code` |  |
+| **destination_currency_code** | **String** | The currency of the funds received. Using [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format |  |
+| **fee** | **Float** | Fee of the transaction |  |
+| **status** | **String** | Status of the transaction |  |
+| **notes** | **String** | Notes of the transaction when load or spend back | [optional] |
+| **payer_name** | **String** | Name of the payer when payout transaction | [optional] |
+| **pickup_code** | **String** | Code/pin that is required when collecting the money when payout transaction | [optional] |
+| **source_token** | **String** | Token that represents the funding source i.e. bank account, wallet. 36 characters long | [optional] |
+| **destination_token** | **String** | Token that represents the payout destination i.e. Omnex->Brazil->Bank Deposit->Itau. To be retrieved from the #pricing callback. If not provided, the last destination that was used for this user will be used. 36 characters long |  |
+| **delivery_type** | **String** | The type of service. I.e. cash pickup, home delivery, etc. Only provided for payouts | [optional] |
+| **client_transfer_id** | **String** | A client defined transfer identifier. This is the unique ID assigned to the transfer on your system. Max 50 characters. | [optional] |
+| **status_reason** | **String** | The reason for the status change. Usually would include reason for an ERROR or CANCEL status | [optional] |
+| **client_id** | **Integer** | Optional client id | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::TxnHistoryResp.new(
+  token: null,
+  type: payout,
+  time_of_txn: null,
+  source_amount: 50.1,
+  source_currency_code: USD,
+  destination_amount: 44.99,
+  destination_currency_code: null,
+  fee: 2.98,
+  status: READY_FOR_PICKUP,
+  notes: Purchase of Candles. Order #14930,
+  payer_name: Elektra,
+  pickup_code: 343432,
+  source_token: null,
+  destination_token: null,
+  delivery_type: null,
+  client_transfer_id: null,
+  status_reason: null,
+  client_id: null
+)
+```
+

data/docs/UpdateUser.md

@@ -0,0 +1,52 @@
+# MassPayRubySdk::UpdateUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The status of the user, if set to ACTIVE when current status is DEACTIVE, reactivation fee will incur |  |
+| **created_on** | **String** | The timestamp the user was created in the system. Using UTC timestamp.[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) | [optional] |
+| **internal_user_id** | **String** | A client-defined identifier for the user. This is the unique ID assigned to the user on your system. Max 75 characters. Allows letters, numbers, and + , - . / _ ~ | |  |
+| **address1** | **String** | The user's street address. |  |
+| **address2** | **String** | The user's street address, line 2. | [optional] |
+| **city** | **String** | The user's city. |  |
+| **state_province** | **String** | The user's state/province. |  |
+| **postal_code** | **String** | The user's postal code. |  |
+| **country** | **String** | The user's country code. ISO_3166-1_alpha-3 code |  |
+| **first_name** | **String** | The user's first name. |  |
+| **middle_name** | **String** | The user's middle name. | [optional] |
+| **last_name** | **String** | The user's last name. |  |
+| **email** | **String** | The user's e-mail address. Must be unique. Cannot have two users with the same e-mail address. |  |
+| **language** | **String** | The user's preferred language of communication. If not provided, defaults to English (en) | [optional] |
+| **mobile_number** | **String** | (Optional) Mobile number of user. Allows for SMS notifications upon availability of funds | [optional] |
+| **business_name** | **String** | Company legal name (Only if Business account) | [optional] |
+| **date_of_birth** | **Date** | Date of birth. (optional). Minimum 18 years old | [optional] |
+| **metadata** | **Object** | Optional JSON object with attributes that can later be searched to locate this user. Do not include PII as this object is not encrypted. | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::UpdateUser.new(
+  status: null,
+  created_on: 2019-07-07T23:03:05,
+  internal_user_id: 4324-rOzk,
+  address1: 2000 main st,
+  address2: apt D,
+  city: Santa Monica,
+  state_province: CA,
+  postal_code: 90405,
+  country: USA,
+  first_name: John,
+  middle_name: ,
+  last_name: Doe,
+  email: jdoe@gmail.com,
+  language: en,
+  mobile_number: 16502000226,
+  business_name: ABC Company,
+  date_of_birth: Mon Mar 24 01:00:00 CET 1975,
+  metadata: {"group_id":541}
+)
+```
+

data/docs/User.md

@@ -0,0 +1,50 @@
+# MassPayRubySdk::User
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **internal_user_id** | **String** | A client-defined identifier for the user. This is the unique ID assigned to the user on your system. Max 75 characters. Allows letters, numbers, and + , - . / _ ~ | |  |
+| **address1** | **String** | The user's street address. Required in order to process a payout. | [optional] |
+| **address2** | **String** | The user's street address, line 2. | [optional] |
+| **city** | **String** | The user's city. Required in order to process a payout. | [optional] |
+| **state_province** | **String** | The user's state/province. | [optional] |
+| **postal_code** | **String** | The user's postal code. | [optional] |
+| **country** | **String** | The user's country code. [ISO_3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code. Required in order to process a payout. |  |
+| **first_name** | **String** | The user's first name. (If Business account, the first name of the representative) |  |
+| **middle_name** | **String** | The user's middle name. (If Business account, the middle name of the representative) | [optional] |
+| **last_name** | **String** | The user's last name. (If Business account, the last name of the representative) |  |
+| **email** | **String** | The user's e-mail address. Must be unique. Cannot have two users with the same e-mail address. |  |
+| **language** | **String** | The user's preferred language of communication. If not provided, defaults to English (en) | [optional] |
+| **mobile_number** | **String** | (Optional) Mobile number of user. Allows for SMS notifications upon availability of funds | [optional] |
+| **business_name** | **String** | Company legal name (Only if Business account) | [optional] |
+| **date_of_birth** | **Date** | Date of birth. (optional). Minimum 18 years old | [optional] |
+| **metadata** | **Object** | Optional JSON object with attributes that can later be searched to locate this user. Do not include PII as this object is not encrypted. | [optional] |
+| **notify_user** | **Boolean** | Should we notify the user via email that their user has been created in the system? They will receive instructions to establish such account. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::User.new(
+  internal_user_id: 4324-rOzk,
+  address1: 2000 main st,
+  address2: apt D,
+  city: Santa Monica,
+  state_province: CA,
+  postal_code: 90405,
+  country: USA,
+  first_name: John,
+  middle_name: ,
+  last_name: Doe,
+  email: jdoe@gmail.com,
+  language: en,
+  mobile_number: 16502000226,
+  business_name: ABC Company,
+  date_of_birth: Mon Mar 24 01:00:00 CET 1975,
+  metadata: {"group_id":541},
+  notify_user: null
+)
+```
+