Hosted checkout

Using the Vyne hosted checkout is the simplest way to start taking payments through your application

The Vyne hosted checkout is fast and simple to integrate, with no need to build any checkout flow. Before you proceed, make sure you understand the payment flow.

Bank selection and consent

The API response body of a PIRPIR - Payment Initiation Request or RPIRRPIR - Recurring Payment Initiation Request contains everything necessary to present the payment to the consumer. The hosted checkout provides two media types for interacting with consumers, to fit a range of use cases.

Media type

Use case



Checkout button - integrating into an existing e-commerce checkout flow.

Vyne is presented as an option at checkout when consumers make online purchases. When selected by the consumer, the consumer is taken to the hosted checkout.


E-mail or SMS link - offline sales with need for deposit or full purchase, such as car showroom or furniture retail. Follow up payment for contracted services such as home or auto-repair.

A link is sent to the consumer by e-mail or SMS to request payment. When clicked by the consumer, the consumer is taken to the hosted checkout.

QR code

Presenting a QR code on-screen for a consumer to initiate payment, such as PoS retail.

A QR code is presented to the consumer on-screen or printed. When scanned on the consumer's device using the camera, the consumer is taken to the hosted checkout.

Example response

  "redirectUrl": "<redirect_url>",
  "qrCodeUrl": "<qr_code_url>",
  "requestId": "adca2b6a077de1f5",
  "mediaType": "URL"




The URL of the hosted checkout page to be presented to consumers. This value is returned when mediaType is URL.


The URL of the QR code which encodes the URL of the payment page. This value is returned when mediaType is QR.

Vyne handles the bank selection and consent in the hosted checkout experience. Consumers are required to:

  1. Select the bank they wish to make the payment from
  2. Consent to payment
  3. Proceed to their bank for authorisation

The hosted checkout is designed and built by Vyne, follows industry standard web practices, and provides:

  • Payment summary to confirm the amount and beneficiary.
  • QR code on desktop to hand-off payment to mobile.
  • Country search to filter banks
  • Consent confirmation prior to payment.

Mobile hand-off

The Vyne hosted checkout presents consumers with a QR code, enabling them to hand-off the payment process to another device. Scanning the QR code opens a URL which will direct the consumer the checkout on the device, allowing them to use mobile banking on their device.

After the user has handed-off to mobile device and continued the payment flow, the checkout is kept alive on the original device, and shows helpful instructions to preserve continuity with the mobile payment flow.


Helpful to know

Mobile hand-off allows for fast authentication on a mobile device, even when the checkout flow has been initiated on a desktop device. By completing the payment flow on mobile, payment can be authorised using mobile banking (bank app) on the mobile device without having to sign in to the bank on desktop.

Authentication and authorisation

Once the consumer selects a bank, the bank's mobile banking app will automatically launch if installed on their device. If the consumer does not have the bank's mobile banking app installed on their device, the bank’s online banking sign in page will be opened in a browser. When launched into mobile banking or online banking, the consumer can use biometrics or credentials to sign in.

The consumer is required to approve the transaction, which is done in a single step. Once approved, the bank transfer is immediately initiated and 100% of the funds are sent directly to the account selected by the merchant.


When the consumer has completed a payment they're redirected to a redirect URL you provide in the PIRPIR - Payment Initiation Request or RPIRRPIR - Recurring Payment Initiation Request. A payload is appended to the callback URL containing a status so you can render feedback to consumers immediately. Vyne also sends webhooks to give you real-time updates on payment status.

Did this page help you?