Advance

Advances the test clock’s current time. You can either specify a new absolute time or advance by a duration.

PATCH /v0/testClocks/{id}

Advance

cURL

curl --request PATCH \
  --url https://api.paygentic.io/v0/testClocks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currentTime": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.paygentic.io/v0/testClocks/{id}"

payload = { "currentTime": "2023-11-07T05:31:56Z" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({currentTime: '2023-11-07T05:31:56Z'})
};

fetch('https://api.paygentic.io/v0/testClocks/{id}', 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.paygentic.io/v0/testClocks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'currentTime' => '2023-11-07T05:31:56Z'
  ]),
  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.paygentic.io/v0/testClocks/{id}"

	payload := strings.NewReader("{\n  \"currentTime\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.paygentic.io/v0/testClocks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"currentTime\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/testClocks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"currentTime\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "tc_w9x0y1z2a3b4c5d6",
  "createdAt": "2024-03-01T09:00:00Z",
  "currentTime": "2024-03-20T14:00:00Z",
  "deletedAt": null,
  "description": "Test clock for daily usage billing scenarios",
  "merchantId": "org_e7f8g9h0i1j2k3l4",
  "name": "Daily Usage Test",
  "updatedAt": "2024-03-20T14:00:00Z"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

Authorizations

Authorization · string · header · required

API key authentication

Path Parameters

id · string · required

The unique identifier of the test clock

Pattern: ^tc_[a-zA-Z0-9]{16}$

Body

application/json

Option 1

Option 2

currentTime · string<date-time> · required

New absolute time for the test clock (must be forward in time)

Response

200

application/json

Test clock updated successfully

id · string · required

Unique identifier for the test clock

Pattern: ^tc_[a-zA-Z0-9]{16}$

createdAt · string<date-time> · required

When the test clock was created

currentTime · string<date-time> · required

The simulated current time of the test clock

merchantId · string · required

The merchant organization that owns this test clock

updatedAt · string<date-time> · required

When the test clock was last updated

deletedAt · string<date-time> | null

When the test clock was deleted (if applicable)

description · string | null

Description of the test clock's purpose

name · string | null

Name of the test clock