De-register webhook
Once deregistered, the previously registered webhook will no longer be triggered by the GrailPay, and notifications will no longer be delivered to the configured endpoint.
Authentication Route
This route is secured with processor token authentication.
Endpoint
/processor/api/v1/webhook
Request Payload
{
"webhook_url": [
"https://example.com/webhook/transaction"
],
"event_names": [
"TransactionCompleted",
"TransactionFailed"
]
}
| Fields | Type | Is Required | Description |
|---|---|---|---|
| event_names | string array | Yes | Possible Values: BatchPayout TransactionStarted TransactionCaptureStarted TransactionCompleted TransactionFailed TransactionCanceled PayoutOnHold PayoutCompleted ClawbackStarted ClawbackFailed ClawbackCompleted BankLinkedSuccessfully BankLinkFailed BusinessCreated BusinessUpdated BatchPayout RefundPending RefundCaptureStarted RefundCaptureCompleted RefundCaptureFailed RefundPayoutPending RefundPayoutCompleted RefundPayoutFailed BatchRefund (coming soon...) |
| webhook_url | string array | No |
Response Object
{
"status": true,
"message": "Webhook de-registered!",
"data": null,
"errors": []
}
Errors & Warnings
| Code | Message |
|---|---|
| 401 | |
| 422 |
Updated 3 months ago