Rotate the Signing Secret

Generate a fresh signing secret. By default rotation opens a 24-hour dual-signature grace window: the new secret signs immediately, and the outgoing secret keeps signing as a second v1= entry in X-Webhook-Signature until previous_secret_expires_at. A verifier that matches ANY entry keeps accepting deliveries, so you can deploy the new secret without dropping events.

Pass ?immediate=true to skip the window — the old secret stops verifying at once. Use this when rotating a leaked secret, accepting that deliveries to a not-yet-updated endpoint will fail verification.

The new secret is shown once in the response. Store it now.

POST

webhooks

{id}

secret

rotate

Rotate the signing secret

curl --request POST \
  --url https://api.antonpayments.com/v1/webhooks/{id}/secret/rotate \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    DPoP: '<api-key>'
  }
};

fetch('https://api.antonpayments.com/v1/webhooks/{id}/secret/rotate', 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.antonpayments.com/v1/webhooks/{id}/secret/rotate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "DPoP: <api-key>",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.antonpayments.com/v1/webhooks/{id}/secret/rotate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "secret": "<string>",
    "previous_secret_expires_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

DPoP

string

header

required

Per-request DPoP proof JWT (RFC 9449). MUST accompany the Authorization: DPoP <access_token> header on every protected operation. The proof is signed by the merchant's private DPoP key and carries htm, htu, iat, jti, and ath claims.

Headers

Idempotency-Key

string

required

Unique key identifying this operation. Sending the same key twice returns the original response instead of creating a duplicate. Keys are retained for 24 hours.

Maximum string length: 255

Path Parameters

string

required

Pattern: ^whk_[a-zA-Z0-9]+$

Query Parameters

immediate

boolean

default:false

When true, skip the dual-signature grace window: the previous secret is dropped at once and previous_secret_expires_at is null.

Response

Rotated. Response carries the new secret.

data

object

required

Show child attributes

⌘I

Rotate the signing secret

curl --request POST \
  --url https://api.antonpayments.com/v1/webhooks/{id}/secret/rotate \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    DPoP: '<api-key>'
  }
};

fetch('https://api.antonpayments.com/v1/webhooks/{id}/secret/rotate', 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.antonpayments.com/v1/webhooks/{id}/secret/rotate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "DPoP: <api-key>",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.antonpayments.com/v1/webhooks/{id}/secret/rotate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "secret": "<string>",
    "previous_secret_expires_at": "2023-11-07T05:31:56Z"
  }
}

Overview

Cross-Cutting

Reference Data

Beneficiaries

Instruments

Intelligence

Verifications

Payouts

Batches

Balances

Accounts

Webhooks

Pricing

FX

Corridors

Rotate the Signing Secret

Authorizations

Headers

Path Parameters

Query Parameters

Response