Use Case: One Off Payments

What are One Off Payments?

A One Off Payment is a single payment made once. For One Off Payments, no card or bank account details are stored (unlike recurring payments, where card or bank account information is stored for future payments).

With Pay-By-Link

A One Off Payment with Pay-By-Link means the payer gets directed to your PayEx portal to complete the payment. There they can choose their preferred payment method for this single payment.

Step-by-Step Guide

Build the link with your preferred method:
- Intelligent Links
- JSON Links
Give the link to your payer, for example via email or by displaying it on your website.

With Checkout

A One Off Payment with Checkout means the payer stays on your website to complete the payment. There they can choose their preferred payment method for this single payment.

This integration requires Flywire API credentials and the ability to make API requests for creating and confirming Checkout Sessions.

Step-by-Step Guide

In your frontend: Implement the Checkout Experience form into your website.

See Implementing the Checkout Experience.
In your backend: Create a One Off Checkout Session.

For details about the request see Creating a Checkout Session.

The response contains the hosted-form-URL and the session ID. It depends on your implementation which one you use to display the Checkout Experience form.
In your frontend: Display the form and let the payer fill it out.

For details about the form see Checkout Experience - One off.
In your backend: Confirm the Checkout Session after your payer filled out the form.

You'll receive the confirm URL after the form is filled out. Use this URL to confirm the session.

The response after confirming contains details about the payment.

With Flywire Elements

A One Off payment with Flywire Elements means the payer stays on your website to complete the payment. With elements, you decide on the payment method for the payer by using a specific element.

Available payment methods for One Off payments with elements are:

Card

This integration requires Flywire API credentials and the ability to make API requests for creating and confirming Checkout Sessions.

Step-by-Step Guide

In your frontend:

Implement a trigger on your website that sends an http request to your backend.

The trigger could be a button like "Make Payment". The http request tells your backend to send a secure request to the Flywire API to create a Checkout Session.

What does the http request contain?

How exactly the http request looks like is up to you,
If your payers have accounts on your website, you can use the request to transfer data from your system and use it to pre-fill the fields of the form.
For security reasons, you should also implement some form of authentication.

Why can't I just send a request to the Flywire API call from the frontend?

Because you need your API Key to make an API request. Your API Key is secret and should never be sent from the frontend. Always make API request securely from your backend.
In your backend:

Create a Checkout Session via the API.

From your backend, you can securely create a Checkout Session. You need to know which recipient you want to use for this request.

Tip if you don't know which recipients are available to you or what their recipient ID is

You can use this request to get a list of all recipients that are available to you as a client and what their recipient ID is:

GET /payments/v1/recipients

For details see Getting a List of all available Recipients.

The response contains the hosted-form-URL and the session ID. It depends on your implementation which one you use to display the form.
In your frontend: Display the form and let the payer fill it out.

For details about the form see Payment Element.
In your backend: Confirm the Checkout Session after your payer filled out the form.

You'll receive the confirm URL after the form is filled out. Use this URL to confirm the session.

The response after confirming contains details about the payment.

Flywire API

The Flywire API allows you to integrate Flywire’s payment services into your own system. You can build a custom user interface while taking advantage of Flywire’s payment network, ensuring a smooth and secure payment experience.

Using the Flywire API:

Testing:

Flywire API Sandbox

{
"payment_reference": "RUC208967136",
"charge_info": {
	"amount": 100000,
	"currency": "EUR"
	},
"payment_method": {
	"token": "232301485cfa4b36bc28",
	"type": "card",
	"card_classification": "credit",
	"last_four_digits": "1111",
	"card_expiration": "03/2030",
	"country": "US",
	"brand": "visa",
	"issuer": "JPMORGAN CHASE BANK, N.A."
	},
"mandate": {
	"id": "MCRUC20230330uAM584YC",
	"currency": "EUR",
	"surcharge": {
		"percentage": 0.03
		}
	},
"payor": {     
	"country": "US",
	"email": "[email protected]",
	"state": "NY"
    }					
}

Pay-By-Link

Pay-By-Link is the lightest and easiest integration. You simply generate a link for your payer that you can implement into emails and other places. After clicking the link, your payer will be directed to your unique PayEx portaloutside of your website and all fields you provided values for via the link (for example payer's name or the payment amount) are already pre-filled.

There are two types of Pay-By-Link integrations depending on your use case:

Intelligent Links- build links with URL query parameters

JSON Links- build links via an API request

From: [email protected]

To: Susan Student <[email protected]>

Subject: Welcome to Model University

Model University Enrollment

Dear Susan Student,

We are thrilled to welcome you to Model University! To confirm your enrollment, please make a payment using the button below.

Sincerely,
The Model University Admissions Team

Flywire Elements

Flywire Elements is an integration that provides access to a library of elements. These elements combine UI components (like input fields or dropdowns) with functionality (like charging a payment). You display them on your website to provide payment functionality.

This integration requires Flywire API credentials and the ability to make API requests for creating and confirming Checkout Sessions.

Smart Rendering

Smart Rendering means you render Flywire Elements on your website with the help of the Flywire SDK script.

Extensive customization

Select which payer fields to display, choose the language, and customize the appearance, such as fonts and colors.

Responsive layout

Optimized responsive layout for desktop and mobile devices.

Easy event handling

Simply define what should happen in case of success or errors - no need to filter individual postMessages.

As a fallback option, you can render Flywire Elements in an iframe on your website. The iframe sources a URL that is generated via the Flywire API.

Which Elements are available?

How do I implement Elements?

Implementing the Payment Element

Your Website

How would you like to pay?

Card

Just save new card

Save new card and make first payment

Use existing card

Direct Debit

SEPA

BACS

EFT Canada

ACH

Checkout

The Checkout implementation allows you to embed the Checkout Experience into your own website.

With Checkout, your payers never leave your website:

With the click of a button on your website the Checkout Experience form opens for the payer.
In the form, the payer can choose their preferred payment method and complete the payment.
After the payment is completed and the form is closed, the payer either is returned to the original page or is redirected to a page you specified.

This integration requires Flywire API credentials and the ability to make API requests for creating and confirming Checkout Sessions.

How do I implement the Checkout Experience form?

See Implementing the Checkout Experience

Your Website

How would you like to pay?

Pay full Amount

Pay now

Pay in Installments

Start installment plan