Sign in

v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB
Event

Events - Manual Retry

Manually retry the delivery of the specified Event.

post/events/{merchant_id}/{event_id}/retry

Path parameters

merchant_idstring required

The unique identifier for the Merchant Account.

event_idstring required

The unique identifier for the Event

Response

The delivery of the Event was attempted. Check the response field in the response payload to identify the status of the delivery attempt.

event_idstring required

The identifier for the Event.

merchant_idstring required

The identifier for the Merchant Account.

profile_idstring required

The identifier for the Business Profile.

object_idstring required

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

event_type'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' | 'surcharge_payment_succeeded' | 'surcharge_refund_succeeded' required
event_class'payments' | 'refunds' | 'disputes' | 'mandates' | 'payouts' | 'subscriptions' required
is_delivery_successfulboolean nullable

Indicates whether the webhook was ultimately delivered or not.

initial_attempt_idstring required

The identifier for the initial delivery attempt. This will be the same as event_id for the initial delivery attempt.

processor_merchant_idstring nullable

The identifier for the Processor Merchant Account.

createdstring date-time required

Time at which the event was created.

delivery_attempt'initial_attempt' | 'automatic_retry' | 'manual_retry'

Example response

{
  "event_id": "evt_018e31720d1b7a2b82677d3032cab959",
  "merchant_id": "y3oqhf46pyzuxjbcn2giaqnb44",
  "profile_id": "SqB0zwDGR5wHppWf0bx7GKr1f2",
  "object_id": "QHrfd5LUDdZaKtAjdJmMu0dMa1",
  "initial_attempt_id": "evt_018e31720d1b7a2b82677d3032cab959",
  "created": "2022-09-10T10:11:12Z",
  "request": {
    "headers": [
      [
        "content-type",
        "application/json"
      ],
      [
        "content-length",
        "1024"
      ]
    ]
  },
  "response": {
    "headers": [
      [
        "content-type",
        "application/json"
      ],
      [
        "content-length",
        "1024"
      ]
    ],
    "status_code": 200
  }
}