cURL
curl --request POST \
--url https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"merchant_guid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"webhook_url": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({merchant_guid: '3c90c3cc-0d44-4b50-8888-8dd25736052a', webhook_url: '<string>'})
};
fetch('https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks', 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"
payload = {
"merchant_guid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"webhook_url": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n \"merchant_guid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"webhook_url\": \"<string>\"\n}", false);
var response = await client.PostAsync(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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'merchant_guid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'webhook_url' => '<string>'
]),
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",
"webhook_secret": "c2VjcmV0LXNlY3JldC1zZWNyZXQtc2VjcmV0LXNlY3JldA==",
"created_date": "2026-11-04T02:30:00.000Z",
"updated_date": null,
"updated_by": null,
"active": true
}
Webhooks
Register a webhook
POST
/
api
/
v5
/
merchantwebhooks
cURL
curl --request POST \
--url https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"merchant_guid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"webhook_url": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({merchant_guid: '3c90c3cc-0d44-4b50-8888-8dd25736052a', webhook_url: '<string>'})
};
fetch('https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks', 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"
payload = {
"merchant_guid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"webhook_url": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api-sandbox.paychoice.com.au/api/v5/merchantwebhooks");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
request.AddJsonBody("{\n \"merchant_guid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"webhook_url\": \"<string>\"\n}", false);
var response = await client.PostAsync(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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'merchant_guid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'webhook_url' => '<string>'
]),
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",
"webhook_secret": "c2VjcmV0LXNlY3JldC1zZWNyZXQtc2VjcmV0LXNlY3JldA==",
"created_date": "2026-11-04T02:30:00.000Z",
"updated_date": null,
"updated_by": null,
"active": true
}
Registers a webhook URL for the merchant. PayChoice then POSTs a notification to it when a charge is created and whenever its status changes — card or bank, API or Widget.
A merchant-level credential can only register for its own merchant GUID. See the Webhooks guide for payload format and signature verification.
The registration object is returned directly, with no envelope.
webhook_secret is the HMAC-SHA256 key for the X-Webhook-Signature header and is only returned by this call. Store it securely.{
"id": "0f6a1c2d-8e4b-4a7c-9d3e-5b2f1a6c8d90",
"merchant_guid": "315564b9-b863-4016-8c53-02c9d8cc80b7",
"webhook_url": "https://your-app.example.com/paychoice/webhook",
"webhook_secret": "c2VjcmV0LXNlY3JldC1zZWNyZXQtc2VjcmV0LXNlY3JldA==",
"created_date": "2026-11-04T02:30:00.000Z",
"updated_date": null,
"updated_by": null,
"active": true
}
uuid
The registration ID. Needed for Update.
string
44-character Base64 string. Use it as-is as the HMAC key; do not decode it.
boolean
Whether notifications are being sent.