Cancel Session
Close an open session from your side: the experience stops, and any connection still running is stopped too.
Key technical details:
- No request body. The cancellation is recorded as yours (
CLIENT_CANCELLED). - Idempotency (
304). A session already finished is left as it is. - Concurrency lock (
504). The cancellation holds the session; if it cannot within a few seconds, retry.
A session that already connected a bank closes as COMPLETED, not as cancelled
If at least one bank had already been connected when you cancelled, the session ends with status_code: COMPLETED and its data is delivered: read it from Get Session Results, and it travels in the end event like any finished session. The session also carries a cancelled_with_products warning, so the outcome stays explainable.
CLIENT_CANCELLED is recorded only when nothing had been connected.
That data came from a real sign-in your customer consented to: cancelling gives up the banks that were not connected yet, not the ones that were.
This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers.
Authentication
Path parameters
Response
204 No Content
Cancelled Successfully