Getting Started with Catalogs
The MassPay Catalogs API is a collection of endpoints that provides you with information about the services available in different countries. The Catalogs API allows you to retrieve lists of MassPay Global Partners and their service offerings, as well as their prices, in a given country. Additionally, you can access information about alternative payout services that may be available in a given country. The Catalogs API also provides access to user agreements, which outline the terms and conditions of using MassPay services. The MassPay Catalogs API is a valuable tool to identify and navigate the various options available when making international payments.
How it works?
The MassPay Catalogs API provides a set of RESTful endpoints that enable you to retrieve useful information about the services available from MassPay. With the Catalogs API, you can get a list of countries where services are offered, along with the list of MassPay Global Partners and their service offerings for a particular country code. Furthermore, you can retrieve a list of alternative services to a provided service, and also obtain user agreements for the services offered.
The MassPay Catalogs API is a valuable tool for users looking to navigate the various options available when making international payments.
What are possible use cases?
Here are some possible use cases for the MassPay Catalogs API:
- Finding the Right Payment Providers: By using the MassPay Catalogs API, you can provide your customers with a list of available countries where your services are offered, enabling them to quickly identify if their desired payment provider is supported.
- Finding the Cheapest Service Offerings: If you run an e-commerce business that operates in multiple countries, you can use the MassPay Catalogs API to retrieve a list of MassPay Global Partners (Companies) and their service offerings for a specific country. This enables you to provide accurate information to your customers about pricing and available services.
- Finding Alternative Services: By retrieving a list of MassPay Global Partners (Companies) and the cost of their service offerings for a specific country using the MassPay Catalogs API, you can help your customers make informed decisions when choosing a service. This will help you build trust and increase customer loyalty.
- Accessing User Agreements: The User Agreements refer to the terms and conditions under which the user uses the MassPay platform and the orchestrated services of our partners. It is essential for customers to understand these terms and conditions so they can make informed decisions when choosing a particular MassPay Global Partner. You can use the MassPay Catalogs API to retrieve a list of alternative services available in the same country, which can help customers find suitable options. This can also aid in retaining customers who may be considering switching to a competitor.
- Providing Comprehensive Service Offerings: By using the MassPay Catalogs API to retrieve user agreements, you can ensure that your business is compliant with local regulations and industry standards. This can help you avoid legal issues and maintain a positive reputation in the market.
If you would like to explore additional use cases, please contact us at [email protected].
What data can I get using the MassPay REST API?
MassPay currently offers five wallet and autopay REST API services that can help you to:
| Service | Description |
|---|---|
| Gets a list of countries where services are offered | Using this API endpoint, you can retrieve a list of countries where MassPay offers its services. The countries are identified by their ISO-3166 alpha-2 country codes. This API is useful for determining which countries MassPay supports and integrating this information into your application. |
| Gets a list of Companies and their service offerings for the given country code | Using this API, you can retrieve a list of MassPay Global Partners (Companies) that offer their services in a specific country, along with detailed information about each service they offer. This information includes the name of the service, the payment methods accepted, the maximum transaction amount, and the processing time. |
| Gets a list of Companies and their cheapest service offerings for the given country code | Using this API, you can retrieve a list of MassPay Global Partners (Companies) offering the cheapest services for a given country code. This endpoint is useful when you want to provide your users with the most cost-effective options for sending payouts to a specific country. The response includes details such as the name of the MassPay Global Partner (Company), the service they offer, and the minimum and maximum amounts they allow for transactions. |
| Returns list of alternative service to a provided service | Using this API, users can retrieve a list of alternative service offerings to a provided service offering. This can be useful for users who are looking for alternative payment options, or who want to compare pricing and service features across different payment providers. |
| Returns provided service | Using this API, you can retrieve a details of provided service. It allows you to access destination tokens linked to various payment destinations, enabling seamless transaction management and verification processes. |
| Get available user agreements | Using this API, you can retrieve a list of available user agreements that can be accepted by payees for a given country code. This can be useful for displaying the available agreements to the payee during the payout process, ensuring that they are aware of and agree to the terms and conditions before accepting the payment. |
| Get user agreement | Using this API endpoint, you can retrieve a user agreement by providing an agreement ID. This API is useful for customers who want to retrieve agreements for legal or compliance purposes, such as reviewing the terms and conditions of a service agreement. The response includes the agreement's ID, name, description, and content in the form of a PDF file. |
It is important to note that the available user agreement API only returns a list of available user agreements and does not handle the acceptance or rejection of agreements. It is the responsibility of the payee to review and accept the terms of the agreement before accepting the payment.
Updated 10 months ago