Sign in
Webhooks

List Webhook Delivery

Retrieve a newest-first paginated list of webhook-delivery summaries. It supports filtering by status, type, event_id, and delivery_id.

get/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries

Request

  • Base URL: https://api.getsafepay.com/raastwire
  • URL: https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries
  • Auth: API key in header X-SFPY-AGGREGATOR-SECRET-KEY

Query parameters

type'payment.created' | 'payment.pending_authorization' | 'payment.authorized' | 'payment.completed' | 'payment.settled' | 'payment.refunded' | 'payment.refund_partial' | 'payment.rejected' | 'payment.failed' | 'payment.reversed' | 'payment.voided' | 'settlement.created' | 'settlement.processing' | 'settlement.completed' | 'settlement.failed' | 'settlement.on_hold' | 'settlement.reversed' | 'refund.created' | 'refund.completed' | 'refund.failed' | 'refund.canceled'
Example:refund.created

Limit results to webhook deliveries of the given public event type.

event_idstring[]

Filter by one or more originating event IDs. Repeat the query parameter to supply multiple values.

[
  "txnlog_5246fdcc-6c86-49bb-9da2-aa38262e0291"
]
delivery_idstring[]

Filter by one or more webhook delivery tokens. Repeat the query parameter to supply multiple values.

[
  "whd_f35737a8-60d0-4d62-8259-9cade007570a"
]
status'WD_PENDING' | 'WD_DELIVERED' | 'WD_FAILED' | 'WD_DEAD'
Example:WD_DELIVERED

Filter webhook deliveries by status. WD_PENDING is waiting for an initial attempt or retry (retryable failures stay WD_PENDING with an advanced next_attempt_at), WD_DELIVERED received a 2xx response, WD_FAILED is reserved by the API contract but not currently assigned, and WD_DEAD will receive no more automatic attempts.

limitstring
Example:10

Maximum number of Webhook deliveries to include in the response

offsetstring
Example:0

Number of Webhook deliveries to skip before starting the result set

Response

This response contains a paginated list of webhook deliveries.

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "deliveries": [
      {
        "type": "payment.completed",
        "payload_json": "{\"source\":\"SAFEPAY_RAAST\",\"kind\":\"PAYMENT_EVENT\",\"code\":\"PAYMENT_CAPTURED\",\"version\":\"V1_0_0\",\"timestamp\":\"2026-09-14T10:15:30.123456Z\",\"identifier\":\"txnlog_5246fdcc-6c86-49bb-9da2-aa38262e0291\",\"partner_id\":\"partner_12345678-1234-1234-1234-123456789012\",\"aggregator_id\":\"agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e\",\"subject\":{\"payment\":{\"token\":\"pm_12345678-1234-1234-1234-123456789012\",\"aggregator_id\":\"agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e\",\"order_id\":\"order-1042\",\"type\":\"RTP_NOW\",\"amount\":\"250000\",\"status\":\"P_CAPTURED\"}},\"destinations\":[],\"raast_channel\":\"\",\"webhook_event_type\":\"payment.completed\"}",
        "next_attempt_at": "2025-03-13T09:12:34Z",
        "created_at": "2025-03-13T09:12:34Z",
        "delivered_at": "2025-03-13T09:12:34Z"
      }
    ],
    "count": "1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.