Skip to main content

Integration touchpoints

Edge is configuration-driven by design: most implementations never call a platform API directly. The integration surface you work with is your Salesforce org and your tenant configuration. This page summarizes the touchpoints that exist and where each one is documented.

Salesforce REST endpoint (Edge Pay)

Edge Pay communicates with your org through a REST endpoint exposed by the Kaptio managed package:

salesforce:
rest_endpoint: /services/apexrest/edge/payments

The platform calls this endpoint to read payment context (schedules, amounts, itinerary status) and to write payment results back to the itinerary. You configure the endpoint path and the extra fields it may read in payment.yaml; the gateway routing record in your org is covered in Salesforce integration.

Every generated document is delivered as a secure viewer URL — the {{viewerUrl}} binding available in email templates. Viewer links:

  • are signed per tenant and expire according to your blueprint's security and viewer_lifecycle settings,
  • render expiry and superseded-version banners using the wording you configure under document_validity,
  • require no authentication from the guest beyond possession of the link.

Lifecycle configuration is covered in Blueprint: document actions & email.

Generation triggers

Documents are generated two ways:

TriggerConfigured inExample
User actioncreate_document_actionsA sales agent clicks "Create Proposal" on an itinerary.
Automaticauto_generated_documentsA booking confirmation generates and sends when a booking is confirmed; a financial summary generates when a payment is received.

Both are configuration, not API calls — see Document types.

Eligibility queries

Payment eligibility rules in payment.yaml run SOQL against your org at payment time (for example, blocking payment unless the itinerary is in Option or Booked status). These are declared in configuration and reviewed with Kaptio during onboarding — see the payment.yaml reference.

Programmatic checkout (advanced)

E-commerce checkout sessions and card-tokenization flows (quote acceptance with card-on-file) exist as capabilities in the platform and ship in the baseline as disabled stubs. They involve per-tenant endpoint and webhook provisioning, and are enabled with Kaptio during implementation. If your project needs web checkout integration, raise it with your implementation team — the configuration shape is shown in the payment.yaml reference.