List Webhook Delivery

curl --request GET \
  --url https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries \
  --header 'X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>'

import requests

url = "https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries"

headers = {"X-SFPY-AGGREGATOR-SECRET-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-SFPY-AGGREGATOR-SECRET-KEY': '<api-key>'}};

fetch('https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-SFPY-AGGREGATOR-SECRET-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries")
  .header("X-SFPY-AGGREGATOR-SECRET-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-SFPY-AGGREGATOR-SECRET-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "api_version": "v1",
  "data": {
    "deliveries": [
      {
        "token": "whd_f35737a8-60d0-4d62-8259-9cade007570a",
        "endpoint_token": "wh_6b849c6f-c091-4ad3-b7a9-de06415c6db3",
        "aggregator_id": "agg_7f500b19-a5e4-4410-b334-5653367ebdf6",
        "event_id": "txnlog_5246fdcc-6c86-49bb-9da2-aa38262e0291",
        "type": "payment.rejected",
        "status": "WD_DEAD",
        "attempts": 0,
        "last_error": "status 422",
        "next_attempt_at": "2025-12-17T14:30:03Z",
        "created_at": "2025-12-17T14:30:02Z",
        "delivered_at": null
      },
      {
        "token": "whd_3c67553a-54ff-4bf7-a2a4-a3db233fd4d8",
        "endpoint_token": "wh_6b849c6f-c091-4ad3-b7a9-de06415c6db3",
        "aggregator_id": "agg_7f500b19-a5e4-4410-b334-5653367ebdf6",
        "event_id": "txnlog_1a574d66-9bdf-48ae-a858-802951c46705",
        "type": "payment.completed",
        "status": "WD_DEAD",
        "attempts": 0,
        "last_error": "status 422",
        "next_attempt_at": "2025-12-17T12:00:48Z",
        "created_at": "2025-12-17T12:00:47Z",
        "delivered_at": null
      },
      {
        "token": "whd_5521cdb9-fe09-4fa4-a63b-0c3637af7810",
        "endpoint_token": "wh_6b849c6f-c091-4ad3-b7a9-de06415c6db3",
        "aggregator_id": "agg_7f500b19-a5e4-4410-b334-5653367ebdf6",
        "event_id": "txnlog_9b62b0e1-4493-45cd-a55d-11c37d60e6d2",
        "type": "payment.created",
        "status": "WD_DEAD",
        "attempts": 0,
        "last_error": "status 422",
        "next_attempt_at": "2025-12-17T12:00:48Z",
        "created_at": "2025-12-17T12:00:46Z",
        "delivered_at": null
      }
    ],
    "count": "10"
  }
}

{
  "code": "error.bad_request",
  "message": "Invalid request parameters"
}

GET

aggregators

{raast-aggregator-id}

webhooks

{endpoint}

deliveries

List Webhook Delivery

curl --request GET \
  --url https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries \
  --header 'X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>'

import requests

url = "https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries"

headers = {"X-SFPY-AGGREGATOR-SECRET-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-SFPY-AGGREGATOR-SECRET-KEY': '<api-key>'}};

fetch('https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-SFPY-AGGREGATOR-SECRET-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-SFPY-AGGREGATOR-SECRET-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries")
  .header("X-SFPY-AGGREGATOR-SECRET-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-SFPY-AGGREGATOR-SECRET-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "api_version": "v1",
  "data": {
    "deliveries": [
      {
        "token": "whd_f35737a8-60d0-4d62-8259-9cade007570a",
        "endpoint_token": "wh_6b849c6f-c091-4ad3-b7a9-de06415c6db3",
        "aggregator_id": "agg_7f500b19-a5e4-4410-b334-5653367ebdf6",
        "event_id": "txnlog_5246fdcc-6c86-49bb-9da2-aa38262e0291",
        "type": "payment.rejected",
        "status": "WD_DEAD",
        "attempts": 0,
        "last_error": "status 422",
        "next_attempt_at": "2025-12-17T14:30:03Z",
        "created_at": "2025-12-17T14:30:02Z",
        "delivered_at": null
      },
      {
        "token": "whd_3c67553a-54ff-4bf7-a2a4-a3db233fd4d8",
        "endpoint_token": "wh_6b849c6f-c091-4ad3-b7a9-de06415c6db3",
        "aggregator_id": "agg_7f500b19-a5e4-4410-b334-5653367ebdf6",
        "event_id": "txnlog_1a574d66-9bdf-48ae-a858-802951c46705",
        "type": "payment.completed",
        "status": "WD_DEAD",
        "attempts": 0,
        "last_error": "status 422",
        "next_attempt_at": "2025-12-17T12:00:48Z",
        "created_at": "2025-12-17T12:00:47Z",
        "delivered_at": null
      },
      {
        "token": "whd_5521cdb9-fe09-4fa4-a63b-0c3637af7810",
        "endpoint_token": "wh_6b849c6f-c091-4ad3-b7a9-de06415c6db3",
        "aggregator_id": "agg_7f500b19-a5e4-4410-b334-5653367ebdf6",
        "event_id": "txnlog_9b62b0e1-4493-45cd-a55d-11c37d60e6d2",
        "type": "payment.created",
        "status": "WD_DEAD",
        "attempts": 0,
        "last_error": "status 422",
        "next_attempt_at": "2025-12-17T12:00:48Z",
        "created_at": "2025-12-17T12:00:46Z",
        "delivered_at": null
      }
    ],
    "count": "10"
  }
}

{
  "code": "error.bad_request",
  "message": "Invalid request parameters"
}

Authorizations

X-SFPY-AGGREGATOR-SECRET-KEY

string

header

required

Path Parameters

raast-aggregator-id

string

required

The unique identifier for the aggregator

Example:

"agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e"

endpoint

string

required

The unique identifier for the webhook endpoint

Example:

"wh_6b849c6f-c091-4ad3-b7a9-de06415c6db3"

Query Parameters

type

enum<string>

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

Available options:

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"

event_id

string[]

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

Example:

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

delivery_id

string[]

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

Pattern: ^whd_

Example:

["whd_f35737a8-60d0-4d62-8259-9cade007570a"]

status

enum<string>

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.

Available options:

WD_PENDING,

WD_DELIVERED,

WD_FAILED,

WD_DEAD

Example:

"WD_DELIVERED"

limit

string

Maximum number of Webhook deliveries to include in the response

Example:

"10"

offset

string

Number of Webhook deliveries to skip before starting the result set

Example:

"0"

Response

This response contains a paginated list of webhook deliveries.

Standard response structure for successful operations

api_version

string

The current version of the API spec

Example:

"v1"

data

object

Paginated collection of webhook deliveries

Show child attributes