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

Authorize to obtain access token

POSThttps://api.sandbox.transactionlink.io/auth/authorize

Body

application/json

key*string

Api key

Example: "api key"

secret*string

Secret key

Example: "secret key"

Response

200400401415500502

Application was authorized successfully

Body

application/json

accessToken*string

Access Token

Example: "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjEyMjY5MTI5fQ.PtQ3yPoTfaUMTFi50Zb3v40otI-C0PKvAByRsHkiuVBlWEfS4gvRkO83e7opdv177zfKKoeHQBvcfw6fqk0kmQ"

refreshToken*string

Refresh Token

Example: "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjIwMDQ0ODI5fQ.IMaw2c-N6PS2xAK5I0-mzf2Z8FNHlvM6JjQog5INUcvD3K92oOWbyaBLlmudLoGLntd7EPFX4z3JjKk6YsTZ6A"

tokenType*string

Token type

Example: "Bearer"

expiryDuration*integer

Token expiration time in seconds

Example: 300

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.transactionlink.io/auth/authorize', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "api key",
      "secret": "secret key"
    }),
});
const data = await response.json();

Response

200400401415500502

{
  "accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjEyMjY5MTI5fQ.PtQ3yPoTfaUMTFi50Zb3v40otI-C0PKvAByRsHkiuVBlWEfS4gvRkO83e7opdv177zfKKoeHQBvcfw6fqk0kmQ",
  "refreshToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjIwMDQ0ODI5fQ.IMaw2c-N6PS2xAK5I0-mzf2Z8FNHlvM6JjQog5INUcvD3K92oOWbyaBLlmudLoGLntd7EPFX4z3JjKk6YsTZ6A",
  "tokenType": "Bearer",
  "expiryDuration": 300
}

POST Refresh access token

Refresh access token

POSThttps://api.sandbox.transactionlink.io/auth/refresh

Body

application/json

refreshToken*string

Refresh token

Example: "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjIwMDQ0ODI5fQ.IMaw2c-N6PS2xAK5I0-mzf2Z8FNHlvM6JjQog5INUcvD3K92oOWbyaBLlmudLoGLntd7EPFX4z3JjKk6YsTZ6A"

Response

200400401415500502

Token was successfully

Body

application/json

accessToken*string

Access Token

Example: "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjEyMjY5MTI5fQ.PtQ3yPoTfaUMTFi50Zb3v40otI-C0PKvAByRsHkiuVBlWEfS4gvRkO83e7opdv177zfKKoeHQBvcfw6fqk0kmQ"

refreshToken*string

Refresh Token

Example: "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjIwMDQ0ODI5fQ.IMaw2c-N6PS2xAK5I0-mzf2Z8FNHlvM6JjQog5INUcvD3K92oOWbyaBLlmudLoGLntd7EPFX4z3JjKk6YsTZ6A"

tokenType*string

Token type

Example: "Bearer"

expiryDuration*integer

Token expiration time in seconds

Example: 300

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.transactionlink.io/auth/refresh', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "refreshToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjIwMDQ0ODI5fQ.IMaw2c-N6PS2xAK5I0-mzf2Z8FNHlvM6JjQog5INUcvD3K92oOWbyaBLlmudLoGLntd7EPFX4z3JjKk6YsTZ6A"
    }),
});
const data = await response.json();

Response

200400401415500502

{
  "accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjEyMjY5MTI5fQ.PtQ3yPoTfaUMTFi50Zb3v40otI-C0PKvAByRsHkiuVBlWEfS4gvRkO83e7opdv177zfKKoeHQBvcfw6fqk0kmQ",
  "refreshToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjIwMDQ0ODI5fQ.IMaw2c-N6PS2xAK5I0-mzf2Z8FNHlvM6JjQog5INUcvD3K92oOWbyaBLlmudLoGLntd7EPFX4z3JjKk6YsTZ6A",
  "tokenType": "Bearer",
  "expiryDuration": 300
}

GET Public key

Obtain public key

Public key for validating webhook JWS signatures

GEThttps://api.sandbox.transactionlink.io/auth/webhooks/key/{keyId}

Path parameters

keyId*string (uuid)

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

Query parameters

Response

200400404500502

Public key obtained successfully

Body

text/plain

string

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.transactionlink.io/auth/webhooks/key/{keyId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500502

text