Skip to content

System

System health check endpoints

Operations

Check connectivity and authentication

Request

This endpoint allows you to verify connectivity to the API and validate your authentication credentials. A successful response indicates that the API is reachable and your credentials are valid.

Required scope: system:read

Security
accountId and apiKey
curl -i -X GET \
  https://api.test.easypay.pt/2.0/system/ping \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

Success

Bodyapplication/json
environmentstring
Example:"sandbox"
timestring, (date-time)
Example:"2026-01-01T12:00:00Z"
Response
{
  "environment": "sandbox",
  "time": "2026-01-01T12:00:00Z"
}