Register Webhook

Create or update webhook callback endpoints for merchant event notifications.

Error Codes

CodeStatusReasonWhat to do
VALIDATION_ERROR422Webhook payload is invalidEnsure all webhook URLs and auth key values are valid.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request payload to create or update merchant webhook endpoints.

string
required
length between 8 and 200

Shared secret value sent with webhook requests for receiver-side verification.

uri
required

HTTPS endpoint that receives payment agreement status callbacks.

uri
required

HTTPS endpoint that receives payment initiation callbacks.

uri
required

HTTPS endpoint invoked when direct debit is accepted.

uri
required

HTTPS endpoint invoked when direct debit is rejected/dishonoured.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json