Welcome to the Coinify Crypto On-Ramp/Off-Ramp API documentation. In this documentation we will take you through the process of integrating with Coinify Trade Service API to enable your customers to buy and sell cryptocurrencies.
Make sure you received your Partner ID from Coinify as it is necessary for the integration.
Good to know:In this documentation the following words/expressions are used interchangeably:
End-user=Trader- represents your customer that is using Coinify's Trade Service.Trade=Order- a Buy or Sell order that the end-user created.
High-level description of the flow that must be implemented for every newly signed-up and existing end-user to enable them to Buy and Sell crypto:
- Register/Sign-up the end-user - Frictionless Sign-up flow is recommended for the best UX
- Authenticate the end-user (Sign-in) - Frictionless Sign-in flow is recommended for the best UX
- Provide Mandatory information from the end-user
- Complete the KYC process - Individual traders only
- Create a trade quote - A valid quote must be created before a trade is created
- Create a trade - A trade is created using a valid trade quote
- Pay for the trade - A trade can be paid for via Credit Card, Bank, or Blockchain transaction, depending on the trade type.
- Update the end-user about the trade status
Views to implement 👀
In order to create a full API integration with Coinify you need to implement the following views for the end-user to be able to see/access:
- KYC/Customer Identity Verification - the end-user has to be redirected to the Identification attempt link in order to complete the KYC.
- Trade Quote - the trader should be able to see the relevant quote information based on which they can decide to create and complete a trade.
- Order summary - the trader should be able to see the summary of their order before the trade is created and before they are prompted for payment.
- Credit card payment - the trader has to be redirected to the Credit Card Payment Page to complete an existing credit card Buy order.
- Bank account registration - the trader has to be able provide and store their bank account details and select the relevant account for their Sell trade.
- Historical trades - the trader should have access to the history and details of previously created trades.
Feel free to use our Trade Widget as an inspiration of the flows and views for your API integration.Check the Trade Widget section to see how to use a Trade Widget link with your dedicated partner ID.