POSTlive

Create the Stripe Checkout session for a party-paid partner filing fee

Requires fee_referrals:authorize on the owning partner's explicitly provisioned platform_orchestrator credential. The server resolves the public case ID to exactly one payable party-due filing fee and does not accept an internal dispute ID or fee ID. Stripe session creation and the Partner API response are idempotent for that fee.

/api/v2/fees/stripe/checkoutcreatePartnerFilingCheckoutV2

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

platformOrchestratorBearer

Credential bound to the platform_orchestrator role.

Parameters

NameLocationRequirementSchema
Idempotency-KeyheaderRequired{"type":"string","minLength":8,"maxLength":200}

Request body

Required request body.

application/json

{
  "$ref": "#/components/schemas/PartnerFilingCheckoutInput",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "caseId"
  ],
  "properties": {
    "caseId": {
      "type": "string",
      "pattern": "^pcase_[A-Za-z0-9_-]{1,96}$",
      "description": "Public Partner API case ID owned by the authenticated partner."
    }
  }
}

Responses

201

Idempotent Stripe Checkout session for the exact partner filing fee.

application/json

{
  "$ref": "#/components/schemas/PartnerFilingCheckoutEnvelope",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PartnerFilingCheckout",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "schemaVersion",
        "caseId",
        "checkout"
      ],
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "partner-filing-checkout-v1"
        },
        "caseId": {
          "type": "string",
          "pattern": "^pcase_[A-Za-z0-9_-]{1,96}$"
        },
        "checkout": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "id",
            "url"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "url": {
              "type": "string",
              "format": "uri"
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "data": {
    "schemaVersion": "partner-filing-checkout-v1",
    "caseId": "pcase_test_123",
    "checkout": {
      "id": "id_test",
      "url": "https://partner.test.example/callbacks/peoples-court"
    }
  },
  "requestId": "requestId_test"
}

Usage notes

  • Responses reflect the current authoritative resource state.
  • Send a unique Idempotency-Key. An exact retry returns the stored result; reusing the key with a different request fails.
  • The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.