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 'package:servicestack/servicestack.dart';

class ConfirmBookingReservationPaymentResponse implements IConvertible
{
    /**
    * The created booking id once the reservation was converted.
    */
    // @ApiMember(Description="The created booking id once the reservation was converted.")
    int? BookingId;

    /**
    * The BookingReservationStatus value after confirmation.
    */
    // @ApiMember(Description="The BookingReservationStatus value after confirmation.")
    int StatusCode = 0;

    /**
    * The BookingReservationStatus name after confirmation.
    */
    // @ApiMember(Description="The BookingReservationStatus name after confirmation.")
    String StatusName = "";

    /**
    * The verified final price of the reservation, if any.
    */
    // @ApiMember(Description="The verified final price of the reservation, if any.")
    double? Price;

    ResponseStatus ResponseStatus;

    ConfirmBookingReservationPaymentResponse({this.BookingId,this.StatusCode,this.StatusName,this.Price,this.ResponseStatus});
    ConfirmBookingReservationPaymentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        BookingId = json['BookingId'];
        StatusCode = json['StatusCode'];
        StatusName = json['StatusName'];
        Price = JsonConverters.toDouble(json['Price']);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'BookingId': BookingId,
        'StatusCode': StatusCode,
        'StatusName': StatusName,
        'Price': Price,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "ConfirmBookingReservationPaymentResponse";
    TypeContext? context = _ctx;
}

// @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)
class ConfirmBookingReservationPayment implements ICompany, IConvertible
{
    /**
    * The opaque session key that identifies the reservation.
    */
    // @ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")
    String SessionKey = "";

    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    String? CompanyId;

    /**
    * The id of the Stripe PaymentIntent the client has already confirmed for this reservation.
    */
    // @ApiMember(Description="The id of the Stripe PaymentIntent the client has already confirmed for this reservation.", IsRequired=true)
    String PaymentIntentId = "";

    ConfirmBookingReservationPayment({this.SessionKey,this.CompanyId,this.PaymentIntentId});
    ConfirmBookingReservationPayment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SessionKey = json['SessionKey'];
        CompanyId = json['CompanyId'];
        PaymentIntentId = json['PaymentIntentId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SessionKey': SessionKey,
        'CompanyId': CompanyId,
        'PaymentIntentId': PaymentIntentId
    };

    getTypeName() => "ConfirmBookingReservationPayment";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'ConfirmBookingReservationPaymentResponse': TypeInfo(TypeOf.Class, create:() => ConfirmBookingReservationPaymentResponse()),
    'ConfirmBookingReservationPayment': TypeInfo(TypeOf.Class, create:() => ConfirmBookingReservationPayment()),
});

Dart ConfirmBookingReservationPayment DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ConfirmBookingReservationPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <PaymentIntentId>String</PaymentIntentId>
  <SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
</ConfirmBookingReservationPayment>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ConfirmBookingReservationPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>0</BookingId>
  <Price>0</Price>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <StatusCode>0</StatusCode>
  <StatusName>String</StatusName>
</ConfirmBookingReservationPaymentResponse>