BokaMera.API.Host

<back to all web services

ConfirmBookingReservationPayment

The following routes are available for this service:
POST/bookingreservations/{SessionKey}/confirmpaymentConfirm a booking reservation payment (synchronous book-and-pay)Verifies a client-confirmed Stripe PaymentIntent server-side and converts the AwaitingPayment reservation into a booking in the same request, returning the created BookingId immediately instead of waiting for the Stripe webhook. Idempotent: replaying the call for an already-converted reservation returns the same BookingId. If the slot was lost between capture and convert the captured payment is refunded.
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConfirmBookingReservationPaymentResponse:
    # @ApiMember(Description="The created booking id once the reservation was converted.")
    booking_id: Optional[int] = None
    """
    The created booking id once the reservation was converted.
    """


    # @ApiMember(Description="The BookingReservationStatus value after confirmation.")
    status_code: int = 0
    """
    The BookingReservationStatus value after confirmation.
    """


    # @ApiMember(Description="The BookingReservationStatus name after confirmation.")
    status_name: Optional[str] = None
    """
    The BookingReservationStatus name after confirmation.
    """


    # @ApiMember(Description="The verified final price of the reservation, if any.")
    price: Optional[Decimal] = None
    """
    The verified final price of the reservation, if any.
    """


    response_status: Optional[ResponseStatus] = None


# @ApiResponse(Description="No reservation found for the given session key", StatusCode=404)
# @ApiResponse(Description="The payment could not be verified or the captured amount did not match", StatusCode=400)
# @ApiResponse(Description="The selected slot is no longer available; the payment was refunded", StatusCode=409)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConfirmBookingReservationPayment(ICompany):
    # @ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")
    session_key: Optional[str] = None
    """
    The opaque session key that identifies the reservation.
    """


    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(Description="The id of the Stripe PaymentIntent the client has already confirmed for this reservation.", IsRequired=true)
    payment_intent_id: Optional[str] = None
    """
    The id of the Stripe PaymentIntent the client has already confirmed for this reservation.
    """

Python ConfirmBookingReservationPayment DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /bookingreservations/{SessionKey}/confirmpayment HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	PaymentIntentId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	BookingId: 0,
	StatusCode: 0,
	StatusName: String,
	Price: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}