Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
transactionAPI-Referenz
GET/v2/transaction/{id}/pay

Zahlung und erstattbaren Restbetrag prüfen

Liest eine verbuchte Zahlung aus dem eigenen Konto und berechnet erfolgreiche bisherige Erstattungen. Obwohl die Route transaction heißt, ist id hier die öffentliche pay-ID aus der Teilnehmerkontobuchung. Nur Saferpay, Stripe-Karte/SEPA und PayPal v2 werden als online erstattbar eingestuft. Der historische Schlüssel refound enthält repaid_amount/refundable_amount oder false.

Operation-ID get_v2_transaction_id_pay

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Nein
Als readOnly markiert
Ja
Für Automation markiert
Ja
GET-Verhalten laut Spezifikation

read

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

Pfadparameter

iderforderlich

Öffentliche pay-ID der ursprünglichen Zahlung; keine transaction-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"
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"
  ]
}
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

9

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

200application/json

Zahlung mit refundable und payment einschließlich historischem Feld refound.

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"
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.

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"
          ]
        },
        "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
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "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"
}
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"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Transaction.php:439getTransaction()

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
false
x-edoobox-get-effect
"read"
x-edoobox-get-permission-review
{
  "file": "docs/openapi/reviews/vue-get-permission-03.json",
  "pointer": "/operations/19",
  "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
  "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
}
x-edoobox-mutationReview
{
  "source": {
    "file": "application/models/v2/Transaction.php",
    "line": 568,
    "reason": "Exact pay GET delegates _getTransactionPayData; _putTransactionRefund is selected separately by update handler."
  },
  "reason": "Read an existing payment and computed refundable amount; do not execute a charge or refund.",
  "review": {
    "file": "docs/openapi/reviews/vue-get-permission-03.json",
    "pointer": "/operations/19",
    "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  }
}
x-edoobox-runtimeMutationGuard
false
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/04-accounting.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Transaction.php",
  "method": "getTransaction",
  "line": 439,
  "branch": {
    "file": "application/models/v2/Transaction.php",
    "line": 568
  }
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
true
x-edoobox-safeForAutomation
true
x-edoobox-permission
{
  "resource": "transaction",
  "short": "tans",
  "checkedByDispatcher": true,
  "levels": [
    1,
    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": "get_v2_transaction_id_pay",
  "summary": "Zahlung und erstattbaren Restbetrag prüfen",
  "description": "Liest eine verbuchte Zahlung aus dem eigenen Konto und berechnet erfolgreiche bisherige Erstattungen. Obwohl die Route transaction heißt, ist id hier die öffentliche pay-ID aus der Teilnehmerkontobuchung. Nur Saferpay, Stripe-Karte/SEPA und PayPal v2 werden als online erstattbar eingestuft. Der historische Schlüssel refound enthält repaid_amount/refundable_amount oder false.",
  "tags": [
    "transaction"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "Öffentliche pay-ID der ursprünglichen Zahlung; keine transaction-ID.",
      "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"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Zahlung mit refundable und payment einschließlich historischem Feld refound.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "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"
                    ]
                  },
                  "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
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "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"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": false,
  "x-edoobox-get-effect": "read",
  "x-edoobox-get-permission-review": {
    "file": "docs/openapi/reviews/vue-get-permission-03.json",
    "pointer": "/operations/19",
    "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  },
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Transaction.php",
      "line": 568,
      "reason": "Exact pay GET delegates _getTransactionPayData; _putTransactionRefund is selected separately by update handler."
    },
    "reason": "Read an existing payment and computed refundable amount; do not execute a charge or refund.",
    "review": {
      "file": "docs/openapi/reviews/vue-get-permission-03.json",
      "pointer": "/operations/19",
      "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
      "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
    }
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/04-accounting.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Transaction.php",
    "method": "getTransaction",
    "line": 439,
    "branch": {
      "file": "application/models/v2/Transaction.php",
      "line": 568
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "transaction",
    "short": "tans",
    "checkedByDispatcher": true,
    "levels": [
      1,
      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."
  }
}