---
title: "Create interaction ID"
method: POST
path: "/backend/{gatewayname}/v1/interaction"
---

# Create interaction ID

`POST /backend/{gatewayname}/v1/interaction`

An Interaction ID is a one-time identifier used to initialise the Gateway SDK and launch a journey for a user. Every interaction is created with an `intent` that determines what the SDK does.

## Path parameters

- `gatewayname` string, required

## Headers

- `x-gateway-secret` string, required
- `x-gateway-authtoken` string, required

## Request body

- object
  - `intent` 'LOAN_APPLICATION' | 'LAUNCH' | 'PAYMENT' | 'WITHDRAW' | 'SERVICE', required — Required | Define the type of Interaction to create
  - `config` object, required — Required | Additional information on the Interaction to create
    - `type` 'bounced_interest' | 'principal' | 'shortfall' | 'loan_closure' — Optional | Required only with the "PAYMENT" intent
    - `amount` string — Optional | Required only with the "WITHDRAW" intent
    - `lender` string, required — Required | Choice of the lender for the LAMF journey
    - `userId` string — Optional | Existing Unity User ID if applicable
    - `opaqueId` string — Optional | To attribute your system identifier with the Interaction
    - `lid` string — Optional | Required only with "PAYMENT" and "WITHDRAW" intents
    - `loans` unknown[]
      - unknown
  - `referrer` string — Optional | Only if part of the LAMF referrer program and Guest journey

## Response `200`

200

- union
  - object
    - `code` integer
    - `data` object
      - `createdAt` integer
      - `expireAt` integer
      - `guest` boolean
      - `intent` string
      - `interactionId` string
      - `lender` string
      - `partner` string
      - `status` string
      - `userId` string
    - `message` string
  - object
    - `code` integer
    - `data` object
      - `createdAt` integer
      - `expireAt` integer
      - `guest` boolean
      - `intent` string
      - `interactionId` string
      - `lender` string
      - `partner` string
      - `status` string
    - `message` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/smallcase/apis/graph-performance-api.md) · [All operations](https://skmtc.net/smallcase/apis/graph-performance-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smallcase/graph-performance-api/versions/6d2439eafede/schema)