HomeStatusSign in ->

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
Body
keystringRequired

Api key

Example: api key
secretstringRequired

Secret key

Example: secret key
Responses
200
Application was authorized successfully
application/json
post
POST /auth/authorize HTTP/1.1
Host: api.sandbox.transactionlink.io
Content-Type: application/json
Accept: */*
Content-Length: 39

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

POST Refresh access token

Refresh access token

post
Body
refreshTokenstringRequired

Refresh token

Example: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJlZUNUUWJnMHNIekhHVlFMdzZHcnhjZ0RVcUhHejBKUyIsImlhdCI6MTYxMjI2ODgyOSwiZXhwIjoxNjIwMDQ0ODI5fQ.IMaw2c-N6PS2xAK5I0-mzf2Z8FNHlvM6JjQog5INUcvD3K92oOWbyaBLlmudLoGLntd7EPFX4z3JjKk6YsTZ6A
Responses
200
Token was successfully
application/json
post
POST /auth/refresh HTTP/1.1
Host: api.sandbox.transactionlink.io
Content-Type: application/json
Accept: */*
Content-Length: 229

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

GET Public key

Obtain public key

get

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
Responsestring
get
GET /auth/webhooks/key/{keyId} HTTP/1.1
Host: api.sandbox.transactionlink.io
Accept: */*

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

Last updated

Was this helpful?