masspay_ruby_sdk

MassPayRubySdk - the Ruby gem for the MassPay API

MassPay API

• API version: 0.1.4
• Package version: 1.0.0

For more information, please visit https://www.masspay.io

Installation

Bundler

bundle add masspay_ruby_sdk

Global Installation

gem install masspay_ruby_sdk

Getting Started

Please follow the installation procedure and then run the following code:

Ruby

# Load the gem
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::AccountApi.new

begin
  #Get current available balance
  result = api_instance.get_account_balance
  p result
rescue MassPayRubySdk::ApiError => e
  puts "Exception when calling AccountApi->get_account_balance: #{e}"
end

Rails

Create a file config/initializers/masspay_ruby_sdk.rb with the following content:

# 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

Then call the API:

api_instance = MassPayRubySdk::AccountApi.new

begin
  #Get current available balance
  result = api_instance.get_account_balance
  p result
rescue MassPayRubySdk::ApiError => e
  puts "Exception when calling AccountApi->get_account_balance: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.masspay.io/v0.1.4

Class	Method	HTTP request	Description
MassPayRubySdk::AccountApi	get_account_balance	GET /account/balance	Get current available balance
MassPayRubySdk::AccountApi	get_account_statement	GET /account/statement	Get certified account statement
MassPayRubySdk::AttributeApi	get_attrs	GET /attribute/user_token/destination_token/currency	Get user attributes for destination_token
MassPayRubySdk::AttributeApi	store_attrs	POST /attribute/user_token/destination_token/currency	Store user attributes
MassPayRubySdk::CardApi	get_wallet_card_info	GET /wallet/user_token/wallet_token/card	Get MassPay Card Information
MassPayRubySdk::CardApi	update_wallet_card_info	PUT /wallet/user_token/wallet_token/card	Update MassPay Card Information
MassPayRubySdk::CatalogApi	get_cheapest_country_services	GET /country/country_code/cheapest	Gets a list of Companies and their cheapest service offerings for the given country code.
MassPayRubySdk::CatalogApi	get_country_list	GET /country/list	Gets a list of countries where services offered.
MassPayRubySdk::CatalogApi	get_country_services	GET /country/country_code	Gets a list of Companies and their service offerings for the given country code.
MassPayRubySdk::CatalogApi	get_destination_token_alternatives	GET /service/destination_token/alternatives	Returns list of alternative service to a provided service
MassPayRubySdk::CatalogApi	get_user_agreement	GET /user-agreements	Get User Agreement
MassPayRubySdk::CatalogApi	get_user_agreements_names	OPTIONS /user-agreements	Get Available User Agreements
MassPayRubySdk::KYCApi	find_attributes_velocity	POST /attribute/user_token/velocity	Attributes velocity check
MassPayRubySdk::KYCApi	get_user_user_token_kyc_au10tix	GET /user/user_token/kyc/au10tix	Get an Au10tix session link
MassPayRubySdk::KYCApi	get_user_user_token_kyc_veriff	GET /user/user_token/kyc/veriff	Get a Veriff session link
MassPayRubySdk::KYCApi	upload_id_photos	POST /user/user_token/kyc/id	Upload ID Photos
MassPayRubySdk::LoadApi	cancel_user_load	DELETE /load/user_token	Reverse a user load
MassPayRubySdk::LoadApi	create_autopay_rule	POST /wallet/user_token/wallet_token/autopay	Add autopay rule
MassPayRubySdk::LoadApi	delete_autopay_rule	DELETE /wallet/user_token/wallet_token/autopay	Delete autopay rule
MassPayRubySdk::LoadApi	get_autopay_rules	GET /wallet/user_token/wallet_token/autopay	Get all autopay rules
MassPayRubySdk::LoadApi	get_user_loads_by_token	GET /load/user_token	Get history of loads by user token
MassPayRubySdk::LoadApi	load_user	POST /load/user_token	Initiate a load transaction
MassPayRubySdk::LoadApi	load_user_token_put	PUT /load/user_token	Resend Load Notification
MassPayRubySdk::LoadApi	resend_balance_notification	PUT /wallet/user_token	Resend Balance Notification
MassPayRubySdk::PayoutApi	commit_payout_txn	PUT /payout/user_token/payout_token	Commit payout transaction
MassPayRubySdk::PayoutApi	get_payout_status	GET /payout/user_token/payout_token	Get status of a payout by payout token
MassPayRubySdk::PayoutApi	get_transaction_confirmation_details	PATCH /payout/user_token/payout_token	Get transaction confirmation details
MassPayRubySdk::PayoutApi	get_user_payouts_by_token	GET /payout/user_token	Get history of payouts by user token
MassPayRubySdk::PayoutApi	initiate_payout	POST /payout/user_token	Initiate a payout transaction
MassPayRubySdk::SpendBackApi	get_user_spendbacks_by_token	GET /spendback/user_token	Get history of spend backs by user token
MassPayRubySdk::SpendBackApi	initiate_spendback	POST /spendback/user_token	Initiate a spend back transaction
MassPayRubySdk::TaxApi	get_tax_users	GET /tax	Get List Of Users Annual Balance
MassPayRubySdk::UserApi	create_user	POST /user	Create a user
MassPayRubySdk::UserApi	get_user_by_token	GET /user/user_token	Get user by user token
MassPayRubySdk::UserApi	get_user_history	GET /user/user_token/history	Transactions history
MassPayRubySdk::UserApi	update_user	PUT /user/user_token	Updated user
MassPayRubySdk::UserApi	user_lookup	GET /user/lookup	Lookup an existing user
MassPayRubySdk::WalletApi	create_autopay_rule	POST /wallet/user_token/wallet_token/autopay	Add autopay rule
MassPayRubySdk::WalletApi	delete_autopay_rule	DELETE /wallet/user_token/wallet_token/autopay	Delete autopay rule
MassPayRubySdk::WalletApi	get_autopay_rules	GET /wallet/user_token/wallet_token/autopay	Get all autopay rules
MassPayRubySdk::WalletApi	get_wallet	GET /wallet/user_token	Retrieve all available wallets for a user
MassPayRubySdk::WalletApi	get_wallet_card_info	GET /wallet/user_token/wallet_token/card	Get MassPay Card Information
MassPayRubySdk::WalletApi	update_wallet_card_info	PUT /wallet/user_token/wallet_token/card	Update MassPay Card Information

