Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

Retry a processor event

Schedules a held event through the existing idempotent application path.

Schedules a held event through the existing idempotent application path. The decision is audited; an etag is required.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/processor_events/processor-event:retry
  • Scope billing:processor_events:write
  • Effect write — a successful call changes state.
  • Collection processor_events

#Request

FieldTypeWhat it is
namestringEvent resource name. Required.
etagstringThe event's current meta.etag, required to avoid racing another decision. Required.
reasonstringoperator_retry or permissions_restored. Required.

#Response

FieldTypeWhat it is
namestringName; the final segment is Stripe's event id.
uidstringStable, server-derived id. Output only.
metaResourceMetaMetadata; meta.etag is required on recovery calls. Output only.
account_idstringStripe account id, never the customer's identity. Output only.
event_typestringStripe event type. Output only.
object_idstringStripe object id (not a payload). Output only.
statestringpending, held, applied or dismissed. Output only.
hold_reasonstringprocessor_permission_denied, attempts_exhausted, or empty. Output only.
attemptsint32Number of failed application attempts. Output only.
livemodeboolWhether the owning merchant is live. Read only when mode_known is true. Output only.
mode_knownboolFalse when the owning merchant cannot be resolved; never assumes test. Output only.
last_recoveryProcessorEventRecoveryLast audited recovery decision, if any. Full history is retained. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#ProcessorEventRecovery

FieldTypeWhat it is
receipt_idstringStable receipt identity, scoped to this event and revision. Output only.
actionstringretry or dismiss. Output only.
reasonstringoperator_retry, permissions_restored, or test_processor_observation. Output only.
principalstringThe verified caller's principal, never supplied by the caller. Output only.
create_timetimestampCommit's decision time. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/processor_events/processor-event:retry" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"etag":"…","reason":"…"}'