Developer guide · API v1

Download .mdView raw

Wix integration

Server-side integrations with explicit payment confirmation and safe retries.

This is a site-specific Velo service plugin. Wix does not accept this ZIP as an App Market installation. A public payment-provider app requires Wix’s separate partner approval.

Add Atlas Pay to your site

Download Wix integration source · ZIP

  1. Enable Velo on your published HTTPS Wix commerce site. Add a Payment Provider service plugin called atlas-pay in the editor’s Service Plugins area.
  2. Copy the supplied payment-provider file contents into Wix’s generated provider/config files. Preserve Wix’s generated manifest and file names.
  3. Add the two Atlas Pay backend modules. Merge the supplied HTTP function into backend/http-functions.js; do not overwrite existing functions.
  4. Create an Admin-only CMS collection with ID AtlasPayWebhookEvents, a text eventId field, and a date processedAt field.
  5. Publish. Your callback is https://YOUR-SITE/_functions/atlasPayWebhook. Include the site path if using a wixsite.com address.
  6. Create an Atlas Pay key for the exact published origin and callback with all six permissions. In Wix Secrets Manager, save ATLAS_PAY_API_KEY and ATLAS_PAY_WEBHOOK_SECRET.
  7. Connect the custom provider under Accept Payments. Enter ATLAS_PAY_API_KEY as the secret-name field. Match your Wix merchant country and currency to Atlas Pay.

How it works

Wix supplies the authoritative order amount and transaction ID. The provider creates a checkout with a stable idempotency key, then returns its hosted redirect URL. Signed callbacks fetch current Atlas Pay status and call Wix’s backend submitEvent. The customer’s return URL never approves payment by itself.

Refund requests use the Wix refund ID as their stable reference. Pending payments/refunds wait for subsequent updates. Secrets are read only in elevated backend code, never from a public web method or browser module.

Scope & release requirements

The code supports one-time hosted checkout and full/partial refunds. It does not support Wix recurring plans, stored payment credentials, manual capture, or a public provider marketplace listing. A payment-capable Wix plan and available service-plugin access are required.

The source includes local contract tests, but a published Wix store must still pass the acceptance checklist. Follow the README inside the download for recovery and rotation. There is no scheduled Wix event-recovery job in this preview.

Official guidance: site-specific provider tutorial and public PSP approval process.