Accept Interac (CAD)
Take a payment from a Canadian bank account with an Interac e-Transfer request emailed to the payer, how it settles, and what it needs.
Interac is a second way to pay, next to the Open Banking checkout. There is no hosted page. Nuvion emails the payer an Interac e-Transfer request, the payer accepts it in their Canadian bank, and the money lands in your CAD account.
What you need
- A Nuvion entity that is
approvedand has a CAD account, bound to an organization (Installation). - The payer's name and email address. The email does not have to be Canadian, but the payer needs a Canadian bank account that supports Interac e-Transfer.
- A CAD account for every organization that receives a share. The shares move as CAD book transfers between Nuvion accounts, so the platform and any reseller need CAD accounts too.
- The plugin at version 0.6 or later, and the new
nuvionPayment.methodcolumn (Upgrading).
Create the request
Add method: "interac" and the payer. There is no redirectUrl.
const { data, error } = await authClient.nuvion.payments({
organizationId: shop.id,
amountMinor: 4_900, // CAD 49.00
currency: "CAD",
method: "interac",
payer: { name: "Ada Lovelace", email: "ada@example.com" },
narration: "Order 1042 from Example Shop", // optional: the message in the payer's email
});
// data = { paymentId, method: "interac", checkoutUrl: null, referenceNumber: "CA…", chargedMinor, legs }checkoutUrl is null: tell the customer to check their email for an Interac request, and show them referenceNumber so they can match it.
The plugin refuses the request with 400, before anything is saved, when:
| Rule | Why |
|---|---|
currency is not CAD | Interac collects CAD |
the amount is below 100 or above 2_500_000 | CAD 1.00 to CAD 25,000.00, Nuvion's limits (what the customer is charged, fee included) |
payer.name or payer.email is missing or invalid | the request is emailed to them |
payer.name has anything but letters A to Z, digits, spaces, hyphens, full stops and apostrophes | Nuvion rejects accented letters and underscores. Strip or transliterate before sending |
narration is not 5 to 200 characters of letters, digits, spaces and # . , ' @ $ | Nuvion's rule: no hyphens or underscores |
Nuvion also rejects the same payer, amount and narration twice. The default narration, Payment plus part of the payment id, never repeats. If you set your own, include something unique such as the order number.
What happens next
- The payer gets the email and accepts or declines. A request left unanswered ends as
failedwithin 3 days. - Nuvion only checks with the bank when asked. A new request stays
awaiting_useruntil the first check, and reading it withGETshows only what was last stored. The plugin asks for you in two places: the reconcile, and the refresh endpoint below. - When the request is
settled, the plugin confirms it and runs the same path as for Open Banking: the shares move, andonPaymentSettledfires. - A declined or unanswered request sends no webhook. When the reconcile, or Check now, asks Nuvion and finds the request
failed, the plugin ends the payment asfailedand runsonPaymentFailed, so you can release the order. The plugin stops asking about a payment after 4 days.
An "I have paid" button
Waiting for the next reconcile is slow for someone staring at a page. Let the payer ask now:
<button
onClick={async () => {
const { data, error } = await authClient.nuvion.payments.refresh({
paymentId,
});
// data = { paymentStatus: "pending" | "received" | "splitting" | "settled", recovered: 0 | 1, errors: 0 | 1 }
if (error) alert(error.message); // 429: asked a moment ago
}}
>
I have paid
</button>refresh asks Nuvion about that one payment immediately. It works for the payer who created it or an admin of the organization, and answers 429 if the same payment was asked about in the last 10 seconds. Also run the scheduled reconcile, so payments are checked even when nobody presses anything.
What it does not do
- No hosted page, so there is nothing to redirect to and no
redirectUrl. - No refund to the payer, as for every payment (Refunds).
- No currency conversion: the shares move in CAD.
- Mobile money and stablecoin funding are not built yet (FAQ).
Testing
In Nuvion's test environment you can create a request and refresh it, but a request cannot be accepted there, so test the rest with the engine and a fake provider (Testing): make confirmInflow answer "confirmed" for an interac payment and watch the shares move. When you go live, follow Going to production.