Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
edsubscriptionAPI-Referenz
PUT/v2/edsubscription/list/pay

Guthaben für die edoobox-Kontoabrechnung bezahlen

Erstellt eine Zahlung oder Rechnungsreferenz für das Konto. type ist invoice, creditcard oder sofortcom; amount muss mindestens 2 betragen und description nach Bereinigung mindestens zwei Zeichen haben. EUR-Konten benötigen vorher eine Geschäftsbeziehung. Bei creditcard sind step=PaymentIntent, Pay oder PayCard erforderlich: Pay verwendet eine Stripe-PaymentIntent-ID, PayCard eine gespeicherte edcard-v2-ID in paymentid. Zahlungsaufrufe können Geldbewegungen auslösen; fehlgeschlagene oder unklare Antworten nicht blind wiederholen.

Operation-ID put_v2_edsubscription_list_pay

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Ja
Als readOnly markiert
Nein
Für Automation markiert
Nein
02

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON
{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}
accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}
accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

03

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string
pattern
"^[a-f0-9]{32}$"
Schema-Beispiel
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}
04

Request Body

erforderlich

application/json

object
data object erforderlich
type string erforderlich
Erlaubte Werte
"invoice""creditcard""sofortcom"
amount number | string erforderlich

Zahl oder numerische Zeichenkette >= 2.

description string erforderlich

Wird bereinigt und auf 35 Zeichen gekürzt; Ergebnis mindestens zwei Zeichen.

step string
Erlaubte Werte
"PaymentIntent""Pay""PayCard"
paymentid string

Stripe-PaymentIntent-ID bei Pay oder öffentliche edcard-v2-ID bei PayCard.

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Schema-Regel if
Typ nicht eingeschränkt
type Typ nicht eingeschränkt

Fester Wert: "creditcard"

Schema-Regel then
Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: step

id string erforderlich

Legacy-Selektor: Bei /list-Schreibrouten benötigt der Dispatcher top-level id. Die Aktion verwendet anschließend das authentifizierte Konto; üblicher Wert account.

Schema-Beispiel
"account"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "invoice",
            "creditcard",
            "sofortcom"
          ]
        },
        "amount": {
          "type": [
            "number",
            "string"
          ],
          "description": "Zahl oder numerische Zeichenkette >= 2."
        },
        "description": {
          "type": "string",
          "description": "Wird bereinigt und auf 35 Zeichen gekürzt; Ergebnis mindestens zwei Zeichen."
        },
        "step": {
          "type": "string",
          "enum": [
            "PaymentIntent",
            "Pay",
            "PayCard"
          ]
        },
        "paymentid": {
          "type": "string",
          "description": "Stripe-PaymentIntent-ID bei Pay oder öffentliche edcard-v2-ID bei PayCard."
        }
      },
      "additionalProperties": true,
      "required": [
        "type",
        "amount",
        "description"
      ],
      "if": {
        "properties": {
          "type": {
            "const": "creditcard"
          }
        }
      },
      "then": {
        "required": [
          "step"
        ]
      }
    },
    "id": {
      "type": "string",
      "description": "Legacy-Selektor: Bei /list-Schreibrouten benötigt der Dispatcher top-level id. Die Aktion verwendet anschließend das authentifizierte Konto; üblicher Wert account.",
      "examples": [
        "account"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data",
    "id"
  ]
}
Guthaben für die edoobox-Kontoabrechnung bezahlen
{
  "data": {
    "type": "invoice",
    "amount": 100,
    "description": "Kontoguthaben"
  },
  "id": "account"
}
05

Antworten

11

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

Zahlungsart-/schrittabhängig: invoice liefert status und token mit Rechnungsreferenzdaten, sofortcom eine redirect_url, PaymentIntent client_secret und return_url, Kreditkartenzahlung status und requires_action. error=false bestätigt nicht zwingend eine Zahlung.

Response Header

X-Edoobox-Revision

Rotated account revision supplied for the next action in one reviewed sequence.

string
pattern
"^[a-f0-9]{32}$"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

application/json

object
success boolean
error boolean | string
error_code string
data object
status string
token Typ nicht eingeschränkt
type string | boolean
id string
client_secret string
error_code string
requires_action boolean
return_url string
redirect_url string
error string | boolean

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string"
        },
        "token": {},
        "type": {
          "type": [
            "string",
            "boolean"
          ]
        },
        "id": {
          "type": "string"
        },
        "client_secret": {
          "type": "string"
        },
        "error_code": {
          "type": "string"
        },
        "requires_action": {
          "type": "boolean"
        },
        "return_url": {
          "type": "string"
        },
        "redirect_url": {
          "type": "string"
        },
        "error": {
          "type": [
            "string",
            "boolean"
          ]
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "status": "success",
    "type": "creditcard",
    "requires_action": false
  }
}
400application/json

Invalid request.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40006"
}
401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40103"
}
402application/json

