API reference
Retrieve event
One event as delivered.
GET
/events/:idOne event, exactly as delivered to webhooks.
- Permission
- read:events
- Auth
- api-key
- Idempotent
- No
- Language
- Node.js
| Field | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | Yes | Event ID (evt_…). |
const response = await fetch(`${process.env.BOSPAY_API_BASE}/events/evt_example`, {
method: "GET",
headers: {
"Content-Type": "application/json",
"BOSPay-Version": "2026-09-23",
"X-API-Key": process.env.BOSPAY_API_KEY,
}
});
if (!response.ok) {
throw new Error(`BOSPay request failed: ${response.status}`);
}
const data = await response.json();Success
200
{
"id": "evt_7Qx2mK9pL4sT8vW1yZ3aB6cD",
"object": "event",
"type": "invoice.paid",
"created": "2026-09-23T10:42:00.000Z",
"apiVersion": "2026-09-23",
"livemode": false,
"environment": "sandbox",
"data": {
"id": "inv_1048",
"object": "invoice",
"invoiceId": "inv_1048",
"status": "paid",
"environment": "sandbox",
"chain": "sepolia",
"tokenSymbol": "USDC",
"cryptoAmount": "8.42",
"amountPaid": "8.42",
"protocolFee": "0.083358",
"merchantShare": "8.336642",
"metadata": {
"orderId": "1048"
}
}
}Validation error
400
{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "A valid fiatAmount is required.",
"field": "fiatAmount",
"requestId": "req_3f0c9a1b2c4d5e6f7a8b9c0d"
}
}