Guides
API Reference

Installing Wyre Checkout

📘

Contents:

  1. Overview
  2. Wyre Checkout Installation
  3. Order Status Polling
  4. Wallet Order Webhook
  5. Test Cards & Supported Types
  6. Go Live

Overview

The Wyre Checkout may be loaded on a page or in a browser dialog. As a partner developer, you will not have direct access to the customer's personal information. The underlying personal information is exposed only in response to demands made to Wyre lawfully (or, in some cases, in support of security authorization).

Wyre Checkout Installation

The Wyre Checkout can be instantiated in two different ways. Both implementations require an API call to generate Wallet Order Reservations.

  • Wyre Checkout - Hosted Dialog: A Wyre-branded card payment processing flow as a popup. The API call to generate Wallet Order Reservations returns a parameterized url and a reservation. The returned reservation is utilized for the Hosted Dialogue and inserted into the widget.

  • Wyre Checkout - Hosted URL: A full-featured, Wyre-branded Debit Card payment processing flow, hosted by Wyre. The API call to generate Wallet Order Reservations returns a parameterized url and a reservation. The returned URL is utilized for the Hosted URL implementation and opened within in a browser window.

Order Status Polling

Each wallet order returns a Wallet Order Id. This orderId can be used to poll the Wallet Order Details endpoint.

Wallet Order Webhook

You can also get order status update via webhooks by registering the Webhook (with sales team [email protected]). Learn about Wallet Order Webhooks. Note: The Wallet Order Webhooks are different than our Data Subscription Webhooks

Test Cards & Supported Types

CardCard NumberExpirationCVV
VISA411111111111111110/23123
Mastercard555555555555444410/23123

Go Live

Before going live, you'll want to make sure that you:

  • Finalize your Partnership Agreement with Wyre
  • Create your production Wyre account and complete KYC
  • Configure the Widget for the production environment

That's it! You're now ready to accept confidently verified users into your application's ecosystem.

🚧

Warning

Apple pay will only work in hosted mode inside Safari and some Opera browsers.