Authentication

See how you can authenticate with TransactionLink.

All API requests must be made over HTTPS. Any requests made over HTTP will fail.

`POST` Authorize token

Deprecated

Authorize workspace (deprecated)

post

Deprecated — This endpoint issues a JWT Bearer token (accessToken) for workspace authentication. JWT-based authentication is deprecated in favor of organization tokens (tot_). Use organization tokens obtained from the dashboard instead of this endpoint.

Body

keystringRequired

Workspace API key

secretstringRequired

Workspace API secret

Responses

200

OK – JWT tokens issued

application/json

accessTokenstringRequired

JWT access token (Bearer)

refreshTokenstringRequired

Refresh token for obtaining a new access token

tokenTypestringRequired

Token type — always Bearer

Example: Bearer

expiryDurationinteger · int64Required

Token validity duration in seconds

400

Bad Request – invalid credentials

application/json

500

Internal Server Error – unexpected server error

application/json

post/auth/authorize

POST /auth/authorize HTTP/1.1
Host: api.transactionlink.io
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "key": "your-workspace-key",
  "secret": "your-workspace-secret"
}

{
  "accessToken": "eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjYyZWY1YjRiLTU0MDEtNGU3Ni1hYmMzLTkzZTdkOGZiY2JhNyJ9.",
  "refreshToken": "dGhpcyBpcyBhIHJlZnJlc2ggdG9rZW4gZXhhbXBsZQ==",
  "tokenType": "Bearer",
  "expiryDuration": 3600
}

`POST` Refresh access token

Deprecated

Refresh JWT token (deprecated)

post

Deprecated — This endpoint refreshes a JWT Bearer token using a refresh token. JWT-based authentication is deprecated in favor of organization tokens (tot_). Use organization tokens obtained from the dashboard instead of this endpoint.

Body

refreshTokenstringRequired

Refresh token obtained from a previous authorization

Responses

200

OK – new JWT tokens issued

application/json

accessTokenstringRequired

JWT access token (Bearer)

refreshTokenstringRequired

Refresh token for obtaining a new access token

tokenTypestringRequired

Token type — always Bearer

Example: Bearer

expiryDurationinteger · int64Required

Token validity duration in seconds

400

Bad Request – invalid or expired refresh token

application/json

500

Internal Server Error – unexpected server error

application/json

post/auth/refresh

POST /auth/refresh HTTP/1.1
Host: api.transactionlink.io
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "refreshToken": "dGhpcyBpcyBhIHJlZnJlc2ggdG9rZW4gZXhhbXBsZQ=="
}

{
  "accessToken": "eyJhbGciOiJub25lIn0.eyJ3b3Jrc3BhY2VJZCI6IjYyZWY1YjRiLTU0MDEtNGU3Ni1hYmMzLTkzZTdkOGZiY2JhNyJ9.",
  "refreshToken": "dGhpcyBpcyBhIHJlZnJlc2ggdG9rZW4gZXhhbXBsZQ==",
  "tokenType": "Bearer",
  "expiryDuration": 3600
}

`GET` Public key

Obtain public key

get

/auth/webhooks/key/{keyId}

Public key for validating webhook JWS signatures

Path parameters

keyIdstring · uuidRequired

UUID of the key, returned as kid parameter in webhook JWS header

Query parameters

pembooleanOptional

Param indiciating whether public key should be returned in PEM format or simple base64

Default: true

Responses

200

Public key obtained successfully

text/plain

stringOptional

400

Request is invalid

application/json

404

Public key not found

application/json

500

Internal service error

application/json

502

Upstream service failure

application/json

get/auth/webhooks/key/{keyId}

GET /auth/webhooks/key/{keyId} HTTP/1.1
Host: api.sandbox.transactionlink.io
Accept: */*

PreviousAPI Reference NextWorkflows

Last updated 2 months ago

POST Authorize token

Authorize workspace (deprecated)

POST Refresh access token

Refresh JWT token (deprecated)

GET Public key

Obtain public key

`POST` Authorize token

`POST` Refresh access token

`GET` Public key