Skip to main content
PUT
cURL
Updates the webhook URL where your partner account receives event notifications. To disable webhook delivery, send null as the url value.
For details on webhook payloads and HMAC validation, see the Webhooks Guide.

Use Cases

  • Set a webhook URL: Start receiving notifications for transaction status changes and KYC events.
  • Update the URL: Point notifications to a new server after a migration.
  • Disable webhooks: Send url: null to stop receiving notifications.

Error Codes

Common Errors

Endpoint-Specific Errors

Authorizations

partner-api-key
string
header
required

API key for the affiliated partner performing the request.

Body

application/json
url
string | null
required

the url where the webhook notifications will be sent to. To reset the value null can be sent in the body.

Example:

"https://some-webhook-endpoint.url"

Response

Allows an affiliated partner to update the settings for receiving webhook notifications.

success
boolean
Example:

true

data
object