README

MasspaySdk

Welcome to our MasspaySdk. 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: 3.0.0

Requirements
Installation
Usage
Features
Contributing
License
Contact
Frequently Asked Questions (FAQ)

Requirements

PHP version >= 8.0.
MassPay.io API credentials.

Installation

Composer

To install via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/masspayio/masspay-php-sdk.git"
    }
  ],
  "require": {
    "masspayio/masspay-php-sdk": "^3.0.0"
  }
}

Then run composer install.

Manual Installation

Download the latest release and include autoload.php:

<?php

require_once('/path/to/masspay-php-sdk/vendor/autoload.php');

Usage

In case that you successfully installed our MasspaySdk please execute this code:

<?php

require_once(__DIR__ . '/vendor/autoload.php');

use MasspaySdk\Client;
use MasspaySdk\Config\ApiConfig;

$config = new ApiConfig();
$config->bearer_token = 'YOUR_BEARER_TOKEN';

$client = new Client($config);
try {
  $result = $client->account->getAccountBalance();
  var_dump($result);
} catch (Exception $e) {
  var_dump($e);
}

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
Account	getAccountBalance	GET /payout/account/balance	Get current available balance
Account	getAccountStatement	GET /payout/account/statement	Get certified account statement
Attribute	getAllAttrs	GET /payout/attribute/{user_token}	Get all stored user attributes
Attribute	storeAttrs	POST /payout/attribute/{user_token}/{destination_token}/{currency}	Store user attributes
Attribute	getAttrs	GET /payout/attribute/{user_token}/{destination_token}/{currency}	Get user attributes for destination_token
Card	getWalletCardInfo	GET /payout/wallet/{user_token}/{wallet_token}/card	Get MassPay card information
Card	updateWalletCardInfo	PUT /payout/wallet/{user_token}/{wallet_token}/card	Update MassPay card information
Catalog	getCountryList	GET /payout/country/list	Gets a list of countries where services offered.
Catalog	getCountryServices	GET /payout/country/{country_code}	Gets a list of Companies and their service offerings for the given country code.
Catalog	getCheapestCountryServices	GET /payout/country/{country_code}/cheapest	Gets a list of Companies and their cheapest service offerings for the given country code.
Catalog	getDestinationTokenAlternatives	GET /payout/service/{destination_token}/alternatives	Returns list of alternative service to a provided service
Catalog	getDestinationToken	GET /payout/service/{destination_token}	Returns provided service
Catalog	getUserAgreement	GET /payout/user-agreements	Get user agreement
Catalog	getUserAgreementsNames	OPTIONS /payout/user-agreements	Get available user agreements
Kyc	findAttributesVelocity	POST /payout/attribute/{user_token}/velocity	Attributes velocity check
Kyc	getUserUserTokenKycAu10Tix	GET /payout/user/{user_token}/kyc/au10tix	Get an Au10tix session link
Kyc	uploadIdPhotos	POST /payout/user/{user_token}/kyc/id	Upload ID photos
Kyc	getUserUserTokenKycAttempts	GET /payout/user/{user_token}/kyc/id	Get all KYC sessions
Kyc	getUserUserTokenKycVeriff	GET /payout/user/{user_token}/kyc/veriff	Get a Veriff session link
Load	resendBalanceNotification	PUT /payout/wallet/{user_token}	Resend balance notification
Load	loadUser	POST /payout/load/{user_token}	Initiate a load transaction
Load	getUserLoadsByToken	GET /payout/load/{user_token}	Get history of loads by user token
Load	resendLoadNotification	PUT /payout/load/{user_token}	Resend load notification
Load	cancelUserLoad	DELETE /payout/load/{user_token}	Reverse a user load
Payout	initiatePayout	POST /payout/{user_token}	Initiate a payout transaction
Payout	getUserPayoutsByToken	GET /payout/{user_token}	Get history of payouts by user token
Payout	commitPayoutTxn	PUT /payout/{user_token}/{payout_token}	Commit payout transaction
Payout	getPayoutStatus	GET /payout/{user_token}/{payout_token}	Get status of a payout by payout token
Payout	getTransactionConfirmationDetails	PATCH /payout/{user_token}/{payout_token}	Get transaction confirmation details
SpendBack	getUserSpendbacksByToken	GET /payout/spendback/{user_token}	Get history of spend backs by user token
SpendBack	initiateSpendback	POST /payout/spendback/{user_token}	Initiate a spend back transaction
Subaccount	createSubaccount	POST /subaccount	Create a subaccount
Subaccount	getSubaccountSubaccountTokenUbo	POST /subaccount/{subaccount_token}/ubo	Add UBOs to subaccount
Subaccount	uploadSubaccountUboId	POST /subaccount/{subaccount_token}/ubo/{ubo_token}/id	Upload UBO ID photos
Tax	getTaxUsers	GET /payout/tax	Get list of users' annual balance
Tax	getTaxInterviewLink	GET /payout/{user_token}/tax	Get link for tax interview
User	createUser	POST /payout/user	Create a user
User	getUserByToken	GET /payout/user/{user_token}	Get user by user token
User	updateUser	PUT /payout/user/{user_token}	Updated user
User	userLookup	GET /payout/user/lookup	Lookup an existing user
User	getUserHistory	GET /payout/user/{user_token}/history	Transactions history
User	getAllUsersHistory	GET /payout/user/history	All Users' Transactions history
Wallet	getWallet	GET /payout/wallet/{user_token}	Retrieve all available wallets for a user
Wallet	getAutopayoutRules	GET /payout/wallet/{user_token}/{wallet_token}/autopayout	Get all AutoPayout rules
Wallet	createAutopayoutRule	POST /payout/wallet/{user_token}/{wallet_token}/autopayout	Add AutoPayout rule
Wallet	deleteAutopayoutRule	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:

info@masspay.io

masspayio / masspay-php-sdk

Maintainers

Details