PUT/v2/transaction/{id}/refund

Onlinezahlung teilweise oder vollständig erstatten

Erstattet einen positiven Betrag über Saferpay, Stripe oder PayPal v2 und legt anschließend Gegenbuchung sowie Erstattungseintrag an. Pfad-id bezeichnet die ursprüngliche pay-ID. amount muss nach Rundung positiv sein und darf den erstattbaren Rest nicht überschreiten; description muss nach Textnormalisierung länger als ein Zeichen sein. Erfolg aktualisiert betroffene Rechnungen; invoice_refresh_pending kann einen nachgelagerten Dokumentfehler melden, obwohl die Auszahlung bereits erfolgreich war. In diesem Fall die Erstattung keinesfalls zur Dokumentkorrektur wiederholen.

Operation-ID put_v2_transaction_id_refund

Vertrag & Verhalten

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

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.

Ressource: transaction · tans
Levels: 3, 4
Dispatcher-Prüfung: Ja

Parameter

Pfadparameter

iderforderlich

Öffentliche pay-ID der ursprünglichen Onlinezahlung.

string

Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.

pattern: "^pay_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"pay_012345abcdef_123456"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
  "examples": [
    "pay_012345abcdef_123456"
  ]
}

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"
  ]
}

Request Body

erforderlich

`application/json`

object

data object erforderlich

amount Typ nicht eingeschränkt erforderlich

Positiver Teil-/Gesamtbetrag in Zahlungswährung; Zahlen oder numerische Zeichenfolgen.

anyOf · Mindestens eine Variante muss passen

Variante 1 number

Variante 2 string

Numerische Zeichenfolge; PHP is_numeric beziehungsweise die dokumentierte Zahlen-Normalisierung ist maßgeblich.

description string erforderlich

Grund der Erstattung; nach aP-Textnormalisierung mindestens zwei Zeichen.

minLength: 2

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "amount": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "string",
              "description": "Numerische Zeichenfolge; PHP is_numeric beziehungsweise die dokumentierte Zahlen-Normalisierung ist maßgeblich."
            }
          ],
          "description": "Positiver Teil-/Gesamtbetrag in Zahlungswährung; Zahlen oder numerische Zeichenfolgen."
        },
        "description": {
          "type": "string",
          "minLength": 2,
          "description": "Grund der Erstattung; nach aP-Textnormalisierung mindestens zwei Zeichen."
        }
      },
      "additionalProperties": true,
      "required": [
        "amount",
        "description"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

Onlinezahlung teilweise oder vollständig erstatten

{
  "data": {
    "amount": 20,
    "description": "Teilnahme storniert"
  }
}

Antworten

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

200application/json

Erstattungsstatus, gegebenenfalls Fehlerdetails, betroffene Rechnungen und vor der Erstattung gelesene Zahlungsdetails. refund=true bestätigt die Auszahlung unabhängig vom Dokumentstatus.

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

id string

Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.

pattern: "^pay_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"pay_012345abcdef_123456"

update boolean

refund boolean

refund_error boolean

refund_error_code string | boolean

refund_error_message string | boolean

invoices array

Array-Elemente

string

Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.

pattern: "^invoice_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"invoice_012345abcdef_123456"

invoice_refresh_pending boolean

pay object

id string

Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.

pattern: "^pay_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"pay_012345abcdef_123456"

paytrans string

Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.

pattern: "^paytrans_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"paytrans_012345abcdef_123456"

refundable boolean

payment object

type string

token string

currency string

amount number

refound Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 object

repaid_amount number

refundable_amount number

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

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

date Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 string

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

user string

Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.

pattern: "^user_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"user_012345abcdef_123456"

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": {
        "id": {
          "type": "string",
          "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
          "examples": [
            "pay_012345abcdef_123456"
          ]
        },
        "update": {
          "type": "boolean"
        },
        "refund": {
          "type": "boolean"
        },
        "refund_error": {
          "type": "boolean"
        },
        "refund_error_code": {
          "type": [
            "string",
            "boolean"
          ]
        },
        "refund_error_message": {
          "type": [
            "string",
            "boolean"
          ]
        },
        "invoices": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
            "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
            "examples": [
              "invoice_012345abcdef_123456"
            ]
          }
        },
        "invoice_refresh_pending": {
          "type": "boolean"
        },
        "pay": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
              "examples": [
                "pay_012345abcdef_123456"
              ]
            },
            "paytrans": {
              "type": "string",
              "pattern": "^paytrans_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
              "examples": [
                "paytrans_012345abcdef_123456"
              ]
            },
            "refundable": {
              "type": "boolean"
            },
            "payment": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string"
                },
                "token": {
                  "type": "string"
                },
                "currency": {
                  "type": "string"
                },
                "amount": {
                  "type": "number"
                },
                "refound": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "repaid_amount": {
                          "type": "number"
                        },
                        "refundable_amount": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": true
                    },
                    {
                      "const": false
                    }
                  ]
                },
                "date": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "const": false
                    }
                  ]
                },
                "user": {
                  "type": "string",
                  "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                  "examples": [
                    "user_012345abcdef_123456"
                  ]
                }
              },
              "additionalProperties": true
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "pay_012345abcdef_123456",
    "update": true,
    "refund": true,
    "refund_error": false,
    "invoices": [
      "invoice_012345abcdef_123456"
    ],
    "invoice_refresh_pending": false,
    "pay": {
      "id": "pay_012345abcdef_123456",
      "paytrans": "paytrans_012345abcdef_123456",
      "refundable": true,
      "payment": {
        "type": "p_stripe_c",
        "token": "ch_example",
        "currency": "CHF",
        "amount": 120,
        "refound": {
          "repaid_amount": 20,
          "refundable_amount": 100
        },
        "date": "2026-10-15T10:00:00+02:00",
        "user": "user_012345abcdef_123456"
      }
    }
  }
}

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

