Fincore · API reference · Webhooks
Delete a client webhook
Base URL https://apicore.stg.finch.lat · operationId deleteClientWebhook
Deletes (or soft-deletes) a webhook owned by the client.
Authorization
JWT bearer token created from client credentials. Use the Authentication guide to generate a token before calling protected endpoints.
Path parameters
clientId string (uuid) requiredClient UUID that owns the webhook.
id string (uuid) requiredWebhook UUID.
Responses
200 Webhook successfully deleted application/json
id string (uuid) requiredWebhook configuration UUID.
clientId string (uuid) requiredClient UUID that owns the webhook.
url string (uri) requiredDestination URL where Monato sends webhook events.
token string Secret configured for webhook delivery.
webhookType string requiredType of events delivered to this webhook.
MONEY_IN STATUS_UPDATE CEP REPORT REFUND webhookStatus string requiredCurrent webhook lifecycle status.
ACTIVE INACTIVE createdAt string (date-time) Timestamp when the webhook configuration was created.
updatedAt string (date-time) Timestamp when the webhook configuration was last updated.
deletedAt string | null Timestamp when the webhook configuration was deleted, or null.
blockedAt string | null Timestamp when the webhook configuration was blocked, or null.
deletedBy string | null Identifier of the actor that deleted the webhook, or null.
blockedBy string | null Identifier of the actor that blocked the webhook, or null.
401 Missing, expired, invalid, or environment-mismatched API key or bearer token. See Authentication. application/json
code integer requiredgRPC status code mapped to HTTP.
message string requiredGeneral error message.
details array of ErrorDetail requiredDetailed error causes returned by the service.
reason details[].reason string requiredMachine-readable error category.
DATA_ERROR FAILED_PRECONDITION MISSING_REQUIRED_FIELDS RESOURCE_NOT_FOUND UNAUTHORIZED PERMISSION_DENIED UNIQUE_VIOLATION INTERNAL domain details[].domain string requiredService domain that produced the error.
metadata details[].metadata object requiredAdditional error metadata, including the detailed message and HTTP code.
error_detail details[].metadata.error_detail string Human-readable detail returned by the service.
http_code details[].metadata.http_code string HTTP status code associated with this error.
error_code details[].metadata.error_code string Optional internal error catalog code when available.
404 Webhook was not found for the supplied client. application/json
code integer requiredgRPC status code mapped to HTTP.
message string requiredGeneral error message.
details array of ErrorDetail requiredDetailed error causes returned by the service.
reason details[].reason string requiredMachine-readable error category.
DATA_ERROR FAILED_PRECONDITION MISSING_REQUIRED_FIELDS RESOURCE_NOT_FOUND UNAUTHORIZED PERMISSION_DENIED UNIQUE_VIOLATION INTERNAL domain details[].domain string requiredService domain that produced the error.
metadata details[].metadata object requiredAdditional error metadata, including the detailed message and HTTP code.
error_detail details[].metadata.error_detail string Human-readable detail returned by the service.
http_code details[].metadata.http_code string HTTP status code associated with this error.
error_code details[].metadata.error_code string Optional internal error catalog code when available.
Request
curl -X DELETE "https://apicore.stg.finch.lat/v1/clients/{clientId}/webhooks/{id}" \
-H "Authorization: Bearer $TOKEN"const res = await fetch("https://apicore.stg.finch.lat/v1/clients/{clientId}/webhooks/{id}", {
method: "DELETE",
headers: {
"Authorization": `Bearer ${TOKEN}`,
},
});
const data = await res.json();import requests
res = requests.delete(
"https://apicore.stg.finch.lat/v1/clients/{clientId}/webhooks/{id}",
headers={
"Authorization": f"Bearer {TOKEN}",
},
)
data = res.json()Response
{
"id": "29806117-2b15-4682-87f0-350e6695fe91",
"clientId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
"url": "https://example.com/webhook",
"token": "secretToken0123",
"webhookType": "MONEY_IN",
"webhookStatus": "ACTIVE",
"createdAt": "2025-04-03 13:40:54.056794-06:00",
"updatedAt": "2025-04-03 13:40:54.056794-06:00",
"deletedAt": null,
"blockedAt": null,
"deletedBy": null,
"blockedBy": null
}{
"code": 16,
"message": "API Error",
"details": [
{
"reason": "UNAUTHORIZED",
"domain": "CORE",
"metadata": {
"error_detail": "Invalid Credentials",
"http_code": "401"
}
}
]
}{
"code": 9,
"message": "API Error",
"details": [
{
"reason": "FAILED_PRECONDITION",
"domain": "CORE",
"metadata": {
"error_detail": "The account does not have sufficient funds.",
"http_code": "400",
"error_code": "10-E4120"
}
}
]
}