Skip to main content
Create accountContactAlready have an account? Log in
API documentation

2 endpoints

Customer journey

What happened between opening a link or a session and the payment: the steps taken, the drop-offs, the traffic source.

Endpoint names and descriptions come from the OpenAPI contract, in English — they cannot drift from the API.

Start in test mode

You create your test key in the portal as soon as your account is activated.

In plain English

What the buyer does between opening the page and paying.

When to use it

To understand why a link does not convert, or to measure a campaign's effect on your incoming payments.

How to integrate it

  1. 1Ask for a resource's funnel summary to see where buyers stop.
  2. 2Drill down into the events when a specific case puzzles you.
GET

Summarize a resource's funnel and acquisition sources

FieldTypeInRequiredDescription
resourceTypeenumpathRequiredValues PRODUCTPAYMENT_LINKPAYMENT_SESSIONORDER
resourceIdstringpathRequired
GET

List a resource's customer-journey events

Returns the tenant-scoped timeline, including retained IP/geolocation and attribution.

FieldTypeInRequiredDescription
resourceTypeenumpathRequiredValues PRODUCTPAYMENT_LINKPAYMENT_SESSIONORDER
resourceIdstringpathRequired
pageablePageablequeryRequired

Talk to an integrator

Make your first test-mode call

Create your account, generate your test key in the portal and send your first request today — or talk to an integrator.

Start in test modeContact us
  • Free, no commitment
  • Test mode from sign-up
  • No approval to wait for