Documentation — Quadriel

Quickstart

First payment in five minutes

Sign up — instant sandbox, no approval needed. Your test keys are in Developers → API keys.
Create a payment — one object, any rail: method: card | bank_debit | open_banking
Listen for webhooks — every state change, including onboarding status.
Go live — complete onboarding, flip sk_test_ to sk_live_.

# Install
npm install @quadriel/node

# Take a payment
const quadriel = require('@quadriel/node')('sk_test_...');
const payment = await quadriel.payments.create({
  amount: 62050, currency: 'gbp',
  method: 'bank_debit',
  customer: 'cus_9f2Ke',
  schedule: { interval: 'month' }
});

API reference

Core resources

/v1/accountsMerchant onboarding — create, retrieve status, list requirements. One call triggers the card + bank-debit onboardings; open banking activates in-platform post-approval.

/v1/customersThe people you bill — company or individual, registry lookup, payment methods on file.

/v1/paymentsOne-off, recurring or instalment collection on any rail.

/v1/invoicesTax-compliant invoices that raise their own pay links. Free, unlimited.

/v1/payment_linksShareable links and QR codes tied to products.

/v1/payoutsSettlement visibility; split instructions for platforms.

/v1/webhookspayment.settled, mandate.active, account.approved, invoice.paid, and 40 more events.

Full reference ships with the sandbox — open the sandbox →

Test mode

A sandbox that lies to no one

Simulated mandates, settlement timing, webhooks and failure states behave exactly like production — including the boring parts like Bacs three-day cycles, so your reconciliation logic is tested before your first real penny moves.

🔑

Test cards & banks

4242… approves, 4000…0002 declines, and test bank selection simulates the full Pay by Bank redirect.

⏱

Time travel

Advance the clock on a mandate or instalment plan to fire collections and webhooks instantly.

⚡

Onboarding simulator

Drive an application through submitted → in_review → approved and watch the webhooks arrive.