Missing/invalid action data or subscription/operation restriction.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80100"
}
403application/json

Permission denied. Browser CORS rejection may have an empty body.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40340"
}
404application/json

Unknown resource/action or unsupported method.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80019"
}
409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

application/json

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "additionalProperties": true
}
Beispiel
{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}
422application/json

Validation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80020"
}
429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

Retry-After

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string
Schema-Beispiel
"30"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "30"
  ]
}

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED42902"
}
502application/json

Server-side operation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED50201"
}
503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

Retry-After

integer

Fester Wert: 1

Vollständiges Schema als JSON
{
  "type": "integer",
  "const": 1
}

application/json

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "additionalProperties": true
}
Beispiel
{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Edsubscription.php:230updateEdsubscription()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state
true
x-edoobox-runtimeMutationGuard
true
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/08-subscriptions.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Edsubscription.php",
  "method": "updateEdsubscription",
  "line": 230,
  "branch": {
    "file": "application/models/v2/Edsubscription.php",
    "line": 235
  }
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
false
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "edsubscription",
  "short": "edsu",
  "checkedByDispatcher": true,
  "levels": [
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}
Vollständige Operation als JSON
{
  "operationId": "put_v2_edsubscription_list_pay",
  "summary": "Guthaben für die edoobox-Kontoabrechnung bezahlen",
  "description": "Erstellt eine Zahlung oder Rechnungsreferenz für das Konto. type ist invoice, creditcard oder sofortcom; amount muss mindestens 2 betragen und description nach Bereinigung mindestens zwei Zeichen haben. EUR-Konten benötigen vorher eine Geschäftsbeziehung. Bei creditcard sind step=PaymentIntent, Pay oder PayCard erforderlich: Pay verwendet eine Stripe-PaymentIntent-ID, PayCard eine gespeicherte edcard-v2-ID in paymentid. Zahlungsaufrufe können Geldbewegungen auslösen; fehlgeschlagene oder unklare Antworten nicht blind wiederholen.",
  "tags": [
    "edsubscription"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "Zahlungsart-/schrittabhängig: invoice liefert status und token mit Rechnungsreferenzdaten, sofortcom eine redirect_url, PaymentIntent client_secret und return_url, Kreditkartenzahlung status und requires_action. error=false bestätigt nicht zwingend eine Zahlung.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "status": "success",
              "type": "creditcard",
              "requires_action": false
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "status": {
                    "type": "string"
                  },
                  "token": {},
                  "type": {
                    "type": [
                      "string",
                      "boolean"
                    ]
                  },
                  "id": {
                    "type": "string"
                  },
                  "client_secret": {
                    "type": "string"
                  },
                  "error_code": {
                    "type": "string"
                  },
                  "requires_action": {
                    "type": "boolean"
                  },
                  "return_url": {
                    "type": "string"
                  },
                  "redirect_url": {
                    "type": "string"
                  },
                  "error": {
                    "type": [
                      "string",
                      "boolean"
                    ]
                  }
                },
                "additionalProperties": true
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "invoice",
                    "creditcard",
                    "sofortcom"
                  ]
                },
                "amount": {
                  "type": [
                    "number",
                    "string"
                  ],
                  "description": "Zahl oder numerische Zeichenkette >= 2."
                },
                "description": {
                  "type": "string",
                  "description": "Wird bereinigt und auf 35 Zeichen gekürzt; Ergebnis mindestens zwei Zeichen."
                },
                "step": {
                  "type": "string",
                  "enum": [
                    "PaymentIntent",
                    "Pay",
                    "PayCard"
                  ]
                },
                "paymentid": {
                  "type": "string",
                  "description": "Stripe-PaymentIntent-ID bei Pay oder öffentliche edcard-v2-ID bei PayCard."
                }
              },
              "additionalProperties": true,
              "required": [
                "type",
                "amount",
                "description"
              ],
              "if": {
                "properties": {
                  "type": {
                    "const": "creditcard"
                  }
                }
              },
              "then": {
                "required": [
                  "step"
                ]
              }
            },
            "id": {
              "type": "string",
              "description": "Legacy-Selektor: Bei /list-Schreibrouten benötigt der Dispatcher top-level id. Die Aktion verwendet anschließend das authentifizierte Konto; üblicher Wert account.",
              "examples": [
                "account"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data",
            "id"
          ]
        },
        "examples": {
          "request": {
            "summary": "Guthaben für die edoobox-Kontoabrechnung bezahlen",
            "value": {
              "data": {
                "type": "invoice",
                "amount": 100,
                "description": "Kontoguthaben"
              },
              "id": "account"
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/08-subscriptions.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Edsubscription.php",
    "method": "updateEdsubscription",
    "line": 230,
    "branch": {
      "file": "application/models/v2/Edsubscription.php",
      "line": 235
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "edsubscription",
    "short": "edsu",
    "checkedByDispatcher": true,
    "levels": [
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}