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

post

/auth/authorize

Body

keystringrequired

Api key

Example: api key

secretstringrequired

Secret key

Example: secret key

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sandbox.transactionlink.io/auth/authorize' \
  --header 'Content-Type: application/json' \
  --data '{"key":"api key","secret":"secret key"}'

200

400

401

415

500

502

200

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

Application was authorized successfully

POST Refresh access token

Refresh access token

post

/auth/refresh

Body

refreshTokenstringrequired

Refresh token

Example: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjIwMDQ0ODI5fQ.IMaw2c-N6PS2xAK5I0-mzf2Z8FNHlvM6JjQog5INUcvD3K92oOWbyaBLlmudLoGLntd7EPFX4z3JjKk6YsTZ6A

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sandbox.transactionlink.io/auth/refresh' \
  --header 'Content-Type: application/json' \
  --data '{"refreshToken":"eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjIwMDQ0ODI5fQ.IMaw2c-N6PS2xAK5I0-mzf2Z8FNHlvM6JjQog5INUcvD3K92oOWbyaBLlmudLoGLntd7EPFX4z3JjKk6YsTZ6A"}'

200

400

401

415

500

502

200

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

Token was successfully

GET Public key

Obtain public key

Public key for validating webhook JWS signatures

get

/auth/webhooks/key/{keyId}

Path parameters

keyIdstring · uuidrequired

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

Query parameters

pemboolean · default: true

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

Responses

text/plain

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sandbox.transactionlink.io/auth/webhooks/key/{keyId}'

200

400

404

500

502

200

Default response

Response with query param pem=false

Default response

-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAiTu+U0W+NitQY1YEFCrj
vZJPdICHaGEUtHyETr7RvtfikDb0pSb97us0NtLJsDitXWDw8cqLp7qrI90IsjY4
qR1NHI1q1TLQdDJmOvd5b6Fglas9p5fN5ODNRcF3hz5f77cPBqNwKBrdzqubEsOw
y+5amL4SIcrsq9KiO/YjAQh7YTBTZviAY7gJKqrbIGzcWpzWdcLnWn2/YgPUlY1K
wy6XzpUWRLpWc2BhRyEwiIhlAEfh0nfBBzlkXyLm4VGscCd7Sj+ExJ/4vhYSOG8C
bufO/BbxEC1zH6S1Y59crbpcw1Wn64EdnFx2AVn6YXzZrgeuT/QdpCIfLbVU9zSS
0wIDAQAB
-----END PUBLIC KEY-----

Public key obtained successfully