masspay_ruby_sdk 1.0.0

data/docs/Loads.md

@@ -0,0 +1,36 @@
+# MassPayRubySdk::Loads
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **load_token** | **String** | Token representing the load token |  |
+| **time_of_load** | **String** | The timestamp the load was processed. If not processed yet, a future date will be returned. Using UTC timestamp.[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) |  |
+| **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 |  |
+| **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 |  |
+| **status** | **String** | Status of the load |  |
+| **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::Loads.new(
+  load_token: ld_ba4275f2-bae1-488d-9d6f-20af1cd83574,
+  time_of_load: 2019-07-07T23:03:05,
+  client_load_id: aEjn345,
+  source_token: null,
+  wallet_token: null,
+  amount: 100.5,
+  source_currency_code: USD,
+  notes: Commission payment for July,
+  status: COMPLETED,
+  metadata: {"group_id":541}
+)
+```
+

data/docs/PayoutApi.md

@@ -0,0 +1,403 @@
+# MassPayRubySdk::PayoutApi
+
+All URIs are relative to *https://api.masspay.io/v0.1.4*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**commit_payout_txn**](PayoutApi.md#commit_payout_txn) | **PUT** /payout/{user_token}/{payout_token} | Commit payout transaction |
+| [**get_payout_status**](PayoutApi.md#get_payout_status) | **GET** /payout/{user_token}/{payout_token} | Get status of a payout by payout token |
+| [**get_transaction_confirmation_details**](PayoutApi.md#get_transaction_confirmation_details) | **PATCH** /payout/{user_token}/{payout_token} | Get transaction confirmation details |
+| [**get_user_payouts_by_token**](PayoutApi.md#get_user_payouts_by_token) | **GET** /payout/{user_token} | Get history of payouts by user token |
+| [**initiate_payout**](PayoutApi.md#initiate_payout) | **POST** /payout/{user_token} | Initiate a payout transaction |
+
+
+## commit_payout_txn
+
+> <PayoutTxnCommitResp> commit_payout_txn(user_token, payout_token, opts)
+
+Commit payout transaction
+
+This **PUT** endpoint is used to commit a previously created payout transaction. <br> Once a payout transaction is created, you can use this endpoint to commit the transaction and initiate the actual payout. <br> To use this endpoint, you need to provide the `user_token` and `payout_token` of the payout transaction you want to commit in the URL Path. <br> The response will include a JSON object containing details about the committed payout transaction, including the `payout_token`, `payout_status`, `pickup_code` and possible errors.
+
+### 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::PayoutApi.new
+user_token = 'user_token_example' # String | Token representing the user to pay out
+payout_token = 'payout_token_example' # String | Token representing the trsanaction. Retrieved from `/payout/{user_token}`
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Unique key to prevent duplicate processing
+}
+
+begin
+  # Commit payout transaction
+  result = api_instance.commit_payout_txn(user_token, payout_token, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling PayoutApi->commit_payout_txn: #{e}"
+end
+```
+
+#### Using the commit_payout_txn_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PayoutTxnCommitResp>, Integer, Hash)> commit_payout_txn_with_http_info(user_token, payout_token, opts)
+
+```ruby
+begin
+  # Commit payout transaction
+  data, status_code, headers = api_instance.commit_payout_txn_with_http_info(user_token, payout_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PayoutTxnCommitResp>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling PayoutApi->commit_payout_txn_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user to pay out |  |
+| **payout_token** | **String** | Token representing the trsanaction. Retrieved from &#x60;/payout/{user_token}&#x60; |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+
+### Return type
+
+[**PayoutTxnCommitResp**](PayoutTxnCommitResp.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_payout_status
+
+> <PayoutTxnResp> get_payout_status(user_token, payout_token, opts)
+
+Get status of a payout by payout token
+
+This **GET** endpoint is used to retrieve the status of a payout transaction for a user with the specified token and payout token. <br> You can use this endpoint to check the status of a specific payout transaction, including whether the payout has been successfully processed or if there was an error. <br> To use this endpoint, you need to provide the `user_token` and `payout_token` in the URL Path. <br> The response will include a JSON object containing details about the payout 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::PayoutApi.new
+user_token = 'user_token_example' # String | Token representing the user to pay out
+payout_token = 'payout_ed75acf2-1c35-4073-9adc-389084d1e96b' # String | Token representing the trsanaction. Retrieved from `/payout/{user_token}`
+opts = {
+  idempotency_key: 'idempotency_key_example', # String | Unique key to prevent duplicate processing
+  force_status_update: true, # Boolean | Attempts to get an updated status update from the payout destination
+  include_payer_logo: true # Boolean | Whether to include the payer logo in base64 format. 
+}
+
+begin
+  # Get status of a payout by payout token
+  result = api_instance.get_payout_status(user_token, payout_token, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling PayoutApi->get_payout_status: #{e}"
+end
+```
+
+#### Using the get_payout_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PayoutTxnResp>, Integer, Hash)> get_payout_status_with_http_info(user_token, payout_token, opts)
+
+```ruby
+begin
+  # Get status of a payout by payout token
+  data, status_code, headers = api_instance.get_payout_status_with_http_info(user_token, payout_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PayoutTxnResp>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling PayoutApi->get_payout_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user to pay out |  |
+| **payout_token** | **String** | Token representing the trsanaction. Retrieved from &#x60;/payout/{user_token}&#x60; |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+| **force_status_update** | **Boolean** | Attempts to get an updated status update from the payout destination | [optional][default to false] |
+| **include_payer_logo** | **Boolean** | Whether to include the payer logo in base64 format.  | [optional] |
+
+### Return type
+
+[**PayoutTxnResp**](PayoutTxnResp.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_transaction_confirmation_details
+
+> <GetTransactionConfirmationDetails200Response> get_transaction_confirmation_details(user_token, payout_token, opts)
+
+Get transaction confirmation details
+
+This **PATCH** endpoint is used to obtain a PDF document with all the details of a payout transaction for a user with the specified token and payout token. <br> You can use this endpoint to obtain confirmation details about a specific payout transaction. <br> To use this endpoint, you need to provide the `user_token` and `payout_token` in the URL Path. <br> The response will include a PDF document containing all the details of the payout 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::PayoutApi.new
+user_token = 'user_token_example' # String | Token representing the user to pay out
+payout_token = 'payout_ed75acf2-1c35-4073-9adc-389084d1e96b' # String | Token representing the trsanaction. Retrieved from `/payout/{user_token}`
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Unique key to prevent duplicate processing
+}
+
+begin
+  # Get transaction confirmation details
+  result = api_instance.get_transaction_confirmation_details(user_token, payout_token, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling PayoutApi->get_transaction_confirmation_details: #{e}"
+end
+```
+
+#### Using the get_transaction_confirmation_details_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetTransactionConfirmationDetails200Response>, Integer, Hash)> get_transaction_confirmation_details_with_http_info(user_token, payout_token, opts)
+
+```ruby
+begin
+  # Get transaction confirmation details
+  data, status_code, headers = api_instance.get_transaction_confirmation_details_with_http_info(user_token, payout_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetTransactionConfirmationDetails200Response>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling PayoutApi->get_transaction_confirmation_details_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user to pay out |  |
+| **payout_token** | **String** | Token representing the trsanaction. Retrieved from &#x60;/payout/{user_token}&#x60; |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+
+### Return type
+
+[**GetTransactionConfirmationDetails200Response**](GetTransactionConfirmationDetails200Response.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_user_payouts_by_token
+
+> <Array<PayoutTxnResp>> get_user_payouts_by_token(user_token, opts)
+
+Get history of payouts by user token
+
+This **GET** endpoint is used to retrieve the payout history for a user with the specified token. <br> You can use this endpoint to view all payouts made to a user, including the `payout_token`, `destinantion_token` and `destination_amount`. <br> To use this endpoint, you need to provide the user token of the recipient in the URL Path. <br> The response will include a JSON object containing an array of payout transactions for the specified user, with each transaction including details such as the transaction ID, payout amount, currency, payout status, and date and time of the payout.
+
+### 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::PayoutApi.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
+  include_payer_logos: true # Boolean | Whether to include the payers logo in base64 format. 
+}
+
+begin
+  # Get history of payouts by user token
+  result = api_instance.get_user_payouts_by_token(user_token, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling PayoutApi->get_user_payouts_by_token: #{e}"
+end
+```
+
+#### Using the get_user_payouts_by_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<PayoutTxnResp>>, Integer, Hash)> get_user_payouts_by_token_with_http_info(user_token, opts)
+
+```ruby
+begin
+  # Get history of payouts by user token
+  data, status_code, headers = api_instance.get_user_payouts_by_token_with_http_info(user_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<PayoutTxnResp>>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling PayoutApi->get_user_payouts_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] |
+| **include_payer_logos** | **Boolean** | Whether to include the payers logo in base64 format.  | [optional][default to false] |
+
+### Return type
+
+[**Array&lt;PayoutTxnResp&gt;**](PayoutTxnResp.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## initiate_payout
+
+> <PayoutTxnResp> initiate_payout(user_token, payout_txn, opts)
+
+Initiate a payout transaction
+
+This **POST** endpoint is used to initiate a payout transaction from your account to a user with a specified token. <br> You can use this endpoint to pay out funds to your users, such as payments for services rendered or rewards for completing tasks. To use this endpoint, you need to provide the user token of the recipient in the URL Path. <br> The request body should include the funding source (`source_token`), payout destination (`destination_token`) and specify in which currency the payout should be made (`destination_currency_code`). <br> As a response API will return all details about your payout 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::PayoutApi.new
+user_token = 'user_token_example' # String | Token representing the user to pay out
+payout_txn = MassPayRubySdk::PayoutTxn.new({destination_currency_code: 'MXN', source_token: 'source_token_example', destination_token: 'destination_token_example'}) # PayoutTxn | Payout parameters for a quote
+opts = {
+  idempotency_key: 'idempotency_key_example', # String | Unique key to prevent duplicate processing
+  limit: 8.14 # Float | Limit amount for transaction amount + fee. If fee + amount are higher than the limit, the output will automatically adjust to maximize the possible amount sent
+}
+
+begin
+  # Initiate a payout transaction
+  result = api_instance.initiate_payout(user_token, payout_txn, opts)
+  p result
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling PayoutApi->initiate_payout: #{e}"
+end
+```
+
+#### Using the initiate_payout_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PayoutTxnResp>, Integer, Hash)> initiate_payout_with_http_info(user_token, payout_txn, opts)
+
+```ruby
+begin
+  # Initiate a payout transaction
+  data, status_code, headers = api_instance.initiate_payout_with_http_info(user_token, payout_txn, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PayoutTxnResp>
+rescue MassPayRubySdk::ApiError => e
+  puts "Error when calling PayoutApi->initiate_payout_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_token** | **String** | Token representing the user to pay out |  |
+| **payout_txn** | [**PayoutTxn**](PayoutTxn.md) | Payout parameters for a quote |  |
+| **idempotency_key** | **String** | Unique key to prevent duplicate processing | [optional] |
+| **limit** | **Float** | Limit amount for transaction amount + fee. If fee + amount are higher than the limit, the output will automatically adjust to maximize the possible amount sent | [optional] |
+
+### Return type
+
+[**PayoutTxnResp**](PayoutTxnResp.md)
+
+### Authorization
+
+[AUTHORIZER_NAME](../README.md#AUTHORIZER_NAME)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PayoutTxn.md

@@ -0,0 +1,36 @@
+# MassPayRubySdk::PayoutTxn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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 | [optional][default to 'USD'] |
+| **destination_currency_code** | **String** | The currency the funds will be deposited into. Using [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format |  |
+| **source_token** | **String** | Token that represents the funding source i.e. bank account, wallet. 36 characters long |  |
+| **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 |  |
+| **destination_amount** | **Float** | The amount to be sent for payout in source currency. i.e USD. Must be provided if source_amount is empty | [optional] |
+| **source_amount** | **Float** | The amount to be received by the payout in source currency. i.e USD. Must be provided if destination_amount is empty | [optional] |
+| **attr_set_token** | **String** | Token that represents set of attributes that associated with destination_token. For example, bank account, mobile account, wallet id, etc. If not provided, uses the last one used. 36 characters long | [optional] |
+| **metadata** | **String** | Optional JSON object with attributes that can later be searched to locate this payout. Do not include PII as this object is not encrypted. | [optional] |
+| **notify_user** | **Boolean** | Should we notify the user via email/sms about status updates for this payout? | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::PayoutTxn.new(
+  client_transfer_id: aEjn345,
+  source_currency_code: USD,
+  destination_currency_code: MXN,
+  source_token: null,
+  destination_token: null,
+  destination_amount: 100.5,
+  source_amount: 100.5,
+  attr_set_token: null,
+  metadata: {"group_id":541},
+  notify_user: null
+)
+```
+

