Transaction integration guide
A simple guide to getting started with transaction integration
This guide serves as a comprehensive walkthrough for partners to integrate the white-label solution for transaction processes using CoinMena's payment gateway APIs.
Note:
Webhook Endpoint: Partners must provide a webhook endpoint to receive confirmations.
Whitelisting: To use this utilise the flow, the partner must be whitelisted by the CoinMena team, and ensure you have a valid API key and API secret provided by the CoinMena team.
For a comprehensive transaction integration, follow these steps:
Fetch Price: To initiate the transaction process, partners first use the Quotes API to retrieve the current cryptocurrency price. This step is crucial as it ensures that users are presented with the most up-to-date pricing information before they proceed with their transaction. This API call fetches real-time data, reflecting the volatile nature of cryptocurrency prices. For more information refer to -> Quote.
Create Transaction: Once the user decides to proceed, the Create Transaction API is triggered. This step formally initiates the crypto-to-fiat conversion process, marking the user's intent to execute a transaction with the specified parameters, For more information refer to -> Create transaction.
QR-based Payment Flow: To offer users a seamless QR-based payment flow, use UPI deep linking to generate a QR code. UPI deep linking simplifies the payment process for users by including necessary payment information in custom links. Find more information here -> .
Webhook Transaction Status Updates: For automated updates, partners can configure a webhook on their server. When a transaction's status changes, the webhook endpoint receives notifications containing details like eventType, referenceId, and metadata. This mechanism ensures real-time updates, eliminating the need for manual status checks and enhancing the user experience by providing immediate feedback on transaction progress. Set up the webhook using -> ONRAMP Webhook.
Transaction API for Status: In cases where a webhook is not enabled, partners need to actively check the transaction status using the endpoint -> Get transaction.
User Notification:
Transaction Successful: Upon receiving a transaction status update, the next step is user notification. For successful transactions, users are informed of the success, reassuring them that the process has been completed.
Transaction Failure: In the event of a transaction failure, users should be notified of the failure and prompted to submit a support ticket.
Last updated
