Link Token Information API

API to retrieve detailed information of a link token, including status, sessions, events, and related metadata.

API Endpoint

POST

https://bankhub-api-sandbox.sepay.vn/v1/link-token/get

Request Parameters

link_tokenstringrequired

Token string of the link token (UUID format)

Note

This API requires a Bearer Token in the Authorization header
Returns detailed information including company, sessions, and events
Sessions contain the history of user visits to the link token
Events contain lifecycle events of the link token

Error Handling

404Not Found

The link token does not exist or does not belong to this merchant

401Unauthorized

Invalid or expired access token

400Validation Error

Invalid link_token (wrong format or missing)

API Response

Response 200

{
  "xid": "string",
  "purpose": "LINK_BANK_ACCOUNT",
  "status": "Active",
  "completion_redirect_uri": "string",
  "is_mobile_app": 0,
  "language": "string",
  "session_count": 0,
  "created_at": "string",
  "updated_at": "string",
  "expires_at": "string",
  "company": {
    "full_name": "string",
    "status": "string",
    "xid": "string"
  },
  "sessions": [
    {
      "xid": "string",
      "context": null,
      "state": "PENDING",
      "status": "string",
      "result": null,
      "finished_at": "string",
      "expires_at": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "events": [
    {
      "xid": "string",
      "name": "string",
      "metadata": null,
      "created_at": "string"
    }
  ]
}

xidstring

Unique ID of the link token

purposeenum

Purpose of the link token

statusenum

Current status

completion_redirect_uristring

Redirect URL after completion

is_mobile_appinteger

Whether from mobile app

languagestring

Interface language

session_countinteger

Number of times users have accessed this link token

created_atstring

Creation time

updated_atstring

Last update time

expires_atstring

Expiration time

companyobject

Code Examples

curl --request POST \
  --url https://bankhub-api-sandbox.sepay.vn/v1/link-token/get \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"link_token":"3034ccc8-9cad-4b39-adb3-738c554a7b77"}'