authAPI-Referenz

POST/v2/auth/webhook/paypal

Signierte PayPal-Ereignisse verarbeiten

Empfängt den originalen PayPal-JSON-Body und prüft Provider-Signatur samt Übertragungsheadern, bevor Zahlungen, Rückerstattungen oder Händlerverbindungsstatus verarbeitet werden. Die Antwort wird früh bestätigt; ihr Erfolg beweist keine fachliche Verarbeitung. Der Legacy-GET-Alias nutzt denselben Body-Handler und kann bei gültigem Provider-Ereignis Daten verändern. Kein data-Envelope um das Provider-Event legen.

Operation-ID post_v2_auth_webhook_paypal

Vertrag & Verhalten

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

Authentifizierung

Für diesen Endpunkt sind keine OpenAPI-Security-Schemas vorgeschrieben. Weitere Voraussetzungen stehen in den Parametern und den Metadaten.

Berechtigungen

No account-JWT resource permission levels are applied. Authentication requirements, if any, are defined by this route source-specific boundary and dedicated security scheme.

Levels: Keine Account-Level angegeben
Dispatcher-Prüfung: Nein

Parameter

Header

PAYPAL-CERT-URLerforderlich

Originaler PayPal-Verifikationsheader.

string

Vollständiges Schema als JSON

{
  "type": "string"
}

PAYPAL-TRANSMISSION-IDerforderlich

Originaler PayPal-Verifikationsheader.

string

Vollständiges Schema als JSON

{
  "type": "string"
}

PAYPAL-TRANSMISSION-TIMEerforderlich

Originaler PayPal-Verifikationsheader.

string

Vollständiges Schema als JSON

{
  "type": "string"
}

PAYPAL-TRANSMISSION-SIGerforderlich

Originaler PayPal-Verifikationsheader.

string

Vollständiges Schema als JSON

{
  "type": "string"
}

PAYPAL-AUTH-ALGOerforderlich

Originaler PayPal-Verifikationsheader.

string

Vollständiges Schema als JSON

{
  "type": "string"
}

Request Body

erforderlich

`application/json`

object

id string erforderlich

event_type string erforderlich

resource object erforderlich

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "event_type": {
      "type": "string"
    },
    "resource": {
      "type": "object",
      "additionalProperties": true
    }
  },
  "additionalProperties": true,
  "required": [
    "id",
    "event_type",
    "resource"
  ]
}

Signierte PayPal-Ereignisse verarbeiten

{
  "id": "WH-SYNTHETIC-EVENT",
  "event_type": "MERCHANT.ONBOARDING.COMPLETED",
  "resource": {
    "tracking_id": "account_012345abcdef_123456",
    "merchant_id": "SYNTHETIC-MERCHANT"
  }
}

Antworten

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

200text/html

Frühe Textbestätigung success; tatsächliche Verarbeitung erfolgt anschließend.

`text/html`

string

Vollständiges Schema als JSON

{
  "type": "string"
}

Beispiel

"success"

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

Quelle & Metadaten

Quelle laut Spezifikationapplication/controllers/V2.php:28coreV2()

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

false

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/05-auth.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/controllers/V2.php",
  "method": "coreV2",
  "line": 28
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "description": "No account-JWT resource permission levels are applied. Authentication requirements, if any, are defined by this route source-specific boundary and dedicated security scheme.",
  "checkedByDispatcher": false,
  "levels": []
}

Vollständige Operation als JSON