`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"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Transaction.php:393updateTransaction()

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/04-accounting.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Transaction.php",
  "method": "updateTransaction",
  "line": 393,
  "branch": {
    "file": "application/models/v2/Transaction.php",
    "line": 398
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "transaction",
  "short": "tans",
  "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_transaction_id_refund",
  "summary": "Onlinezahlung teilweise oder vollständig erstatten",
  "description": "Erstattet einen positiven Betrag über Saferpay, Stripe oder PayPal v2 und legt anschließend Gegenbuchung sowie Erstattungseintrag an. Pfad-id bezeichnet die ursprüngliche pay-ID. amount muss nach Rundung positiv sein und darf den erstattbaren Rest nicht überschreiten; description muss nach Textnormalisierung länger als ein Zeichen sein. Erfolg aktualisiert betroffene Rechnungen; invoice_refresh_pending kann einen nachgelagerten Dokumentfehler melden, obwohl die Auszahlung bereits erfolgreich war. In diesem Fall die Erstattung keinesfalls zur Dokumentkorrektur wiederholen.",
  "tags": [
    "transaction"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "Öffentliche pay-ID der ursprünglichen Onlinezahlung.",
      "schema": {
        "type": "string",
        "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
        "examples": [
          "pay_012345abcdef_123456"
        ]
      }
    },
    {
      "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": "Erstattungsstatus, gegebenenfalls Fehlerdetails, betroffene Rechnungen und vor der Erstattung gelesene Zahlungsdetails. refund=true bestätigt die Auszahlung unabhängig vom Dokumentstatus.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "pay_012345abcdef_123456",
              "update": true,
              "refund": true,
              "refund_error": false,
              "invoices": [
                "invoice_012345abcdef_123456"
              ],
              "invoice_refresh_pending": false,
              "pay": {
                "id": "pay_012345abcdef_123456",
                "paytrans": "paytrans_012345abcdef_123456",
                "refundable": true,
                "payment": {
                  "type": "p_stripe_c",
                  "token": "ch_example",
                  "currency": "CHF",
                  "amount": 120,
                  "refound": {
                    "repaid_amount": 20,
                    "refundable_amount": 100
                  },
                  "date": "2026-10-15T10:00:00+02:00",
                  "user": "user_012345abcdef_123456"
                }
              }
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                    "examples": [
                      "pay_012345abcdef_123456"
                    ]
                  },
                  "update": {
                    "type": "boolean"
                  },
                  "refund": {
                    "type": "boolean"
                  },
                  "refund_error": {
                    "type": "boolean"
                  },
                  "refund_error_code": {
                    "type": [
                      "string",
                      "boolean"
                    ]
                  },
                  "refund_error_message": {
                    "type": [
                      "string",
                      "boolean"
                    ]
                  },
                  "invoices": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                      "examples": [
                        "invoice_012345abcdef_123456"
                      ]
                    }
                  },
                  "invoice_refresh_pending": {
                    "type": "boolean"
                  },
                  "pay": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                        "examples": [
                          "pay_012345abcdef_123456"
                        ]
                      },
                      "paytrans": {
                        "type": "string",
                        "pattern": "^paytrans_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                        "examples": [
                          "paytrans_012345abcdef_123456"
                        ]
                      },
                      "refundable": {
                        "type": "boolean"
                      },
                      "payment": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string"
                          },
                          "token": {
                            "type": "string"
                          },
                          "currency": {
                            "type": "string"
                          },
                          "amount": {
                            "type": "number"
                          },
                          "refound": {
                            "anyOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "repaid_amount": {
                                    "type": "number"
                                  },
                                  "refundable_amount": {
                                    "type": "number"
                                  }
                                },
                                "additionalProperties": true
                              },
                              {
                                "const": false
                              }
                            ]
                          },
                          "date": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "const": false
                              }
                            ]
                          },
                          "user": {
                            "type": "string",
                            "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus diesem Konto; keine interne Datenbank-ID.",
                            "examples": [
                              "user_012345abcdef_123456"
                            ]
                          }
                        },
                        "additionalProperties": true
                      }
                    },
                    "additionalProperties": true
                  }
                },
                "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": {
                "amount": {
                  "anyOf": [
                    {
                      "type": "number"
                    },
                    {
                      "type": "string",
                      "description": "Numerische Zeichenfolge; PHP is_numeric beziehungsweise die dokumentierte Zahlen-Normalisierung ist maßgeblich."
                    }
                  ],
                  "description": "Positiver Teil-/Gesamtbetrag in Zahlungswährung; Zahlen oder numerische Zeichenfolgen."
                },
                "description": {
                  "type": "string",
                  "minLength": 2,
                  "description": "Grund der Erstattung; nach aP-Textnormalisierung mindestens zwei Zeichen."
                }
              },
              "additionalProperties": true,
              "required": [
                "amount",
                "description"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Onlinezahlung teilweise oder vollständig erstatten",
            "value": {
              "data": {
                "amount": 20,
                "description": "Teilnahme storniert"
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/04-accounting.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Transaction.php",
    "method": "updateTransaction",
    "line": 393,
    "branch": {
      "file": "application/models/v2/Transaction.php",
      "line": 398
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "transaction",
    "short": "tans",
    "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."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
# cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${PATH_ID:?PATH_ID setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "amount": 20,
    "description": "Teilnahme storniert"
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'PUT' \
  --url "${API_ORIGIN%/}"'/v2/transaction/'"${PATH_ID}"'/refund' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/transaction/{id}/refund";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "amount": 20,
    "description": "Teilnahme storniert"
  }
});
const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/transaction/{id}/refund"
path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"amount\":20,\"description\":\"Teilnahme storniert\"}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="PUT", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/transaction/{id}/refund";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "amount": 20,
    "description": "Teilnahme storniert"
  }
});
const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/transaction/{id}/refund"
path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"amount\":20,\"description\":\"Teilnahme storniert\"}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="PUT", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.