Pay: webhooks

Get a webhook endpoint

GET/v1/webhook_endpoints/{id}

Authentication: API key (Authorization: Bearer)
Required scope: pay:read

Path parameters#

idstring · uuidrequired

Responses#

200Endpoint.

Object fields

idstring · uuid
objectstring
Values webhook_endpoint
environmentstring
Values test live
urlstring
event_typesarray of string
Values invoice.created invoice.confirming invoice.paid invoice.underpaid invoice.overpaid invoice.expired invoice.paid_late invoice.canceled invoice.reverted invoice.held sweep.succeeded sweep.failed refund.succeeded refund.pending merchant.payout_change_requested merchant.payout_changed merchant.frozen merchant.kyb_updated
statusstring
Values enabled disabled
created_atstring · date-time
disabled_atstring · date-timenullable

4xx · 5xxError.

Standard error format: see Errors.

Request

cURL

curl "https://aicscan.io/v1/webhook_endpoints/0193a1d2-3c4d-7e5f-8a6b-7c8d9e0f1a2b" \
  -H "Authorization: Bearer $AICSCAN_API_KEY"

JavaScript

const res = await fetch('https://aicscan.io/v1/webhook_endpoints/0193a1d2-3c4d-7e5f-8a6b-7c8d9e0f1a2b', {
  headers: {
    Authorization: `Bearer ${process.env.AICSCAN_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error.code);
console.log(data);

Python

import os
import requests

resp = requests.get(
    "https://aicscan.io/v1/webhook_endpoints/0193a1d2-3c4d-7e5f-8a6b-7c8d9e0f1a2b",
    headers={
        "Authorization": f"Bearer {os.environ['AICSCAN_API_KEY']}",
    },
    timeout=10,
)
resp.raise_for_status()
print(resp.json())

Response 200

JSON

{
  "id": "0193a1c9-41aa-7b2e-9c0d-1e2f3a4b5c6d",
  "object": "webhook_endpoint",
  "environment": "test",
  "url": "string",
  "event_types": [
    "invoice.created"
  ],
  "status": "enabled",
  "created_at": "2026-11-14T09:30:13Z",
  "disabled_at": "2026-11-14T09:30:13Z"
}