Update a webhook

cURL

curl --request PATCH \
  --url https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks/{webhookId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook_url": "<string>",
  "active": true
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({webhook_url: '<string>', active: true})
};

fetch('https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks/{webhookId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks/{webhookId}"

payload = {
    "webhook_url": "<string>",
    "active": True
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks/{webhookId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n  \"webhook_url\": \"<string>\",\n  \"active\": true\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks/{webhookId}",
  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([
    'webhook_url' => '<string>',
    'active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

{
  "id": "0f6a1c2d-8e4b-4a7c-9d3e-5b2f1a6c8d90",
  "merchant_guid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
  "webhook_url": "https://your-app.example.com/paychoice/webhook-v2",
  "created_date": "2026-11-04T02:30:00.000Z",
  "created_by": null,
  "updated_date": "2026-11-04T03:45:12.000Z",
  "updated_by": "merchant-user",
  "active": true
}

PATCH

api

merchantwebhooks

{webhookId}

cURL

curl --request PATCH \
  --url https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks/{webhookId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook_url": "<string>",
  "active": true
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({webhook_url: '<string>', active: true})
};

fetch('https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks/{webhookId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks/{webhookId}"

payload = {
    "webhook_url": "<string>",
    "active": True
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks/{webhookId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n  \"webhook_url\": \"<string>\",\n  \"active\": true\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks/{webhookId}",
  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([
    'webhook_url' => '<string>',
    'active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

{
  "id": "0f6a1c2d-8e4b-4a7c-9d3e-5b2f1a6c8d90",
  "merchant_guid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
  "webhook_url": "https://your-app.example.com/paychoice/webhook-v2",
  "created_date": "2026-11-04T02:30:00.000Z",
  "created_by": null,
  "updated_date": "2026-11-04T03:45:12.000Z",
  "updated_by": "merchant-user",
  "active": true
}

Updates an existing registration, for example to change the URL. webhookId is the id from Register a webhook. Your webhook_secret is unchanged and is not returned.

{
  "id": "0f6a1c2d-8e4b-4a7c-9d3e-5b2f1a6c8d90",
  "merchant_guid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
  "webhook_url": "https://your-app.example.com/paychoice/webhook-v2",
  "created_date": "2026-11-04T02:30:00.000Z",
  "created_by": null,
  "updated_date": "2026-11-04T03:45:12.000Z",
  "updated_by": "merchant-user",
  "active": true
}

Returns 404 if the registration doesn’t exist.

Authorizations

Authorization

string

header

required

Basic Authorization header using the Bearer scheme.

Path Parameters

webhookId

string<uuid>

required

Body

webhook_url

string | null

active

boolean | null

Response

200

Charges

Webhooks

Tokens

Refunds and pre-authorisations

Authorizations

Path Parameters

Body

Response