BokaMera.API.Host

StripeV1CreateCheckout

The following routes are available for this service:
POST	/payment/stripe/v1/checkout	Create an checkout for Payble entity. Note if existing checkouts already exists, it will invalidate those.	Create Stripe checkout (requires settings for Stripe Checkout 1.0)

"use strict";
export class StripeCheckoutQueryResponse {
    /** @param {{Number?:string,Url?:string,Status?:string,ClientSecret?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The checkout session id */
    Number;
    /**
     * @type {string}
     * @description The url for checkout module to be placed in a iframe */
    Url;
    /**
     * @type {string}
     * @description The checkout status */
    Status;
    /**
     * @type {string}
     * @description Client secret to be used when initializing Stripe.js embedded checkout. */
    ClientSecret;
}
export class StripeV1CreateCheckout {
    /** @param {{CompanyId?:string,CountryCode?:string,Articles?:ArticleToCreate[],InternalReferenceId?:string,ConfirmationUrl?:string,CancelUrl?:string,UiMode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company id. */
    CompanyId;
    /**
     * @type {string}
     * @description Country code for checkout */
    CountryCode;
    /**
     * @type {ArticleToCreate[]}
     * @description Articles (Could be Service, rebate code types, etc.. */
    Articles;
    /**
     * @type {string}
     * @description An internal reference id (Could be booking, rebate code etc.) */
    InternalReferenceId;
    /**
     * @type {string}
     * @description Optional to set your own confirmation url after payment completed. */
    ConfirmationUrl;
    /**
     * @type {string}
     * @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is <c>embedded</c>. */
    CancelUrl;
    /**
     * @type {string}
     * @description The UI mode of the Session. Defaults to <c>hosted</c>; One of: <c>embedded</c>, or <c>hosted</c> */
    UiMode;
}
export class ArticleToCreate {
    /** @param {{ArticleId?:number,ArticleTypeId?:number,Quantity?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ArticleId;
    /** @type {number} */
    ArticleTypeId;
    /** @type {number} */
    Quantity;
}

JavaScript StripeV1CreateCheckout 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 /payment/stripe/v1/checkout HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	CountryCode: String,
	Articles: 
	[
		{
			ArticleId: 0,
			ArticleTypeId: 0,
			Quantity: 0
		}
	],
	InternalReferenceId: String,
	ConfirmationUrl: String,
	CancelUrl: String,
	UiMode: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Number: String,
	Url: String,
	Status: String,
	ClientSecret: String
}