Versapay
Versapay is a payment processor that handles credit card and alternative payment transactions for both checkout and invoice payments. It creates secure payment sessions, processes orders, and supports authorization and capture workflows for e-commerce transactions.
How to set it up
Where to find it: Admin → Settings → Payments → Versapay
When you'd use this: You need to accept credit card payments at checkout or enable customers to pay open invoices online.
What you need first:
- A Versapay merchant account
- Your API Token from Versapay
- Your API Key from Versapay
- Access to your CommerceBuild admin panel with permissions to configure payment methods
Set it up:
- Navigate to Admin → Settings → Payments
- Select Versapay from the list of available payment processors
- Enter your API Token in the apiToken field
- Enter your API Key in the apiKey field
- Configure whether payments should be captured immediately or authorized only
- Save the configuration
- Test the integration with a small transaction to verify credentials
Configuration options
| Field | What it does | Default | Required |
|---|---|---|---|
| apiToken | Your Versapay API token used to authenticate gateway requests | None | Yes |
| apiKey | Your Versapay API key used to authenticate gateway requests | None | Yes |
| capture | Whether to capture payment immediately (true) or only authorize it (false) | None | Yes |
| paymentMethod | The payment type to use (e.g., "creditCard") | creditCard | Yes |
Using it day-to-day
For customers at checkout:
- Customer proceeds to checkout and selects credit card as payment method
- The system creates a secure Versapay session and displays the payment form
- Customer enters card number, cardholder name, expiration date (MM/YY format), and CVV
- Customer submits payment
- Versapay processes the transaction and returns authorization or capture confirmation
- Order is created with payment status
For invoice payments:
- Customer navigates to open invoices in their account
- Customer selects an invoice to pay
- System creates a Versapay session for the invoice amount
- Customer enters payment details in the secure form
- Payment is processed and applied to the invoice
For admins managing payments:
- View payment transactions in Admin → Payments
- Monitor pre-authorization status and expiry dates
- Filter invoices by payment method or custom fields if configured
- Capture previously authorized payments if using auth-only mode
Troubleshooting
-
"An error occurred on client" during payment: The Versapay session may have expired or become invalid. Have the customer refresh the page and try again. Sessions must be used within their validity window.
-
Payment fails at checkout or invoice payment: Verify that your API Token and API Key are correct in the admin settings. Invalid credentials will cause all transactions to fail.
-
Pre-authorization has expired: Pre-authorized payments have a limited validity period (typically 7-30 days depending on card type). The admin panel flags expired authorizations. Capture authorizations before they expire or process a new payment.
-
Customer number or order number errors: Ensure that your customer and order numbering systems produce unique values. Versapay requires unique identifiers for each transaction.
-
Missing billing or shipping address data: Versapay requires complete address information. Verify that your checkout collects all required fields: first name, last name, address lines, city, state/province, postal code, country, phone, and email.