REST API
ForexPay provides a robust REST API for developers to leverage ForexPay' capabilities programmatically. Our REST API is the base layer for all ForexPay SDKs.If you prefer to work directly with the ForexPay API, read our REST API Guide.
To practice with our API before implementing any code, read the Postman Guide containing the pre-defined API endpoints.
Language-specific SDKs & guides
ForexPay supports and maintains SDKs in JavaScript and Python to help you interact with the ForexPay API. We also offer guides for languages in which we don't have a currently active SDK.
These guides provide you with a simple example to get you started and quickly past the first hurdles of securely signing API requests:
JavaScript Guide
Python Guide
Java Guide
Need help deciding which language to use?
Use the following decision tree to help you figure out which ForexPay SDK is best for your use case.
Web3/Smart Contract
ForexPay offers Web3 connector SDKs for developers who use a base library as part of their tech stack and want ForexPay to act as the underlying wallet and security layer:
·Ethereum Development Guide: Learn about using ethers.js, web3.js or web3.py with ForexPay as the Web3 Provider.
·Ethereum Smart Contract Development: Learn how to connect ForexPay in tools like Hardhat.
Additional Tools
·ForexPay Web3Provider - A "hook" to connect ForexPay easily as the signing mechanism is web3.js and ethers.js as described in Ethereum Development
·ForexPay Local JSON RPC - A locally running EVM JSON RPC module that uses the Web3 Provider to use ForexPay as the signing mechanism. This allows you to plug ForexPay into any of the tools that require a JSON RPC URL, including different development and deployment tools.
Webhooks
Webhook notifications allow you to get push notifications for events that happen in your ForexPay workspace directly to an HTTP webhook URL of your choice. This saves you the need to constantly check the API for updates.
Read more at Webhooks & Notifications.
As a provider of digital asset management services, ForexPay reminds users to pay attention to the following risks:
- Legal risk: The legal status of digital currency is different in different countries and regions. Users should understand relevant laws and regulations before using ForexPay's services to ensure that their operations are legal and compliant.
- Technical risk: Although the blockchain technology is highly secure, it also has loopholes, data loss, operational errors and other issues. Users need to be clear about their own risks in using ForexPay and take corresponding preventive measures (such as backing up private keys).
- Market risk: The digital currency market is highly volatile, and prices are affected by various factors. Users need to understand the risks and rules of digital currency market, invest and trade cautiously.
- Transaction risk: When using ForexPay for transactions, users need to confirm the authenticity of transaction object and the accuracy of transaction information to avoid fraud and misoperation.
- Information security risk: Users need to protect their account and password to avoid account theft or password leakage. ForexPay will take a variety of security measures, but it also requires users to protect and manage their accounts and passwords.
- When using various products and services provided by ForexPay, users need to carefully read product descriptions and related terms to ensure that their understanding and operation are correct.
- Risk of regional restrictions: ForexPay may not be able to provide services in some countries and regions, users need to carefully check the scope of services provided by ForexPay before using.
ForexPay is committed to providing users with safe, stable and convenient digital currency management services. However, there are various risks in the digital currency market, and users should understand and bear their own risks before using. ForexPay will continue to strengthen risk management measures to provide better and safer services.