masspay_ruby_sdk
Welcome to our masspay_ruby_sdk. We are committed to providing you with the best SDK services experience possible. Please use our step-by-step instructions to become familiar with how to use our SDK.
- Current API version: 1.0.0
- Current package version: 2.0.0
Table of Contents
- Requirements
- Installation
- Usage
- Features
- Contributing
- License
- Contact
- Frequently Asked Questions (FAQ)
Requirements
- Ruby version >= 2.7.
- MassPay.io API credentials.
Installation
Use this command to install masspay_ruby_sdk in your terminal.
gem install masspay_ruby_sdk
Usage
In case that you successfully installed our masspay_ruby_sdk please execute this code:
require 'masspay_ruby_sdk'
client = MasspayRubySdk.client({ bearer_auth: 'YOUR_BEARER_TOKEN' })
client.account_service.get_account_balance
Features
Kindly note that every URI is relative to https://api.masspay.io/v1.0.0.
The table displays all features categorized based on their specific purposes.
| Class | Method | HTTP request | Description |
|---|---|---|---|
| MasspayRubySdk.account_service | get_account_balance | GET /payout/account/balance | Get current available balance |
| MasspayRubySdk.account_service | get_account_statement | GET /payout/account/statement | Get certified account statement |
| MasspayRubySdk.attribute_service | get_all_attrs | GET /payout/attribute/user_token | Get all stored user attributes |
| MasspayRubySdk.attribute_service | store_attrs | POST /payout/attribute/user_token/destination_token/currency | Store user attributes |
| MasspayRubySdk.attribute_service | get_attrs | GET /payout/attribute/user_token/destination_token/currency | Get user attributes for destination_token |
| MasspayRubySdk.card_service | get_wallet_card_info | GET /payout/wallet/user_token/wallet_token/card | Get MassPay card information |
| MasspayRubySdk.card_service | update_wallet_card_info | PUT /payout/wallet/user_token/wallet_token/card | Update MassPay card information |
| MasspayRubySdk.catalog_service | get_country_list | GET /payout/country/list | Gets a list of countries where services offered. |
| MasspayRubySdk.catalog_service | get_country_services | GET /payout/country/country_code | Gets a list of Companies and their service offerings for the given country code. |
| MasspayRubySdk.catalog_service | get_cheapest_country_services | GET /payout/country/country_code/cheapest | Gets a list of Companies and their cheapest service offerings for the given country code. |
| MasspayRubySdk.catalog_service | get_destination_token_alternatives | GET /payout/service/destination_token/alternatives | Returns list of alternative service to a provided service |
| MasspayRubySdk.catalog_service | get_destination_token | GET /payout/service/destination_token | Returns provided service |
| MasspayRubySdk.catalog_service | get_user_agreement | GET /payout/user-agreements | Get user agreement |
| MasspayRubySdk.catalog_service | get_user_agreements_names | OPTIONS /payout/user-agreements | Get available user agreements |
| MasspayRubySdk.kyc_service | find_attributes_velocity | POST /payout/attribute/user_token/velocity | Attributes velocity check |
| MasspayRubySdk.kyc_service | get_user_user_token_kyc_au_10_tix | GET /payout/user/user_token/kyc/au10tix | Get an Au10tix session link |
| MasspayRubySdk.kyc_service | upload_id_photos | POST /payout/user/user_token/kyc/id | Upload ID photos |
| MasspayRubySdk.kyc_service | get_user_user_token_kyc_attempts | GET /payout/user/user_token/kyc/id | Get all KYC sessions |
| MasspayRubySdk.kyc_service | get_user_user_token_kyc_veriff | GET /payout/user/user_token/kyc/veriff | Get a Veriff session link |
| MasspayRubySdk.load_service | resend_balance_notification | PUT /payout/wallet/user_token | Resend balance notification |
| MasspayRubySdk.load_service | load_user | POST /payout/load/user_token | Initiate a load transaction |
| MasspayRubySdk.load_service | get_user_loads_by_token | GET /payout/load/user_token | Get history of loads by user token |
| MasspayRubySdk.load_service | resend_load_notification | PUT /payout/load/user_token | Resend load notification |
| MasspayRubySdk.load_service | cancel_user_load | DELETE /payout/load/user_token | Reverse a user load |
| MasspayRubySdk.payout_service | initiate_payout | POST /payout/user_token | Initiate a payout transaction |
| MasspayRubySdk.payout_service | get_user_payouts_by_token | GET /payout/user_token | Get history of payouts by user token |
| MasspayRubySdk.payout_service | commit_payout_txn | PUT /payout/user_token/payout_token | Commit payout transaction |
| MasspayRubySdk.payout_service | get_payout_status | GET /payout/user_token/payout_token | Get status of a payout by payout token |
| MasspayRubySdk.payout_service | get_transaction_confirmation_details | PATCH /payout/user_token/payout_token | Get transaction confirmation details |
| MasspayRubySdk.spend_back_service | get_user_spendbacks_by_token | GET /payout/spendback/user_token | Get history of spend backs by user token |
| MasspayRubySdk.spend_back_service | initiate_spendback | POST /payout/spendback/user_token | Initiate a spend back transaction |
| MasspayRubySdk.subaccount_service | create_subaccount | POST /subaccount | Create a subaccount |
| MasspayRubySdk.subaccount_service | get_subaccount_subaccount_token_ubo | POST /subaccount/subaccount_token/ubo | Add UBOs to subaccount |
| MasspayRubySdk.subaccount_service | upload_subaccount_ubo_id | POST /subaccount/subaccount_token/ubo/ubo_token/id | Upload UBO ID photos |
| MasspayRubySdk.tax_service | get_tax_users | GET /payout/tax | Get list of users' annual balance |
| MasspayRubySdk.tax_service | get_tax_interview_link | GET /payout/user_token/tax | Get link for tax interview |
| MasspayRubySdk.user_service | create_user | POST /payout/user | Create a user |
| MasspayRubySdk.user_service | get_user_by_token | GET /payout/user/user_token | Get user by user token |
| MasspayRubySdk.user_service | update_user | PUT /payout/user/user_token | Updated user |
| MasspayRubySdk.user_service | user_lookup | GET /payout/user/lookup | Lookup an existing user |
| MasspayRubySdk.user_service | get_user_history | GET /payout/user/user_token/history | Transactions history |
| MasspayRubySdk.user_service | get_all_users_history | GET /payout/user/history | All Users' Transactions history |
| MasspayRubySdk.wallet_service | get_wallet | GET /payout/wallet/user_token | Retrieve all available wallets for a user |
| MasspayRubySdk.wallet_service | get_autopayout_rules | GET /payout/wallet/user_token/wallet_token/autopayout | Get all AutoPayout rules |
| MasspayRubySdk.wallet_service | create_autopayout_rule | POST /payout/wallet/user_token/wallet_token/autopayout | Add AutoPayout rule |
| MasspayRubySdk.wallet_service | delete_autopayout_rule | DELETE /payout/wallet/user_token/wallet_token/autopayout | Delete AutoPayout rule |
Contributing
To learn more about the possibility of contributing to the subsequent development of this SDK, please visit our contributing page. Kindly note that contributions are limited by a unique set of rules in order to ensure clarity.
License
Please refer to the license page for more information about the license type and the corresponding terms of use.
Contact
We kindly request that you direct all questions to our support email:
Frequently Asked Questions (FAQ)
Q: Where may I obtain an API key? A: Please visit our registration page if you do not have your unique API key.