Sign in

v1

latestOpenAPI 3.0.32026-07-24190128.9 KB

Create interaction ID

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.

post/backend/{gatewayname}/v1/interaction

Path parameters

gatewaynamestring required

Headers

x-gateway-secretstring required

Required | apiSecret shared for authentication

x-gateway-authtokenstring required

Required | JWT created with payload {"iss":"<your_gateway_name>"}, and signed with the shared secret

Request body

intent'LOAN_APPLICATION' | 'LAUNCH' | 'PAYMENT' | 'WITHDRAW' | 'SERVICE' required

Required | Define the type of Interaction to create

referrerstring

Optional | Only if part of the LAMF referrer program and Guest journey

Response

200

OR

Example response

{
  "data": {
    "createdAt": 1686253244,
    "expireAt": 1686253544,
    "intent": "LOAN_APPLICATION",
    "interactionId": "INT64822ebcb406ec46428efac0",
    "lender": "bajaj_finserv",
    "partner": "gatewaydemo-dev",
    "status": "CREATED",
    "userId": "646f5a65a4ae4db366623638"
  },
  "message": "SUCCESS"
}