DocsAPI ReferenceBNPL API ReferenceDashboard

Product Features

This section gives you a quick, practical tour of Paypercut’s payment products and how to use them. You’ll find what each feature is for, when to choose it, how it works at a high level, and the key API endpoints/fields to implement fast.

Checkout Experience

What it is:
One Checkout session that you can either redirect to or embed via <iframe> for an on-page experience (same capabilities, same API).

Best for:

  • Redirect: Fastest go-live, minimal frontend work, lowest PCI scope
  • Iframe: On-brand, on-site flow without handling raw card data

How it works:

  1. Create a checkout via API → provide success_url and cancel_url in your payload
  2. Redirect customers to the checkout URL or use the same URL as an <iframe src>
  3. Receive status via webhooks; customers are returned to your success_url or cancel_url after payment

API:
POST /v1/checkouts (server-side, Authorization: Bearer <secret>)

Key options:
amount, currency, success_url, cancel_url, line_items[], mode, qr, client_reference_id, client_customer_id, payment_method_configuration

Payment Links

What it is:
Shareable links to the checkout page for invoices, email/chat, or manual orders.

Best for:
No-code/low-code collections; remote and one-off payments

How it works:

  • Create a checkout and distribute the checkout URL (QR optional)
  • Track results in dashboard and via webhooks

API:
POST /v1/checkouts

Key options:
expires_at, description, line_items[], qr, client_reference_id, success_url, cancel_url

BNPL Aggregator

What it is:
One interface to multiple BNPL providers; Paypercut handles routing, eligibility, and status mapping.

Best for:
Higher conversion/AOV with installments across Europe

How it works:

  • Expose BNPL in checkout
  • Customer is evaluated by a connected provider
  • Status and settlement flow back via unified webhooks

API (preview):
Enable via payment_method_configuration on POST /v1/checkouts

Key options (preview):
bnpl.enabled, bnpl.provider_preference, bnpl.installment_options

Webhooks (preview):
bnpl.approved, bnpl.declined, bnpl.canceled, bnpl.settled

Apple Pay

What it is:
Wallet payments on Apple devices/Safari.

Best for:
Frictionless checkout for iOS/macOS users

How it works:

  • Complete Apple domain verification
  • Enable via payment_method_configuration
  • Apple Pay button appears in checkout (redirect or iframe) on eligible devices

API:
POST /v1/checkouts (+ dashboard/domain setup)

Key options:
payment_method_configuration.apple_pay.enabled, branding/domain settings

Google Pay

What it is:
Wallet payments for Chrome/Android.

Best for:
Fast, tokenized payments across web and Android

How it works:

  • Configure merchant parameters
  • Enable via payment_method_configuration
  • Google Pay shown in checkout (redirect or iframe) on eligible browsers/devices

API:
POST /v1/checkouts

Key options:
payment_method_configuration.google_pay.enabled, merchant ID/config

Web SDK

What it is:
Client utilities to mount the iframe checkout and handle events.

Best for:
A polished, on-site experience with simple JS integration

How it works:

  • Create checkout server-side
  • Initialize SDK
  • Mount iframe with the checkout URL
  • Listen for success/error/close

API:
Works with POST /v1/checkouts (server); SDK on client

Key options:
Mount target, event callbacks, graceful fallbacks, loading states

Webhooks

What it is:
Event delivery for payments, refunds, expirations—subscriptions/BNPL later.

Best for:
Order fulfillment, CRM/ERP sync, analytics

How it works:

  • Configure endpoint in dashboard
  • Verify X-PayPerCut-Signature
  • Implement idempotent handlers

API:
List: GET /v1/webhooks (Bearer auth)

Key events (current):
payment.succeeded, payment.failed, refund.processed, checkout.expired

Dashboard & Reporting

What it is:
Operational hub (“Merchant Dashboard”) for transactions, payouts, refunds, webhook logs, keys, sandbox data.

Best for:
Monitoring health and finance ops

How it works:

  • Use dashboard views and exports
  • Correlate events and payouts
  • Manage API keys and webhooks

Plugins

What it is:
Prebuilt connectors for popular carts: WooCommerce, PrestaShop, OpenCart

Best for:
Fastest path to launch with minimal custom code

How it works:

  • Install plugin
  • Add API keys
  • Choose checkout mode (redirect or iframe)
  • Optional APMs; subscriptions/BNPL supported once live

Ready to get started?
Log in to your Merchant Dashboard and explore all product features today!