---
title: "Create a Flinks Connect session for the embedded payment flow"
method: POST
path: "/api/v1/embedded/flinks-session"
tags: ["Embedded"]
---

# Create a Flinks Connect session for the embedded payment flow

`POST /api/v1/embedded/flinks-session`

Create a Flinks Connect session for the embedded payment flow

## Request body

- EmbeddedFlinksSessionInput
  - `institution_id` integer — Optional Flinks institution ID. When provided, the Flinks iframe skips bank selection and goes directly to credential entry for that institution.

## Response `200`

Success

- EmbeddedFlinksSessionResponse
  - `success` boolean, required — Indicates if the request was successful
  - `data` object, required
    - `session_id` string, uuid, required — Internal session identifier for the Flinks Connect flow.
    - `connect_url` string, uri, required — URL to load in the Flinks Connect iframe.
    - `expires_at` string, date-time, required — When this session expires.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

## Changes

- **2026-06-16** `b372e7d5563d` — 1 info
  - endpoint added
- **2025-11-02** `919eb7a392aa` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/banqzinc/apis/quidkey-api/changes/api/v1/embedded/flinks-session/post.md)

---

[API](https://skmtc.dev/banqzinc/apis/quidkey-api.md) · [All operations](https://skmtc.dev/banqzinc/apis/quidkey-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/banqzinc/quidkey-api/revisions/f86d2bdbcb08/schema)