Create Checkout Session
POST/api/stripe/payment/checkout-session
Creates a new Stripe Checkout Session for collecting a rental application fee payment.
After creating the session, redirect the renter to the checkout_url in the response
to complete payment. Upon completion, the renter will be redirected to your successUrl.
Duplicate Prevention: If the renter has already paid within the last 30 days,
this endpoint returns 409 Conflict.
Amount Behavior:
- If
amountis omitted, it defaults to the relay fee for your account - If
amountis specified, it must be >= the relay fee - The
successUrlmay include{CHECKOUT_SESSION_ID}as a placeholder that Stripe will replace with the actual session ID
Request
Responses
- 201
- 400
- 403
- 409
- 500
- 503
Checkout session created successfully
Invalid request. Possible causes:
- Missing or invalid required fields (renterId, successUrl, cancelUrl)
- Invalid URL format or non-https URL in production
- Amount has more than 2 decimal places or is out of range
- Amount is less than the minimum relay fee
- Client account is missing required Stripe configuration
Validation failures use errorCode 400 with errorOnField naming the
offending field. A malformed (unparseable) JSON body instead returns
errorCode 121.
Missing or invalid X-API-KEY
Renter has already paid within the last 30 days
Stripe API error
Stripe service temporarily unavailable