List subscribable events
curl -X GET "https://test-api.kashier.io/v2/webhooks/events"[ { "value": "pay", "label": "Payment", "resource": "transaction" }, { "value": "refund", "label": "Refund", "resource": "transaction" }, { "value": "TRANSFERRED", "label": "Transferred", "resource": "transfer" }]Returns the catalog of event types a webhook can subscribe to — the exact values that
are valid in the events array of Create a webhook and Update a webhook.
Read this catalog rather than hard-coding a copy of the list. It is the source Kashier validates against, so a list you maintain separately will drift the moment Kashier adds an event, and a subscription containing a value that is not in the catalog is rejected.
Each entry pairs the literal value you subscribe with a human label and the
resource it belongs to. There are two families: transaction events, whose value
is the operation that produced them (pay, authorize, capture, refund, void,
reversal), and transfer events, whose value is the transfer status reached
(INITIATED, IN_TRANSIT, TRANSFERRED, FAILED). Casing is significant and matched
literally.
Note what is not in the catalog: a card decline, a Meeza payment, an Apple Pay
payment and a Fawry payment are all pay events — payment method and outcome are
variations inside the payload, not separate event types. Always read data.status
rather than treating the arrival of a pay event as proof of payment.
Authorization
secretKey Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
Create a webhook POST
Creates a new webhook for your merchant. The webhook's url must be https. There is a cap on how many webhooks you can hold in each mode; once you reach it, creating another webhook in that mode is…
Delete a webhook DELETE
Removes a webhook. There's no undo — deliveries already recorded against it stay visible in delivery records.