This is the official Metaprise API library that we recommend for integrating with Metaprise APIs.
This library supports the following:
| API name | API version | Description | API object |
|---|---|---|---|
| BIN Lookup API | v54 | The BIN Lookup API provides endpoints for retrieving information based on a given BIN. | BinLookup |
| Checkout API | v71 | Our latest integration for accepting online payments. | CheckoutAPI |
| Configuration API | v2 | The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts. | BalancePlatform |
| DataProtection API | v1 | Metaprise Data Protection API provides a way for you to process Subject Erasure Requests as mandated in GDPR. Use our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email) | DataProtection |
| Legal Entity Management API | v3 | Manage legal entities that contain information required for verification. | LegalEntityManagement |
| Local/Cloud-based Terminal API | - | Our point-of-sale integration. | TerminalLocalAPI or TerminalCloudAPI |
| Management API | v3 | Configure and manage your Metaprise company and merchant accounts, stores, and payment terminals. | Management |
| Payments API | v68 | Our classic integration for online payments. | ClassicIntegrationAPI |
| Payouts API | v68 | Endpoints for sending funds to your customers. | Payout |
| Platforms APIs | - | Set of APIs when using Metaprise for Platforms. This API is used for the classic integration. | Platforms |
| Account API | v6 | Provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. | Account |
| Fund API | v6 | Provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account. | Fund |
| Hosted onboarding API | v6 | Provides endpoints that you can use to generate links to Metaprise-hosted pages, such as an onboarding page or a PCI compliance questionnaire. You can provide these links to your account holders so that they can complete their onboarding. | HostedOnboardingPage |
| Notification Configuration API | v6 | Provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed. | NotificationConfiguration |
| POS Terminal Management API | v1 | Endpoints for managing your point-of-sale payment terminals. | TerminalManagement |
| Recurring API | v68 | Endpoints for managing saved payment details. | Recurring |
| Stored Value API | v46 | Manage both online and point-of-sale gift cards and other stored-value cards. | StoredValue |
| Transfers API | v4 | The Transfers API provides endpoints that can be used to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument. | Transfers |
| Disputes API | v30 | You can use the Disputes API to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. | Disputes |
| POS Mobile API | v68 | The POS Mobile API is used in the mutual authentication flow between an Metaprise Android or iOS POS Mobile SDK and the Metaprise payments platform. The POS Mobile SDK for Android or iOS devices enables businesses to accept in-person payments using a commercial off-the-shelf (COTS) device like a phone. For example, Tap to Pay transactions, or transactions on a mobile device in combination with a card reader | POS Mobile |
| Payments App API | v1 | The Payments App API is used to Board and manage the Metaprise Payments App on your Android mobile devices. | PaymentsAppApi |
For more information, refer to our documentation
## Feedback
We value your input! Help us enhance our API Libraries and improve the integration experience by providing your feedback. Please take a moment to fill out [our feedback form](https://forms.gle/A4EERrR6CWgKWe5r9) to share your thoughts, suggestions or ideas.
## Contributing
We strongly encourage you to contribute to this repository by:
* Adding new features and functionality.
* Fixing bugs and issues.
* Making general improvements.
To learn how to create a pull request, read our [contribution guidelines](CONTRIBUTING.md).
## Support
For other questions, contact our [support team](https://www.Metaprisebanking.com).
## License
This repository is available under the [MIT license](LICENSE).