data/docs/PayoutTxnCommitResp.md

@@ -0,0 +1,24 @@
+# MassPayRubySdk::PayoutTxnCommitResp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payout_token** | **String** | Token that represents the transaction that was just created. |  |
+| **status** | **String** | Status that indicates whether the transaction was successfully processed. If `success`, everything was processed correctly. `failure` indicates a generic error. `addtl_attr_req` indicates that in order to process this transaction, additional attributes are required to be updated for this customer. `ex_rate_expired` indicates that the transaction exchange rate has expired and a new transaction has to be created. |  |
+| **pickup_code** | **String** | Code/pin that is required when collecting the money. Should be provided to the recipient to present to payout location. | [optional] |
+| **errors** | **String** | Description of errors preventing transfer from being injected. | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::PayoutTxnCommitResp.new(
+  payout_token: null,
+  status: null,
+  pickup_code: 54238173,
+  errors: Duplicate transfer
+)
+```
+

data/docs/PayoutTxnResp.md

@@ -0,0 +1,60 @@
+# MassPayRubySdk::PayoutTxnResp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payout_token** | **String** | Token that represents the transaction that was just created. Need to be used to commit the transaction in `/payout/{user_token}/{payout_token}`. Value would be NSF if there are not enough funds in the `source_token`. Value would be `DUPLICATE` if there is a duplicate `client_transfer_id`. |  |
+| **client_transfer_id** | **String** | A client defined transfer identifier. This is the unique ID assigned to the transfer on your system. Max 50 characters. |  |
+| **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 |  |
+| **destination_currency_code** | **String** | The currency the funds will be deposited into. Using [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format |  |
+| **source_token** | **String** | Token that represents the funding source i.e. your bank account, user's wallet. 36 characters long |  |
+| **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 |  |
+| **destination_amount** | **Float** | The amount to be sent for payout in source currency. i.e USD. Must be provided if source_amount is empty |  |
+| **source_amount** | **Float** | The amount to be received by the payout in source currency. i.e USD. Must be provided if destination_amount is empty |  |
+| **attr_set_token** | **String** | Token that represents set of attributes that associated with destination_token. For example, bank account, mobile account, wallet id, etc. If not provided, uses the last one used. 36 characters long |  |
+| **exchange_rate** | **Float** | The exchange rate to convert source_amount to destination_amount |  |
+| **fee** | **Float** | Fee to be charged for the transaction |  |
+| **expiration** | **String** | The time and date at which the transaction will expire. The transaction has to be finalized before this time. Transactions are valid for 2 minutes from creation time. If expired, a new transaction has to be created. |  |
+| **pickup_code** | **String** | Code/pin that is required when collecting the money. Should be provided to the recipient to present to payout location. |  |
+| **status** | **String** | The status of the transaction |  |
+| **payer_logo** | **String** | base64 representation of the payer logo | [optional] |
+| **payer_name** | **String** | Name of payer |  |
+| **delivery_type** | **String** | The type of delivery |  |
+| **country_code** | **String** | Country code [ISO_3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) |  |
+| **metadata** | **Object** | Optional JSON object with attributes that can later be searched to locate this payout. Do not include PII as this object is not encrypted. | [optional] |
+| **estimated_availability** | **Time** | Estimated availability of funds. When funds would be available to pickup/deposited |  |
+| **status_reason** | **String** | Optional. Contains the reason for the status change. Most commonly used for CANCELLED status with the reason for cancellation | [optional] |
+| **attrs** | **Object** | The relevant attributes that were used to fulfill this payout | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::PayoutTxnResp.new(
+  payout_token: ba4275f2-bae1-488d-9d6f-20af1cd83574,
+  client_transfer_id: aEjn345,
+  source_currency_code: USD,
+  destination_currency_code: MXN,
+  source_token: ba4275f2-bae1-488d-9d6f-20af1cd83574,
+  destination_token: d2138fd0-00be-45a8-985f-4f5bde500962,
+  destination_amount: 100.5,
+  source_amount: 100.5,
+  attr_set_token: b1a867c1-6e36-4525-b6d5-a20bac80e3b0,
+  exchange_rate: 18.55,
+  fee: 2.99,
+  expiration: 2019-06-26T22:32:05,
+  pickup_code: 54238173,
+  status: null,
+  payer_logo: [B@3459a3c9,
+  payer_name: Elektra,
+  delivery_type: null,
+  country_code: MEX,
+  metadata: {"group_id":541},
+  estimated_availability: 2020-07-21T17:32:28Z,
+  status_reason: null,
+  attrs: null
+)
+```
+

