Skip to main content

VistaPay at a glance

VistaPay is a payment orchestration platform and gateway that supports card payments, Apple Pay, Google Pay, tokenisation, Hosted Payment Pages (HPP), Hosted Payment Fields (HPF), PayByLink, EMV 3-D Secure (3DS2), notifications, and more.

Where to start

  • New to VistaPay? Read the Getting Started guide and call the OAuth 2.0 token endpoint.
  • Front-end first? Choose Hosted Payment Pages for fastest time-to-value, or Hosted Payment Fields for SAQ-A compliance with a custom UI.
  • Digital wallets? See Apple Pay and Google Pay setup guides.
  • Server-led flows? Create Orders and Transactions directly via the API.
  • Reference: Explore the live API Reference at checkout.vistapay.co.uk/api/v1/docs.

Start building​

Getting Started

⚡️ URLs & Authentication

Base URLs, environments, and OAuth 2.0 client credentials. Generate limited-use JWTs for HPF/APMs.

Routing

🧭 Merchant Accounts & Orchestration

Acquirer-agnostic routing, explicit merchant selection, and rules for cost/acceptance.

Core Objects

🧩 Orders

Group transactions for a purchase. Required for HPP flows.

Core Objects

💳 Transactions

Authorise, capture, pay, refund, void, verify. Polling & response structure.

Hosted

🧾 Hosted Payment Pages (HPP)

Fastest path to live with SAQ‑A. Theming, tokens, return URLs, and callbacks.

Hosted

🔗 PayByLink

Email, SMS, and QR-based payments with expiries and branded receipts.

Hosted

🧱 Hosted Payment Fields (HPF)

Per‑field iframes for SAQ‑A with a custom UI. Sessions, JWT scope, events.

Security

🛡️ EMV 3‑D Secure (3DS2)

Challenge loop, ACS POST to returnUrl, authentication values, frictionless support.

Wallets

🍎 Apple Pay

Certificates, domain verification, payment token handoff to VistaPay.

Wallets

🅖 Google Pay

Gateway tokenization (encoded), allowed networks/methods, pay flow.

Wallets

🧰 APM JavaScript Library

Render Apple/Google Pay buttons, obtain tokens, and complete a pay transaction.

Retention

🔒 Tokens

Card-on-file models, agreements, and using tokens as sources.

Ops

📬 Notifications

Signed webhooks with HMAC verification for asynchronous updates.

Ops

🧾 Response Codes

Validation, declines, errors/timeouts. Map results to user messaging.

Sandbox

🧪 Test Cards (SIT)

Scheme coverage and CVC→result mapping for deterministic testing.

Reference

📚 API Reference

Live OpenAPI endpoints and schemas.

VistaPay offerings​

  • Gateway API – Acquirer-agnostic payments with smart routing.
  • Payment Orchestration – Rules for best-cost/highest-acceptance routing.
  • Hosted Payment Pages (HPP) – Drop-in checkout, PayByLink, QR, theming.
  • Hosted Payment Fields (HPF) – Per-field iframes for SAQ-A compliance.
  • Alternative Payment Methods – Apple Pay & Google Pay via JS wrapper.
  • Tokenisation – Store card credentials as tokens for future payments.
  • 3DS2 – Built-in challenge flows and frictionless authentication.
  • Notifications – Signed webhooks for asynchronous updates.

Production base URL: https://checkout.vistapay.co.uk/api/v1/
SIT base URL: https://checkout-test.vistapay.co.uk/api/v1/