Everest Card — API reference
  • Credit
  • Debit
  • Prepaid
  • Corebanking
  • OAuth2
  • Delivery
Information
Platform
    Authentication
      authorizeposttokenpostrevokepostintrospectpost
    Platform operations
      healthCheckpost
SchemasError codes
powered by Zudoku
OAuth2 Security Token Service
OAuth2 Security Token Service

Platform operations

Health checks and cache refresh. Called by your monitoring, not by a cardholder journey.


healthCheck

POST
https://everest-sandboxapi.dgpays.com/SandBox
/oAuth2/sts/api/healthCheck

Performs a lightweight health probe to confirm the STS component is running and able to respond to requests. This endpoint is intended for monitoring systems, load balancers, and deployment readiness checks. The response includes a simple result indicator and a server timestamp to help validate connectivity and clock sanity. Use this operation to quickly distinguish platform/network issues from functional authorization/token errors.

healthCheck › Headers

evrst-ptrnid
​string

Correlation id for this request. Echo it in your own logs to trace the call through the platform.

Default: x_request_id

healthCheck › Responses

Success

HealthCheckResponse
date
​string · date-time · required

Date

result
​string | null

Result - [Optional]

POST/oAuth2/sts/api/healthCheck
curl https://everest-sandboxapi.dgpays.com/SandBox/oAuth2/sts/api/healthCheck \ --request POST \ --header 'evrst-ptrnid: x_request_id'
Example Responses
{ "result": "result", "date": "2024-08-25T15:00:00Z" }
json
application/json

AuthenticationError codes