beel-es · Schema

ListManagedPaymentEventsResponse

InvoicingSpainFintechSoftware-as-a-Service

Properties

Name Type Description
success boolean
data object
meta object
View JSON Schema on GitHub

JSON Schema

beel-es-list-managed-payment-events-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/beel-es/json-schema/beel-es-list-managed-payment-events-response-schema.json",
  "title": "ListManagedPaymentEventsResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/beel-es-companypaymentevents-api-openapi.yml#/components/schemas/ListManagedPaymentEventsResponse",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "required": [
        "events"
      ],
      "properties": {
        "events": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ManagedPaymentEvent"
          }
        },
        "pagination": {
          "$ref": "#/$defs/Pagination"
        },
        "counts": {
          "$ref": "#/$defs/PaymentEventCounts"
        }
      }
    },
    "meta": {
      "$ref": "#/$defs/ResponseMeta"
    }
  },
  "$defs": {
    "ManagedPaymentEvent": {
      "type": "object",
      "description": "A payment event of a managed NIF's connection (curated subset).",
      "required": [
        "id",
        "provider",
        "event_type",
        "event_kind",
        "external_event_id",
        "status",
        "needs_action",
        "outcome",
        "draft_available",
        "retry_available",
        "discard_available",
        "retry_count",
        "received_at",
        "discarded"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Identifier of the payment event."
        },
        "provider": {
          "type": "string",
          "description": "Payment provider slug (lowercase)."
        },
        "event_type": {
          "type": "string",
          "description": "Raw event name as the provider emitted it. Preserved verbatim so you can trace the\nevent back on the provider's side. Not filterable — filter by `event_kind`.\n"
        },
        "event_kind": {
          "allOf": [
            {
              "$ref": "#/$defs/PaymentEventType"
            }
          ],
          "description": "What the event is about, once `event_type` has been classified. This is the value the\n`event_kind` filter takes, so what you read here you can ask for again.\n"
        },
        "external_event_id": {
          "type": "string",
          "description": "Provider-side event identifier."
        },
        "external_payment_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Canonical identity of the payment at the provider. On Stripe this is the\nPaymentIntent id (`pi_…`); for a charge without a PaymentIntent, the Charge id\n(`ch_…`); for a Stripe invoice paid outside Stripe, the payment record id (`pr_…`).\nEvery event of the same payment carries the same value and can be grouped by it.\nNull while the identity is not yet resolved.\nTo trace the event back to the object that delivered it, use `source_object_id`.\n"
        },
        "source_object_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Provider object that delivered this event (`in_…`, `cs_…`, `ch_…`, `pi_…`). Use it to\nopen the originating invoice, checkout session or charge at the provider. It is an\naudit trail only: it never identifies the payment — `external_payment_id` does.\n"
        },
        "currency": {
          "type": [
            "string",
            "null"
          ],
          "description": "ISO 4217 currency of the event. Absent on an event that moves no money — a failed\nintent, or a provider notice we do not classify — and then `amount` is absent too.\n"
        },
        "amount": {
          "type": [
            "number",
            "null"
          ],
          "description": "Amount the event carries. Absent whenever `currency` is: the two travel together, so\nan amount never arrives without the currency that gives it meaning.\n"
        },
        "fee_amount": {
          "type": [
            "number",
            "null"
          ],
          "description": "Provider fee, when reported."
        },
        "net_amount": {
          "type": [
            "number",
            "null"
          ],
          "description": "Amount net of the provider fee, when reported."
        },
        "category": {
          "allOf": [
            {
              "$ref": "#/$defs/PaymentEventCategory"
            }
          ],
          "description": "Which product line the money came from, resolved when the event was processed. Not the\nsame as `event_kind`: that one says what happened, this one says where it came from.\n`null` when the event does not fall in any category, or when it predates the field.\n"
        },
        "money_returned": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Whether money actually went back to the payer through the provider. Always `true` for\na refund. For a credit note it is `true` only when the note settles provider refunds:\na note credited against an unpaid invoice, or settled outside the provider, corrects\nthe same amount without moving any money. `null` when the concept does not apply, as\non a charge.\n"
        },
        "customer_email": {
          "type": [
            "string",
            "null"
          ],
          "description": "Payer email reported by the provider."
        },
        "customer_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Payer name reported by the provider."
        },
        "status": {
          "$ref": "#/$defs/PaymentEventStatus"
        },
        "invoice_id": {
          "type": [
            "string",
            "null"
          ],
          "format": "uuid",
          "description": "Invoice generated from the event, when there is one."
        },
        "invoice_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "Number of the invoice generated from the event. `null` while that invoice is still a\ndraft — a draft has no number yet — and `null` when the event produced no invoice.\n"
        },
        "failure_category": {
          "allOf": [
            {
              "$ref": "#/$defs/PaymentEventFailureCategory"
            }
          ],
          "description": "High-level cause of the failure, when the event did not complete. Same vocabulary the\n`failure_category` filter takes.\n"
        },
        "failure_reason": {
          "type": [
            "string",
            "null"
          ],
          "description": "Stable failure code you can branch on."
        },
        "failure_message": {
          "type": [
            "string",
            "null"
          ],
          "description": "Readable explanation of the failure, in the language of the request."
        },
        "needs_action": {
          "type": "boolean",
          "description": "Whether the event did not complete and is still worth acting on. Events that failed\nfor reasons outside your control are excluded.\n"
        },
        "outcome": {
          "$ref": "#/$defs/PaymentEventOutcome"
        },
        "draft_available": {
          "type": "boolean",
          "description": "Whether a draft invoice can be generated from this event. When `false`, the draft\noperation would be rejected.\n"
        },
        "retry_available": {
          "type": "boolean",
          "description": "Whether retrying this event would be accepted right now. Do not derive it from\n`status`: a skipped event may still be recoverable, and a failed one with no\nretries left is not.\n"
        },
        "discard_available": {
          "type": "boolean",
          "description": "Whether this event can be discarded — taken out of the list. When `false`, the\ndiscard operation would be rejected.\n\nAn event that is `PROCESSED` or `PROCESSING` cannot be discarded: it has (or is\nabout to have) an invoice that already went through VeriFactu, and hiding it would\nbreak the audit trail. Do not derive it from `status`: read this flag.\n\nAlready-discarded events keep the flag they would have — what applies to them is\nrestore, not discard.\n"
        },
        "retry_count": {
          "type": "integer",
          "description": "Retries charged to the event: those that ended in an outcome attributable to it.\nA retry that failed for a transient cause outside the event is not counted.\n"
        },
        "received_at": {
          "type": "string",
          "format": "date-time",
          "description": "When the event was received."
        },
        "processed_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "When processing of the event finished."
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "Charge description as the provider reported it. It is what the description filters of\nthe connection match against, so it is what makes them auditable.\n"
        },
        "payment_method": {
          "allOf": [
            {
              "$ref": "#/$defs/PaymentMethod"
            }
          ],
          "description": "How the charge was paid, when the provider reported it. `null` means the provider\ndid not report a method for this event.\n"
        },
        "discarded": {
          "type": "boolean",
          "description": "Whether the event was discarded (soft-deleted) and is hidden by default."
        },
        "discarded_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "When the event was discarded, when it is."
        }
      }
    },
    "Pagination": {
      "type": "object",
      "required": [
        "current_page",
        "total_pages",
        "total_items",
        "items_per_page"
      ],
      "properties": {
        "current_page": {
          "type": "integer"
        },
        "total_pages": {
          "type": "integer",
          "description": "How many pages the query has. An empty collection has **one** page — the\nfirst one, empty — so the smallest value a canonical route returns is `1`.\n\nThe deprecated flat aliases (`/v1/invoices`, `/v1/customers`, …) answer `0`\nfor that same empty collection, and `has_next`/`has_previous` follow suit.\nThey were left as they were on purpose: a client that reads `total_pages == 0`\nas \"no results\" would break if it changed under it. Do not compare the two\nfamilies of routes field by field; read `total_items` if what you want to know\nis whether anything came back.\n"
        },
        "total_items": {
          "type": "integer"
        },
        "items_per_page": {
          "type": "integer"
        },
        "has_next": {
          "type": "boolean"
        },
        "has_previous": {
          "type": "boolean"
        }
      }
    },
    "PaymentEventCategory": {
      "type": "string",
      "description": "Which product line a payment event's money came from. A different axis from `event_kind`,\nwhich says what happened: a `checkout.session.completed` is `PAYMENT_COMPLETED` either way,\nand the category tells you whether it was a one-off checkout or the start of a subscription.\n\n- `DIRECT_PAYMENT`: a one-off charge\n- `SUBSCRIPTION`: a charge produced by a recurring subscription\n- `REFUND`: money given back\n- `CREDIT_NOTE`: a credit note issued on the provider's side\n",
      "enum": [
        "DIRECT_PAYMENT",
        "SUBSCRIPTION",
        "REFUND",
        "CREDIT_NOTE"
      ]
    },
    "PaymentEventCounts": {
      "type": "object",
      "description": "How the events of the connection break down, over the whole connection and not just the\npage you are reading. The filters of the request (`q`, `status`, `needs_action`, dates,\namounts and the rest) do not narrow these counts, which may therefore exceed\n`pagination.total_items`: they are what lets you show \"12 need action\" without asking for\nevery page. Only two parameters have a bearing on them: `charges_only` changes what is\ncounted (money movements instead of events), and `include_discarded` decides whether\ndiscarded events take part in `by_status` and `failure_reasons`.\n",
      "required": [
        "total",
        "discarded",
        "needs_action",
        "ignored",
        "by_status",
        "by_failure_reason",
        "failure_reasons"
      ],
      "properties": {
        "total": {
          "type": "integer",
          "description": "Events of the connection that are not discarded — the size of the list you get when\nyou filter by nothing.\n"
        },
        "discarded": {
          "type": "integer",
          "description": "Events you discarded. They are not part of `total`; ask for them with\n`include_discarded=true`.\n"
        },
        "needs_action": {
          "type": "integer",
          "deprecated": true,
          "description": "Events that are waiting for you to do something — the same set you get with\n`needs_action=true`. Counts only events that are not discarded, so it is part of\n`total`.\n\n**Deprecated. Retires on 11 December 2026.** Filter with `needs_action=true` and read\n`pagination.total_items` instead. See the [migration guide](https://docs.beel.es/changelog/payments-cleanup).\n"
        },
        "ignored": {
          "type": "integer",
          "deprecated": true,
          "description": "Events that were skipped on purpose and need nothing from you (duplicates, your own\nfilters, event types that are not invoiced). Counts only events that are not\ndiscarded, so it is part of `total`.\n\n**Deprecated. Retires on 11 December 2026.** The closest surviving figure is\n`by_status.SKIPPED`. See the [migration guide](https://docs.beel.es/changelog/payments-cleanup).\n"
        },
        "by_status": {
          "type": "object",
          "additionalProperties": {
            "type": "integer"
          },
          "description": "Number of events per processing status."
        },
        "by_failure_reason": {
          "type": "object",
          "additionalProperties": {
            "type": "integer"
          },
          "deprecated": true,
          "description": "Number of events per failure reason, among those that did not complete. Events that\ncompleted do not appear here.\n\n**Deprecated. Retires on 11 December 2026.** Use `failure_reasons`, which carries the\nsame counts plus the reason written out for a person. See the\n[migration guide](https://docs.beel.es/changelog/payments-cleanup).\n"
        },
        "failure_reasons": {
          "type": "array",
          "description": "Number of events per failure reason, among those that did not complete, with the\nreason already written out in the language of the request. Events that completed do\nnot appear here. Replaces the deprecated `by_failure_reason`.\n",
          "items": {
            "$ref": "#/$defs/PaymentEventFailureReasonCount"
          }
        }
      }
    },
    "PaymentEventFailureCategory": {
      "type": "string",
      "enum": [
        "USER_CONFIGURATION",
        "PROVIDER_DATA",
        "DOMAIN_RULE",
        "INFRASTRUCTURE",
        "SYSTEM_ERROR"
      ],
      "description": "High-level cause of an event that did not complete, so you can tell apart what you can fix\nfrom what you cannot.\n\n- `USER_CONFIGURATION`: your configuration stopped it (filters, missing series)\n- `PROVIDER_DATA`: the provider data was insufficient or inconsistent\n- `DOMAIN_RULE`: an invoicing rule forbade it — permanent, retrying changes nothing\n- `INFRASTRUCTURE`: a transient failure; retrying may work\n- `SYSTEM_ERROR`: a defect on our side\n"
    },
    "PaymentEventFailureReasonCount": {
      "type": "object",
      "description": "How many events share one failure reason.",
      "required": [
        "code",
        "label",
        "count"
      ],
      "properties": {
        "code": {
          "type": "string",
          "description": "Stable identifier of the reason. Branch on this, not on `label`."
        },
        "label": {
          "type": "string",
          "description": "The reason written out for a person, in the language of the request."
        },
        "count": {
          "type": "integer",
          "description": "Events of the connection with this reason."
        }
      }
    },
    "PaymentEventOutcome": {
      "type": "string",
      "enum": [
        "INVOICED",
        "IN_PROGRESS",
        "NOT_INVOICED",
        "RESOLVED",
        "INCIDENT",
        "NO_CHANGE"
      ],
      "description": "What this event means for its payment. Branch on this value instead of deriving it from\n`status` and `failure_reason`.\n\n- `INVOICED`: an invoice was generated from the event (`invoice_id` is set)\n- `IN_PROGRESS`: the payment can still change, because the event is being processed or\n  retried, or the payer has yet to pay\n- `NOT_INVOICED`: closed without an invoice and with nothing for you to do, for example a\n  zero-amount payment, or a payment settled from the payer's balance\n- `RESOLVED`: marked as resolved outside BeeL\n- `INCIDENT`: needs your action (`needs_action` is `true`)\n- `NO_CHANGE`: the event does not change the tax position of the payment, such as a refund\n  that did not complete, a failed payment attempt, an event type BeeL does not handle, or a\n  dispute settled in your favour\n\n`INCIDENT` takes precedence over the rest, then `INVOICED`.\n"
    },
    "PaymentEventStatus": {
      "type": "string",
      "enum": [
        "RECEIVED",
        "PROCESSING",
        "PROCESSED",
        "FAILED",
        "SKIPPED",
        "MANUALLY_RESOLVED"
      ],
      "description": "Processing status of a payment event.\n\n- RECEIVED: queued, awaiting processing\n- PROCESSING: in flight\n- PROCESSED: invoice was created (`invoice_id` is set)\n- FAILED: processing failed (see failure_reason / failure_message)\n- SKIPPED: filtered out by user rules (see skip_reason)\n- MANUALLY_RESOLVED: operator marked it as resolved outside BeeL — terminal\n"
    },
    "PaymentEventType": {
      "type": "string",
      "enum": [
        "PAYMENT_COMPLETED",
        "PAYMENT_FAILED",
        "REFUND_COMPLETED",
        "DISPUTE_OPENED",
        "DISPUTE_CLOSED",
        "UNKNOWN"
      ],
      "description": "What a payment event is about, once the provider's own event name has been classified.\n\n- `PAYMENT_COMPLETED`: a charge went through\n- `PAYMENT_FAILED`: a charge was attempted and did not go through\n- `REFUND_COMPLETED`: money was returned (refund or credit note)\n- `DISPUTE_OPENED`: the payer disputed a charge\n- `DISPUTE_CLOSED`: a dispute was settled, in favour of either party\n- `UNKNOWN`: the provider event does not fall in any of the above\n"
    },
    "PaymentMethod": {
      "type": "string",
      "description": "Payment method shown on invoices and recurring invoices.\n\n- `NONE`: no payment information is shown.\n- `BANK_TRANSFER`: bank transfer to the IBAN of the payment details; the only method\n  that requires an IBAN.\n- `CARD`: card payment.\n- `CASH`: cash payment.\n- `CHECK`: payment by cheque.\n- `DIRECT_DEBIT`: direct debit from the customer's bank account.\n- `BIZUM`: payment through Bizum.\n- `OTHER`: any other method.\n",
      "enum": [
        "NONE",
        "BANK_TRANSFER",
        "CARD",
        "CASH",
        "CHECK",
        "DIRECT_DEBIT",
        "BIZUM",
        "OTHER"
      ]
    },
    "ResponseMeta": {
      "type": "object",
      "properties": {
        "timestamp": {
          "type": "string",
          "format": "date-time"
        },
        "request_id": {
          "type": "string"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/beel-es-list-managed-payment-events-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.