API referenceStripe candidatesIngest Stripe Event
104 operations ↓ OpenAPI JSON Get API key
POST /v1/stripe/events

Ingest Stripe Event

Ingest a Stripe event as raw evidence and review-required settlement candidates. No posting or allocation is performed.

Requires API key Idempotent OpenAPI v1

Authentication

Use a HelvCore API key in the Authorization header. Keys are server-side secrets and must not be exposed to browser JavaScript.

GETHeader
Authorization: Bearer hc_...

Parameters

Idempotency-Keystringrequiredheader

Documented field.

Request body

Send JSON using the documented schema. Unknown or unsafe fields fail with structured validation errors where the endpoint owns validation.

end_customer_idstringoptionalbody

Documented field.

stripe_event_idstringrequiredbody

Documented field.

event_typestringrequiredbody

Documented field.

livemodebooleanoptionalbody

Documented field.

stripe_account_idstringoptionalbody

Documented field.

api_versionstringoptionalbody

Documented field.

payloadobjectrequiredbody

Documented field.

Returns

Returns a documented JSON response on success and the standard HelvCore error envelope on failure.

202Successful response.
defaultStructured error response.
401invalid_auth - missing, expired, or invalid Bearer key

Stable error codes

api_key_disabledDocumented HelvCore error code for this operation.
api_key_expiredDocumented HelvCore error code for this operation.
idempotency_key_conflictDocumented HelvCore error code for this operation.
invalid_authDocumented HelvCore error code for this operation.
invalid_requestDocumented HelvCore error code for this operation.
missing_idempotency_keyDocumented HelvCore error code for this operation.
validation_failedDocumented HelvCore error code for this operation.