Documentation for Models

• MassPayRubySdk::ApiResponse
• MassPayRubySdk::AttrTxn
• MassPayRubySdk::AttrValue
• MassPayRubySdk::AttrVelocityRequestInner
• MassPayRubySdk::AttrsRequirement
• MassPayRubySdk::AutopayResp
• MassPayRubySdk::AutopayRule
• MassPayRubySdk::AvailableBalanceTxnResp
• MassPayRubySdk::CompaniesResp
• MassPayRubySdk::Company
• MassPayRubySdk::Country
• MassPayRubySdk::Exception
• MassPayRubySdk::FoundUser
• MassPayRubySdk::GetAccountStatement200Response
• MassPayRubySdk::GetTransactionConfirmationDetails200Response
• MassPayRubySdk::GetUserAgreement200Response
• MassPayRubySdk::GetUserAgreementsNames200ResponseInner
• MassPayRubySdk::GetUserUserTokenKycAu10tix200Response
• MassPayRubySdk::GetUserUserTokenKycVeriff200Response
• MassPayRubySdk::GetWalletCardInfo200Response
• MassPayRubySdk::IDUpload
• MassPayRubySdk::LoadTxn
• MassPayRubySdk::LoadTxnResp
• MassPayRubySdk::Loads
• MassPayRubySdk::PayoutTxn
• MassPayRubySdk::PayoutTxnCommitResp
• MassPayRubySdk::PayoutTxnResp
• MassPayRubySdk::ResendBalanceNotification200Response
• MassPayRubySdk::Service
• MassPayRubySdk::ServicePayersInner
• MassPayRubySdk::ServicePayersInnerExchangeRateInner
• MassPayRubySdk::SpendBackTxn
• MassPayRubySdk::SpendBackTxnResp
• MassPayRubySdk::SpendBacks
• MassPayRubySdk::StoredUser
• MassPayRubySdk::TaxYearUserResp
• MassPayRubySdk::TxnHistoryResp
• MassPayRubySdk::UpdateUser
• MassPayRubySdk::User
• MassPayRubySdk::WalletTxnResp

Documentation for Authorization

AUTHORIZER_NAME

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author

info@masspay.io