PaygateDeveloper documentation

Advance Clock

POST/api/v1/test/clock/advance
operationId
testkit.AdvanceClock
Permission
simulate
Idempotency
required

An Idempotency-Key header is required.

Parameters

FieldinTypeRequiredDescription
Idempotency-KeyheaderstringYes
PG-Versionheaderstring

Request body

application/json

FieldTypeRequiredDescription
secondsinteger

Example

Generated from the schema — a shape, not a sample.

{
  "seconds": 0
}

Responses

200 OK

AdvanceReport

Response headers: `X-Request-Id`

FieldTypeRequiredDescription
action_idstring
advanced_secondsinteger
jobs_runinteger
shiftedobject
{
  "action_id": "string",
  "advanced_seconds": 0,
  "jobs_run": 0,
  "shifted": {}
}

default Error

Problem

FieldTypeRequiredDescription
codestringYes
detailstring
detailsobject
errorsobject[]
errors.codestring
errors.fieldstring
errors.messagestring
instancestring
statusintegerYes
titlestringYes
typestring
{
  "code": "string",
  "detail": "string",
  "details": {},
  "errors": [
    {
      "code": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "instance": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

Errors

Derived from the modules this operation touches, because the snapshot carries no x-errors list yet — it may list codes this operation cannot return.

Try it

POST/test/clock/advance

Makes a real call in test mode with your own key. The key stays in this tab and is never sent anywhere but the API.

No API base URL is configured for this environment, so try-it is unavailable.

Starts with pg_test_. A live key is refused before any request is made.

curl -X POST '<API_BASE_URL>/api/v1/test/clock/advance' \
  -H 'Authorization: Bearer pg_test_…' \
  -H 'PG-Version: 2026-09-01' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <uuid v7>' \
  -d '{
  "seconds": 0
}'