Skip to main content

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:

  1. Navigate to Admin → Settings → Payments
  2. Select Versapay from the list of available payment processors
  3. Enter your API Token in the apiToken field
  4. Enter your API Key in the apiKey field
  5. Configure whether payments should be captured immediately or authorized only
  6. Save the configuration
  7. Test the integration with a small transaction to verify credentials

Configuration options

FieldWhat it doesDefaultRequired
apiTokenYour Versapay API token used to authenticate gateway requestsNoneYes
apiKeyYour Versapay API key used to authenticate gateway requestsNoneYes
captureWhether to capture payment immediately (true) or only authorize it (false)NoneYes
paymentMethodThe payment type to use (e.g., "creditCard")creditCardYes

Using it day-to-day

For customers at checkout:

  1. Customer proceeds to checkout and selects credit card as payment method
  2. The system creates a secure Versapay session and displays the payment form
  3. Customer enters card number, cardholder name, expiration date (MM/YY format), and CVV
  4. Customer submits payment
  5. Versapay processes the transaction and returns authorization or capture confirmation
  6. Order is created with payment status

For invoice payments:

  1. Customer navigates to open invoices in their account
  2. Customer selects an invoice to pay
  3. System creates a Versapay session for the invoice amount
  4. Customer enters payment details in the secure form
  5. Payment is processed and applied to the invoice

For admins managing payments:

  1. View payment transactions in Admin → Payments
  2. Monitor pre-authorization status and expiry dates
  3. Filter invoices by payment method or custom fields if configured
  4. 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.