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.
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
- 1Ask for a resource's funnel summary to see where buyers stop.
- 2Drill down into the events when a specific case puzzles you.
- GET
/v1/analytics/journeys/{resourceType}/{resourceId}/summarySummarize a resource's funnel and acquisition sources - GET
/v1/analytics/journeys/{resourceType}/{resourceId}/eventsList a resource's customer-journey events
GET
Summarize a resource's funnel and acquisition sources
| Field | Type | In | Required | Description |
|---|---|---|---|---|
resourceType | enum | path | Required | Values PRODUCTPAYMENT_LINKPAYMENT_SESSIONORDER |
resourceId | string | path | Required |
GET
List a resource's customer-journey events
Returns the tenant-scoped timeline, including retained IP/geolocation and attribution.
| Field | Type | In | Required | Description |
|---|---|---|---|---|
resourceType | enum | path | Required | Values PRODUCTPAYMENT_LINKPAYMENT_SESSIONORDER |
resourceId | string | path | Required | |
pageable | Pageable | query | Required |
A question about integration?
Our technical team supports integrators from the first sandbox call through to go-live.