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.
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class ConfirmBookingReservationPaymentResponse implements JsonSerializable
{
    public function __construct(
        /** @description The created booking id once the reservation was converted. */
        // @ApiMember(Description="The created booking id once the reservation was converted.")
        /** @var int|null */
        public ?int $BookingId=null,

        /** @description The BookingReservationStatus value after confirmation. */
        // @ApiMember(Description="The BookingReservationStatus value after confirmation.")
        /** @var int */
        public int $StatusCode=0,

        /** @description The BookingReservationStatus name after confirmation. */
        // @ApiMember(Description="The BookingReservationStatus name after confirmation.")
        /** @var string */
        public string $StatusName='',

        /** @description The verified final price of the reservation, if any. */
        // @ApiMember(Description="The verified final price of the reservation, if any.")
        /** @var float|null */
        public ?float $Price=null,

        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['BookingId'])) $this->BookingId = $o['BookingId'];
        if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
        if (isset($o['StatusName'])) $this->StatusName = $o['StatusName'];
        if (isset($o['Price'])) $this->Price = $o['Price'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->BookingId)) $o['BookingId'] = $this->BookingId;
        if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
        if (isset($this->StatusName)) $o['StatusName'] = $this->StatusName;
        if (isset($this->Price)) $o['Price'] = $this->Price;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @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, JsonSerializable
{
    public function __construct(
        /** @description The opaque session key that identifies the reservation. */
        // @ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")
        /** @var string */
        public string $SessionKey='',

        /** @description 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.")
        /** @var string|null */
        public ?string $CompanyId=null,

        /** @description 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)
        /** @var string */
        public string $PaymentIntentId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SessionKey'])) $this->SessionKey = $o['SessionKey'];
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['PaymentIntentId'])) $this->PaymentIntentId = $o['PaymentIntentId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SessionKey)) $o['SessionKey'] = $this->SessionKey;
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->PaymentIntentId)) $o['PaymentIntentId'] = $this->PaymentIntentId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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>