Prerequisites
Review the checklist below before beginning your integration with Volume to ensure a smooth and efficient developer experience.
What to Expect
Volume SDK integration is designed to be quick and easy, often completed in less than an hour. However, several important concepts and preparatory tasks must be addressed to ensure a successful implementation. Below is a high-level overview of the essential steps to complete before launching Volume Payments in production:
- SDK front-end component integration.
- Make necessary adjustments to your existing payment methods page, ensuring you follow our UI Best Practices to achieve optimal results.
- The callback implementation typically involves a lightweight user return page, however, your system must be prepared to handle payment identifiers and the initial payment status.
- Implement universal links to enable a seamless app-to-app experience, ensuring users are redirected back to your application upon returning to the callback.
- Webhook implementation to receive payment status updates.
IMPORTANT: Ensure that you regenerate the merchantPaymentId upon receiving the corresponding Volume event triggered by each SDK. Please refer to the "Regenerating Merchant Payment ID" section in the respective SDK documentation to prevent errors during implementation.
Preparing Your Volume Application
Before integrating Volume payments, please ensure the following prerequisites are in place:
-
Create a sandbox account via the Volume Merchant Portal (opens in a new tab), or sign in (opens in a new tab) if you already have one.
-
Once logged in, you can find your Application ID, required for the Volume SDK, under Settings → Security.
-
Request the SDK-specific token required to install and initialize the SDK by emailing us at support@getvolume.com.
-
Ensure that your Callback and Webhook URLs are added before making your first payment. You can configure these in Settings → Webhooks and Callbacks within the merchant portal. If you do not have the URLs ready at this time, please use the placeholders provided below:
- Payment webhooks: https://api.sandbox.volumepay.io/api/payments/webhook (opens in a new tab)
- Refund webhooks: https://api.sandbox.volumepay.io/api/refunds/webhook (opens in a new tab)
- Payout webhooks: https://api.sandbox.volumepay.io/api/payouts/webhook (opens in a new tab)
- Callback URL: https://sandbox.web.volumepay.io/mobile-web (opens in a new tab)
Virtual Account Sandbox Access
If you plan to use Virtual Accounts, it's important to begin integration with virtual account functionality already enabled on your sandbox account, as this impacts your webhook implementation requirements.
If you’ve signed the Virtual Account agreement but haven’t received a VA-enabled sandbox environment, please contact us at support@getvolume.com or reach out to your Customer Success Manager.
What to Avoid
WebView and API implementations should be strictly avoided when using our SDKs, as they may interfere with core functionalities and result in the loss of certain benefits and features.