Token

Tokens allow clients to securely send their data to TransactionLink.

The token object represents a one-time token to the workflow for a specific Case.

Each token is unique to a client and has a duration of 60 minutes before it expires, providing a safe and time-limited way to utilize them in the frontend of your application.

Remember to create a new case and a new token each time you initialize the widget for a new end user.

POST Generate Token

Generate widget token

post

Differences between versions: version 1 relies on caseId and is scheduled for deprecation, whereas version 2 uses recordId (this field is optional) and is recommended moving forward.

Body

application/jsonapplication/json;version=2

caseIdstring · uuidRequired

Case identifier for which we want to initiate the workflow

workflowDefinitionIdstringRequired

ID of the workflow definition

Example: 3b2d8a4f-579f-4e2e-a51c-f859e532fe8c

parametersIdstringOptional

ID of the parameters used in the workflow

Example: 4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302

Responses

201

Token has been generated

application/jsonapplication/json;version=2

400

Request is invalid

application/json

404

Case or Record not found

application/json

post

/token

HTTPcURLJavaScriptPython

POST /token HTTP/1.1
Host: api.transactionlink.io
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "caseId": "11111111-2222-3333-4444-555555555555",
  "workflowDefinitionId": "3b2d8a4f-579f-4e2e-a51c-f859e532fe8c",
  "parametersId": "4b6ffcb6-ab6d-44b9-b5ab-4b5147b0b302"
}

application/jsonapplication/json;version=2

{
  "token": "ewogICJhbGciIDogIlJTNTEyIgp9.ewogICJjdXN0b21lcklkIiA6ICIxMTUzNmU2NS00YmIwLTQ3ZGQtOTYwMC03NmFjNTM1Yzc4MzIiLAogICJwYXJ0eUlkIiA6ICIzYjJkOGE0Zi01NzlmLTRlMmUtYTUxYy1mODU5ZTUzMmZlOGMiLAogICJ3b3Jrc3BhY2VJZCIgOiAiMWY5ZDI4YmItNzQ5NC00NTMxLWI1MGUtZmM1YTlhMTFiNDgzIiwKICAiaWF0IiA6IDE2NDUwMjkyOTcsCiAgImV4cCIgOiAxNjQ1MDMyODk3Cn0.j62_fClRsh6vk4Lx2JoMSoEjptUyK9kqtaK_9BtYk3j-Gw-dphMRD4TL0tSc-CBHloV8wl2knMqsyTHLMNSdOkwZYNeSfPwABQEmgNkpOJoyKAxlYAp3KOpkhT4EQgYFeewrK6tgOiLPWy5tlT8NOMJHWJ_VdDGjtBd1jcir1Tp6ipumoUcBfrspHIuXbNVdh7PHJg1mUVHMspvL1WsARVvqHe9KsUszVPdlxc2xJkKFf2jwh70jwjcaXSkBSu4iOVjPdblC6vdvZpRIUK7eSASKexPfQaJXMa0iDv7NEwSAQbrz9iyXiYD5pnRR6MeGAX1d39Z09sxvVzyon_aSvA",
  "expiryDuration": 3600,
  "tokenType": "Bearer"
}