{
  "operationId": "post_v2_auth_webhook_paypal",
  "summary": "Signierte PayPal-Ereignisse verarbeiten",
  "description": "Empfängt den originalen PayPal-JSON-Body und prüft Provider-Signatur samt Übertragungsheadern, bevor Zahlungen, Rückerstattungen oder Händlerverbindungsstatus verarbeitet werden. Die Antwort wird früh bestätigt; ihr Erfolg beweist keine fachliche Verarbeitung. Der Legacy-GET-Alias nutzt denselben Body-Handler und kann bei gültigem Provider-Ereignis Daten verändern. Kein data-Envelope um das Provider-Event legen.",
  "tags": [
    "auth"
  ],
  "security": [],
  "parameters": [
    {
      "name": "PAYPAL-CERT-URL",
      "in": "header",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Originaler PayPal-Verifikationsheader."
    },
    {
      "name": "PAYPAL-TRANSMISSION-ID",
      "in": "header",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Originaler PayPal-Verifikationsheader."
    },
    {
      "name": "PAYPAL-TRANSMISSION-TIME",
      "in": "header",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Originaler PayPal-Verifikationsheader."
    },
    {
      "name": "PAYPAL-TRANSMISSION-SIG",
      "in": "header",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Originaler PayPal-Verifikationsheader."
    },
    {
      "name": "PAYPAL-AUTH-ALGO",
      "in": "header",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "Originaler PayPal-Verifikationsheader."
    }
  ],
  "responses": {
    "200": {
      "description": "Frühe Textbestätigung success; tatsächliche Verarbeitung erfolgt anschließend.",
      "content": {
        "text/html": {
          "schema": {
            "type": "string"
          },
          "example": "success"
        }
      }
    },
    "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": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "event_type": {
              "type": "string"
            },
            "resource": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "additionalProperties": true,
          "required": [
            "id",
            "event_type",
            "resource"
          ]
        },
        "examples": {
          "request": {
            "summary": "Signierte PayPal-Ereignisse verarbeiten",
            "value": {
              "id": "WH-SYNTHETIC-EVENT",
              "event_type": "MERCHANT.ONBOARDING.COMPLETED",
              "resource": {
                "tracking_id": "account_012345abcdef_123456",
                "merchant_id": "SYNTHETIC-MERCHANT"
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/05-auth.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/controllers/V2.php",
    "method": "coreV2",
    "line": 28
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "description": "No account-JWT resource permission levels are applied. Authentication requirements, if any, are defined by this route source-specific boundary and dedicated security scheme.",
    "checkedByDispatcher": false,
    "levels": []
  }
}

Aufruf vorbereiten

Beispiel

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

cURL

# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${HEADER_PAYPAL_CERT_URL:?HEADER_PAYPAL_CERT_URL setzen}"
: "${HEADER_PAYPAL_TRANSMISSION_ID:?HEADER_PAYPAL_TRANSMISSION_ID setzen}"
: "${HEADER_PAYPAL_TRANSMISSION_TIME:?HEADER_PAYPAL_TRANSMISSION_TIME setzen}"
: "${HEADER_PAYPAL_TRANSMISSION_SIG:?HEADER_PAYPAL_TRANSMISSION_SIG setzen}"
: "${HEADER_PAYPAL_AUTH_ALGO:?HEADER_PAYPAL_AUTH_ALGO setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "id": "WH-SYNTHETIC-EVENT",
  "event_type": "MERCHANT.ONBOARDING.COMPLETED",
  "resource": {
    "tracking_id": "account_012345abcdef_123456",
    "merchant_id": "SYNTHETIC-MERCHANT"
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/auth/webhook/paypal' \
  --header 'PAYPAL-CERT-URL: '"${HEADER_PAYPAL_CERT_URL}" \
  --header 'PAYPAL-TRANSMISSION-ID: '"${HEADER_PAYPAL_TRANSMISSION_ID}" \
  --header 'PAYPAL-TRANSMISSION-TIME: '"${HEADER_PAYPAL_TRANSMISSION_TIME}" \
  --header 'PAYPAL-TRANSMISSION-SIG: '"${HEADER_PAYPAL_TRANSMISSION_SIG}" \
  --header 'PAYPAL-AUTH-ALGO: '"${HEADER_PAYPAL_AUTH_ALGO}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// 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/auth/webhook/paypal";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["PAYPAL-CERT-URL"] = "" + required("HEADER_PAYPAL_CERT_URL");
headers["PAYPAL-TRANSMISSION-ID"] = "" + required("HEADER_PAYPAL_TRANSMISSION_ID");
headers["PAYPAL-TRANSMISSION-TIME"] = "" + required("HEADER_PAYPAL_TRANSMISSION_TIME");
headers["PAYPAL-TRANSMISSION-SIG"] = "" + required("HEADER_PAYPAL_TRANSMISSION_SIG");
headers["PAYPAL-AUTH-ALGO"] = "" + required("HEADER_PAYPAL_AUTH_ALGO");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "id": "WH-SYNTHETIC-EVENT",
  "event_type": "MERCHANT.ONBOARDING.COMPLETED",
  "resource": {
    "tracking_id": "account_012345abcdef_123456",
    "merchant_id": "SYNTHETIC-MERCHANT"
  }
});
const response = await fetch(url, { method: "POST", 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

# 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/auth/webhook/paypal"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["PAYPAL-CERT-URL"] = "" + os.environ["HEADER_PAYPAL_CERT_URL"]
headers["PAYPAL-TRANSMISSION-ID"] = "" + os.environ["HEADER_PAYPAL_TRANSMISSION_ID"]
headers["PAYPAL-TRANSMISSION-TIME"] = "" + os.environ["HEADER_PAYPAL_TRANSMISSION_TIME"]
headers["PAYPAL-TRANSMISSION-SIG"] = "" + os.environ["HEADER_PAYPAL_TRANSMISSION_SIG"]
headers["PAYPAL-AUTH-ALGO"] = "" + os.environ["HEADER_PAYPAL_AUTH_ALGO"]
headers["Content-Type"] = "application/json"
body = "{\"id\":\"WH-SYNTHETIC-EVENT\",\"event_type\":\"MERCHANT.ONBOARDING.COMPLETED\",\"resource\":{\"tracking_id\":\"account_012345abcdef_123456\",\"merchant_id\":\"SYNTHETIC-MERCHANT\"}}".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="POST", 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

// 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/auth/webhook/paypal";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["PAYPAL-CERT-URL"] = "" + required("HEADER_PAYPAL_CERT_URL");
headers["PAYPAL-TRANSMISSION-ID"] = "" + required("HEADER_PAYPAL_TRANSMISSION_ID");
headers["PAYPAL-TRANSMISSION-TIME"] = "" + required("HEADER_PAYPAL_TRANSMISSION_TIME");
headers["PAYPAL-TRANSMISSION-SIG"] = "" + required("HEADER_PAYPAL_TRANSMISSION_SIG");
headers["PAYPAL-AUTH-ALGO"] = "" + required("HEADER_PAYPAL_AUTH_ALGO");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "id": "WH-SYNTHETIC-EVENT",
  "event_type": "MERCHANT.ONBOARDING.COMPLETED",
  "resource": {
    "tracking_id": "account_012345abcdef_123456",
    "merchant_id": "SYNTHETIC-MERCHANT"
  }
});
const response = await fetch(url, { method: "POST", 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

# 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/auth/webhook/paypal"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["PAYPAL-CERT-URL"] = "" + os.environ["HEADER_PAYPAL_CERT_URL"]
headers["PAYPAL-TRANSMISSION-ID"] = "" + os.environ["HEADER_PAYPAL_TRANSMISSION_ID"]
headers["PAYPAL-TRANSMISSION-TIME"] = "" + os.environ["HEADER_PAYPAL_TRANSMISSION_TIME"]
headers["PAYPAL-TRANSMISSION-SIG"] = "" + os.environ["HEADER_PAYPAL_TRANSMISSION_SIG"]
headers["PAYPAL-AUTH-ALGO"] = "" + os.environ["HEADER_PAYPAL_AUTH_ALGO"]
headers["Content-Type"] = "application/json"
body = "{\"id\":\"WH-SYNTHETIC-EVENT\",\"event_type\":\"MERCHANT.ONBOARDING.COMPLETED\",\"resource\":{\"tracking_id\":\"account_012345abcdef_123456\",\"merchant_id\":\"SYNTHETIC-MERCHANT\"}}".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="POST", 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.