POST
/
events
/
{merchant_id}
/
{event_id}
/
retry
curl --request POST \
  --url https://sandbox.hyperswitch.io/events/{merchant_id}/{event_id}/retry \
  --header 'api-key: <api-key>'
{
  "event_id": "evt_018e31720d1b7a2b82677d3032cab959",
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "profile_id": "SqB0zwDGR5wHppWf0bx7GKr1f2",
  "object_id": "QHrfd5LUDdZaKtAjdJmMu0dMa1",
  "event_type": "payment_succeeded",
  "event_class": "payments",
  "is_delivery_successful": true,
  "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
  },
  "delivery_attempt": "initial_attempt"
}

Authorizations

​
api-key
string
header
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
The delivery of the Event was attempted. Check the `response` field in the response payload to identify the status of the delivery attempt.

The response body for retrieving an event.

​
event_id
string
required

The identifier for the Event.

Maximum length: 64
Example:

"evt_018e31720d1b7a2b82677d3032cab959"

​
merchant_id
string
required

The identifier for the Merchant Account.

Maximum length: 64
Example:

"y3oqhf46pyzuxjbcn2giaqnb44"

​
profile_id
string
required

The identifier for the Business Profile.

Maximum length: 64
Example:

"SqB0zwDGR5wHppWf0bx7GKr1f2"

​
object_id
string
required

The identifier for the object (Payment Intent ID, Refund ID, etc.)

Maximum length: 64
Example:

"QHrfd5LUDdZaKtAjdJmMu0dMa1"

​
event_type
enum<string>
required
Available options:
payment_succeeded,
payment_failed,
payment_processing,
payment_cancelled,
payment_authorized,
payment_captured,
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
​
event_class
enum<string>
required
Available options:
payments,
refunds,
disputes,
mandates,
payouts
​
is_delivery_successful
boolean
required

Indicates whether the webhook delivery attempt was successful.

​
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 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.

​
delivery_attempt
enum<string>
Available options:
initial_attempt,
automatic_retry,
manual_retry
Events - Delivery Attempt ListPoll - Retrieve Poll Status