About Roqqett - Equals Documentation

Roqqett lets your customers pay you straight from their bank account. Instead of entering card details, the payer picks their bank, approves the payment in their banking app or online banking, and the money moves account to account. GBP payments go over Faster Payments and EUR payments over SEPA Instant.

Key concepts

Concept	What it is
Merchant	Your Roqqett profile: the name, logo and colours payers see.
Settlement account	One of your own bank accounts that payments settle into. It must be `APPROVED` before it can receive funds.
Checkout	A payment page you configure once: its currency, return URL, settlement account and whether to collect a shipping address.
Checkout session	One payment journey on a checkout, for one basket or amount. You create one each time a customer pays.
Payment	A record of money moving. Each payment has a `type`: `PAYMENT` moves money from the payer and `REFUND` moves it back.
Order	The record of a completed shopping checkout session.
Payee	A bank account, other than your own settlement account, that a top-up checkout session pays into.

A checkout has one of two types:

SHOPPING takes payment for a basket into your settlement account.
TOP_UP pays into a payee you supply, for example to fund a customer’s wallet. Equals must enable top-ups for your account.

How a payment works

Your server creates a checkout session

Your backend creates a checkout session for the amount and basket. Keep prices on your server, so a customer can’t change what they pay.

The payer goes to Roqqett

You send the payer to the Roqqett payment pages, where they choose their bank.

The payer approves the payment at their bank

The payer approves the payment in their banking app or online banking. On a desktop, they can carry on there or move to their phone.

You confirm the outcome

The payer returns to your site, and your server checks the session’s status before fulfilling the order.

A checkout session doesn’t fail when a bank payment does. The payer can retry, with the same bank or a different one, until the session completes, is cancelled or expires.

Choose an integration

Integration	How the payer pays	Which API
Hosted checkout	You redirect the payer to the `checkoutUrl` of a checkout session.	Roqqett V2, on `https://api.equalsmoney.com/v2`.
Embedded checkout	The Roqqett JavaScript library opens the payment journey in a pop-up over your page.	Roqqett V1, on `https://api.roqqett.com`.

Use the hosted checkout for a new integration. The embedded checkout is for merchants who already use the Roqqett JavaScript library. It still works, but the V1 API it relies on is deprecated. See Migrating from Roqqett V1.

Testing

There is no Roqqett sandbox yet, and V2 checkout sessions have no test mode. To check a hosted checkout integration before you go live, take a few small real payments, confirm that they reach your settlement account, then refund them. The embedded checkout has a test mode for V1 carts.

​Key concepts

​How a payment works

​Choose an integration

​Testing

Key concepts

How a payment works

Choose an integration

Testing