Skip to main content
POST
cURL
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.
webhook_secret is the HMAC-SHA256 key for the X-Webhook-Signature header and is only returned by this call. Store it securely.
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.
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.

Authorizations

Authorization
string
header
required

Basic Authorization header using the Bearer scheme.

Body

merchant_guid
string<uuid>
webhook_url
string | null

Response

200

OK