Events - Delivery Attempt List

Retrieve the delivery attempts for a specific event.

Example: cURL

curl

curl --request GET \
  --url https://sandbox.hyperswitch.io/events/{merchant_id}/{event_id}/attempts \
  --header 'api-key: <api-key>'

Example response (200)

application/json

[
  {
    "event_id": "evt_018e31720d1b7a2b82677d3032cab959",
    "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
    "profile_id": "SqB0zwDGR5wHppWf0bx7GKr1f2",
    "object_id": "QHrfd5LUDdZaKtAjdJmMu0dMa1",
    "event_type": "payment_succeeded",
    "event_class": "payments",
    "initial_attempt_id": "evt_018e31720d1b7a2b82677d3032cab959",
    "created": "2022-09-10T10:11:12Z",
    "request": {
      "body": "<string>",
      "headers": [
        [
          "content-type",
          "application/json"
        ],
        [
          "content-length",
          "1024"
        ]
      ]
    },
    "response": {
      "body": "<string>",
      "headers": [
        [
          "content-type",
          "application/json"
        ],
        [
          "content-length",
          "1024"
        ]
      ],
      "status_code": 200,
      "error_message": 200
    },
    "is_delivery_successful": true,
    "delivery_attempt": "initial_attempt"
  }
]

---

HTTP Request

GET /events/{merchant_id}/{event_id}/attempts

---

Authorization

Header: api-key (string) — required

Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account.

---

Path parameters

• merchant_id (string, required) The unique identifier for the Merchant Account.

• event_id (string, required) The unique identifier for the Event

---

Response

200 — application/json List of delivery attempts retrieved successfully

Response item fields:

• event_id (string, required) The identifier for the Event. Maximum string length: 64 Example: "evt_018e31720d1b7a2b82677d3032cab959"

• merchant_id (string, required) The identifier for the Merchant Account. Maximum string length: 64 Example: "y3oqhf46pyzuxjbcn2giaqnb44"

• profile_id (string, required) The identifier for the Business Profile. Maximum string length: 64 Example: "SqB0zwDGR5wHppWf0bx7GKr1f2"

• object_id (string, required) The identifier for the object (Payment Intent ID, Refund ID, etc.) Maximum string length: 64 Example: "QHrfd5LUDdZaKtAjdJmMu0dMa1"

• event_type (enum, required) Available options include: payment_succeeded, payment_failed, payment_processing, payment_cancelled, payment_cancelled_post_capture, payment_authorized, payment_partially_authorized, payment_captured, payment_expired, action_required, refund_succeeded, refund_failed, dispute_opened, dispute_expired, dispute_accepted, dispute_cancelled, dispute_challenged, dispute_won, dispute_lost, mandate_active, mandate_revoked, payout_success, payout_failed, payout_initiated, payout_processing, payout_cancelled, payout_expired, payout_reversed, invoice_paid

• event_class (enum, required) Available options: payments, refunds, disputes, mandates, payouts, subscriptions

• initial_attempt_id (string, required) The identifier for the initial delivery attempt. This will be the same as event_id for the initial delivery attempt. Maximum string length: 64 Example: "evt_018e31720d1b7a2b82677d3032cab959"

• created (string, required) Time at which the event was created. Example: "2022-09-10T10:11:12Z"

• request (object, required) The request information (headers and body) sent in the webhook.

• response (object, required) The response information (headers, body and status code) received for the webhook sent.

• is_delivery_successful (boolean | null) Indicates whether the webhook was ultimately delivered or not.

• delivery_attempt (enum) Available options: initial_attempt, automatic_retry, manual_retry

---

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/event/events--delivery-attempt-list.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/event/events--delivery-attempt-list

Related:

• Events - List: https://api-reference.hyperswitch.io/v1/event/events--list

• Events - Manual Retry: https://api-reference.hyperswitch.io/v1/event/events--manual-retry