beel_resolve_payment_event
Marks a payment event as resolved outside BeeL, clearing events that need action without generating an invoice. Applies to all eligible events sharing the payment identity or source object.
Instructions
Marks a payment event as resolved outside BeeL, for example when the invoice was issued through another tool or the situation was otherwise handled by hand. The event leaves the events that need action without generating any invoice.
The operation applies to the whole payment the event belongs to. Its scope is every active
event of the connection that shares the payment identity of the event named in the
request: when the event carries a payment identifier (external_payment_id), every event
with that same identifier, whatever its kind (the sale, its failed attempts, its refunds);
otherwise, when it carries a source object (source_object_id, such as a credit note or a
dispute), every event with that same source object; otherwise, the event alone. Within that
scope, the events that need action (the same criterion as the needs_action filter) and
are eligible are resolved together, in a single transaction; a failed event still pending
automatic retry is resolved as well, so that no retry is attempted for a payment the
caller has declared handled elsewhere. Events that do not need action — for instance an
event still in RECEIVED state that has not stalled — remain unchanged. The response
carries the event named in the request.
Eligible events: only events in
FAILED,SKIPPEDorRECEIVEDcan be resolved; if the event named in the request is not eligible, the request returns400.Terminal: a resolved event cannot be retried afterwards.
Endpoint: POST /v1/companies/{company_id}/payment-connections/{connection_id}/events/{event_id}/resolve
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| event_id | Yes | Identifier of the payment event, as returned by the list operation. | |
| company_id | Yes | Unique identifier (UUID) of the company the events belong to — its identifier, not its NIF. It is the only source of context: the account that owns it is derived from it, and the `BeeL-Active-Company` header plays no part. A company you do not reach answers `403`, and so does a company that does not exist, so the existence of a company in another account is never disclosed. | |
| connection_id | Yes | Unique identifier (UUID) of the payment connection the operation acts on, as returned by `GET /v1/companies/{company_id}/payment-connections`. A NIF can hold several connections of the same provider, so the provider slug alone does not name one. A connection of another NIF answers `404`, exactly like one that does not exist. | |
| idempotency_key | No | Optional idempotency key for this operation. Omit it and one is derived from the request itself, which makes a blind retry safe but also collapses a SECOND, deliberately identical operation into the first for 24 hours. Set it — to an order id, or anything unique per intended operation — whenever you mean to create something that may look identical to what you just created. |