data/docs/ResendBalanceNotification200Response.md

@@ -0,0 +1,18 @@
+# MassPayRubySdk::ResendBalanceNotification200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | True if notifcation was sent succesfully. False otherwise |  |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::ResendBalanceNotification200Response.new(
+  success: null
+)
+```
+

data/docs/Service.md

@@ -0,0 +1,22 @@
+# MassPayRubySdk::Service
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **country_code** | **String** | Country code [ISO_3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) |  |
+| **delivery_type** | **String** | The type of service. I.e. cash pickup, home delivery, etc. |  |
+| **payers** | [**Array<ServicePayersInner>**](ServicePayersInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::Service.new(
+  country_code: MEX,
+  delivery_type: null,
+  payers: null
+)
+```
+

data/docs/ServicePayersInner.md

@@ -0,0 +1,38 @@
+# MassPayRubySdk::ServicePayersInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **destination_token** | **String** | Token that represents the payout destination. 36 characters long |  |
+| **payer_logo** | **String** | base64 representation of the payer logo |  |
+| **payer_name** | **String** | Name of payer |  |
+| **exchange_rate** | [**Array<ServicePayersInnerExchangeRateInner>**](ServicePayersInnerExchangeRateInner.md) | Lists all available currencies and their estimated rates |  |
+| **fee** | **Float** | Service fee |  |
+| **max_limit** | **Float** | The maximum amount (inclusive) the user can send with this service. 0 if no upper limit |  |
+| **min_limit** | **Float** | The minimum amount (inclusive) the user can send with this service. 0 if no lower limit |  |
+| **source_amount** | **Float** | Optional return field. Will only show if `limit` parameter is provided | [optional] |
+| **number_of_locations** | **Integer** | Total number of locations. Mostly relevant for cash pickup services. 0 if unknown or irrelevant | [optional][default to 0] |
+| **estimated_availability** | **Time** | Estimated availability of funds. When funds would be available to pickup/deposited | [optional] |
+| **additional_description** | **String** | When available, additional description that explains the service offered or requirements for funds delivery. | [optional] |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::ServicePayersInner.new(
+  destination_token: null,
+  payer_logo: [B@7a1cca39,
+  payer_name: Elektra,
+  exchange_rate: null,
+  fee: 8,
+  max_limit: 10000,
+  min_limit: 0,
+  source_amount: 104.3,
+  number_of_locations: 13007,
+  estimated_availability: 2020-07-21T17:32:28Z,
+  additional_description: Requires drivers license to pickup funds
+)
+```
+

data/docs/ServicePayersInnerExchangeRateInner.md

@@ -0,0 +1,20 @@
+# MassPayRubySdk::ServicePayersInnerExchangeRateInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency_symbol** | **String** | Using [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. |  |
+| **exchange_rate** | **Float** | Estimated rate |  |
+
+## Example
+
+```ruby
+require 'masspay_ruby_sdk'
+
+instance = MassPayRubySdk::ServicePayersInnerExchangeRateInner.new(
+  currency_symbol: MXN,
+  exchange_rate: 18.37
+)
+```
+