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.
// @ts-nocheck

export class ConfirmBookingReservationPaymentResponse
{
    /** @description The created booking id once the reservation was converted. */
    // @ApiMember(Description="The created booking id once the reservation was converted.")
    public BookingId?: number;

    /** @description The BookingReservationStatus value after confirmation. */
    // @ApiMember(Description="The BookingReservationStatus value after confirmation.")
    public StatusCode: number;

    /** @description The BookingReservationStatus name after confirmation. */
    // @ApiMember(Description="The BookingReservationStatus name after confirmation.")
    public StatusName: string;

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

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<ConfirmBookingReservationPaymentResponse>) { (Object as any).assign(this, init); }
}

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

    /** @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.")
    public CompanyId?: string;

    /** @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)
    public PaymentIntentId: string;

    public constructor(init?: Partial<ConfirmBookingReservationPayment>) { (Object as any).assign(this, init); }
}

TypeScript ConfirmBookingReservationPayment DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"CompanyId":"00000000-0000-0000-0000-000000000000","PaymentIntentId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}