Mint an end-user token
curl --request POST \
--url https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expiresIn": 3600,
"sessionId": "<string>"
}
'import requests
url = "https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token"
payload = {
"expiresIn": 3600,
"sessionId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({expiresIn: 3600, sessionId: '<string>'})
};
fetch('https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expiresIn' => 3600,
'sessionId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token"
payload := strings.NewReader("{\n \"expiresIn\": 3600,\n \"sessionId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expiresIn\": 3600,\n \"sessionId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expiresIn\": 3600,\n \"sessionId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"token": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"expiresIn": 1830,
"tokenId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalUserId": "<string>"
}End users
Mint an end-user token
Mint server-side only. Creates the tenant-scoped end-user record and credit account on first use. JWT claims are sub, tid, iss=locus-credits, aud=locus-credits-enduser, iat, exp, jti, and optional sid. The sid claim is a SHA-256 fingerprint, not the raw session value. Verification allows 30 seconds of clock skew. There is no refresh token; re-authenticate the user and mint a replacement. A sid-bound token requires the original value in X-Locus-Session-Id whenever used.
POST
/
credits
/
end-users
/
{externalUserId}
/
token
Mint an end-user token
curl --request POST \
--url https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expiresIn": 3600,
"sessionId": "<string>"
}
'import requests
url = "https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token"
payload = {
"expiresIn": 3600,
"sessionId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({expiresIn: 3600, sessionId: '<string>'})
};
fetch('https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expiresIn' => 3600,
'sessionId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token"
payload := strings.NewReader("{\n \"expiresIn\": 3600,\n \"sessionId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expiresIn\": 3600,\n \"sessionId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expiresIn\": 3600,\n \"sessionId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"token": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"expiresIn": 1830,
"tokenId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalUserId": "<string>"
}Authorizations
dashboardSessionsecretKey
Locus Pro dashboard session (Cognito).
Path Parameters
Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.
Required string length:
1 - 200Pattern:
^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$Body
application/json
Response
Token
Required range:
60 <= x <= 3600Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.
Required string length:
1 - 200Pattern:
^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$