appointments

Pay Appointment V2

Changed on

Create payment checkout session for an existing appointment, requiring the tax deduction question to be answered.

post/api/appointments/v2/pay

Request

  • Base URL: https://api.corabea.it (the document declares no server; this is the origin it was published from)
  • URL: https://api.corabea.it/api/appointments/v2/pay
  • Auth: HTTP bearer

Request body

appointment_idstring required

Appointment UUID to pay

coupon_idstring nullable

Optional Stripe coupon ID to apply to the payment

payment_sheetboolean

True when the client can present Stripe PaymentSheet; ignored when a coupon is applied

Example request

{
  "appointment_id": "123e4567-e89b-12d3-a456-426614174000",
  "coupon_id": "coupon_abc123"
}

Response

Successful Response

payment_idstring nullable

Payment UUID when checkout is required

checkout_urlstring nullable

Stripe checkout URL when payment required

payment_intent_client_secretstring nullable

PaymentIntent client secret when the payment goes through the in-app PaymentSheet instead of Checkout

customer_idstring nullable

Stripe customer ID for PaymentSheet

ephemeral_keystring nullable

Ephemeral key secret of the customer for PaymentSheet

publishable_keystring nullable

Stripe publishable key for PaymentSheet

expires_atstring date-time nullable

Checkout lock expiry when payment required

amountinteger required

Amount in cents (0 for instant free booking)

currencystring

Currency code

appointment_idstring nullable

Confirmed appointment UUID when no Stripe step (e.g. CALL_GRATUITA)

titlestring nullable

Success title (set only on instant confirmation)

Example response

{
  "amount": 4900,
  "checkout_url": "https://checkout.stripe.com/c/pay/cs_test_...",
  "currency": "eur",
  "expires_at": "2025-11-20T10:15:00+00:00",
  "payment_id": "123e4567-e89b-12d3-a456-426614174002"
}

Changes

  • babe5287135bRevision changes
    • info

      added the new optional request property

  • 4d74c6bc8ec1Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status