Skip to main content

Lender Start Credit Application Convention

Operator home for start-application work is the merchant record and the lender API tab, not a Cloud Run filename.

  1. Test quotes on Lenders → a lender card → API. The page subtitle is API reference (internal). Header tabs are Credit Products, Lender Settings, and API. The playground heading is API Playground. Send Request posts a finance quote. It does not start a credit application. Do not paste partner keys onto this public page. Lender API.

  2. Turn Apply on from the merchant Overview → Features matrix. On the Finance Assistant row, click the cog (Settings). That opens Finance Assistant Settings (not a fifth merchant tab). Configure Snap Session Start Settings, Zopa Settings, Humm Start Finance Application Settings, and Propensio (Aero API) Settings. Header buttons: Enquiries, Back to Merchant, Back to Merchants. Field list: Lender Apply start. Zopa webhook token and vertical ID: Bon Voyage and Zopa Start.

  3. Read launched applications on the merchant Enquiries tab (Timestamp, Customer, Lender, Credit Product, Purchase, Loan Amount, Status), or click Enquiries in the Settings header. Load row: Loading enquiries.... Empty table: No enquiries found. Tile list: Merchant Page Editing — Enquiries.

Shopper path those settings turn on: Calculator → Enquiry page → Bon Voyage → lender launch. Headless Propensio skips the enquiry page and Bon Voyage screen, not the start API.

The naming table below is for engineers adding or migrating a lender start route. Operators do not edit those files from admin.

Do not paste secrets onto this public page.

Naming (schema / syntax)​

This document defines the naming and structure convention for post-enquiry lender launch flows (e.g. Bon Voyage). Use it when adding or migrating lender “start credit application” flows so that routes, modules, and events stay consistent.

ConceptPatternExample
Action keystart_<lender>_finance_applicationstart_zopa_finance_application
Module filecloud-run/finance-assistant/lenders/start_<lender>_finance_application_logic.jsstart_zopa_finance_application_logic.js
API route/api/lenders/start/<lender>/finance-application/api/lenders/start/zopa/finance-application
Event namingstart_credit_application_*start_credit_application_success, start_credit_application_failed
  • <lender> is the technical lender identifier used in code and URLs (e.g. zopa, snap). Customer-facing names (e.g. Zopa, Snap Finance) stay in config/UI. Historical DivideBuy rows may still display that name.
  • Module: Each such flow is implemented in its own file under cloud-run/finance-assistant/lenders/ and exports a register function that mounts the route on the app.
  • Proxy: The Finance Assistant proxy (Cloudflare worker) must include a pass-through for the same path so browser calls go: proxy → Cloud Run route.
  • Events: Structured logs and telemetry for this flow should use the start_credit_application_* prefix for consistency.

Live start modules that follow this pattern today: Snap, Humm, Zopa, and Propensio (start_snap_finance_application, start_humm_finance_application, start_zopa_finance_application, start_propensio_finance_application).

Backward compatibility​

  • Existing lender routes that do not follow this convention (e.g. /api/lenders/snap/session/start) remain supported until explicitly deprecated.
  • New lender flows should use this convention. When migrating an existing flow, add the new route/module and optionally keep the old route as an alias during transition.