Skip to main content
POST
/
terminals
/
auth
Auth
curl --request POST \
  --url https://api.staging.paycodefintech.net/terminals/auth \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "current_versions": {
    "acquirer_param_version": "v3.2.0",
    "aid_version": "v1.3.0",
    "biometric_key_version": "v1.2.0",
    "capk_version": "v2.6.0",
    "cvm_version": "v1.0.9",
    "emv_key_version": "v2.7.0",
    "file_key_version": "v3.4.0",
    "firmware_version": "v2.4.2",
    "fx_rates_version": "v1.3.0",
    "hot_cards_version": "v1.1.0",
    "pure_tags_version": "v3.2.0",
    "tac_version": "v1.1.2",
    "tms_param_version": "v4.0.5"
  },
  "device_health": {
    "batterylevel": 85,
    "signalstrength": "strong",
    "tamperdetected": false,
    "temperature": 36.5
  },
  "geolocation": {
    "latitude": -1.2921,
    "longitude": 36.8219
  },
  "terminal_id": "term_tPYmyt3FEfKl83JiHpb2"
}
'
{
  "expires_in_seconds": 3600,
  "network_token": "TI5vXQgbZZPHXP7TOCo0",
  "sync_required": true,
  "update_hints": {
    "AID_version": "v2.1.6",
    "CAPK_version": "v3.0.1"
  }
}

Authorizations

​
api-key
string
header
required

Use the API key created under your merchant account from the Paycode dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Body

application/json

Request body for terminal auth handshake

Request payload for POS login handshake

​
terminal_id
string
required

Terminal ID (required)

​
current_versions
object
required

Terminal parameter versions (MOSOLO specification)

​
geolocation
object
​
device_health
object
​
network_token
string | null

token for session if available

Response

Terminal authorized

Response for parameter download request

​
network_token
string
required

Network token for authentication

​
expires_in_seconds
integer<int32>
required

Token expiration time in seconds

Required range: x >= 0
​
sync_required
boolean
required

Whether synchronization is required

​
update_hints
object

Update hints for newer versions available