BokaMera.API.Host

QvicklyV1CreateCheckout

The following routes are available for this service:
POST	/payment/billmate/v1/checkout	Create an checkout for Booking. Note if existing checkouts already exists, i will invalidate those.	Create Qvickly checkout (requires settings for Billmat Checkout 1.0)

"use strict";
export class QvicklyCheckoutQueryResponse {
    /** @param {{Number?:number,Url?:string,Status?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The checkout id */
    Number;
    /**
     * @type {string}
     * @description The url for checkout module to be placed in a iframe */
    Url;
    /**
     * @type {string}
     * @description The checkout status */
    Status;
}
/** @typedef {'HomePage'|'Embedded'|'Admin'|'Apps'|'HomePageNew'} */
export var PaymentOrigin;
(function (PaymentOrigin) {
    PaymentOrigin["HomePage"] = "HomePage"
    PaymentOrigin["Embedded"] = "Embedded"
    PaymentOrigin["Admin"] = "Admin"
    PaymentOrigin["Apps"] = "Apps"
    PaymentOrigin["HomePageNew"] = "HomePageNew"
})(PaymentOrigin || (PaymentOrigin = {}));
export class QvicklyV1CreateCheckout {
    /** @param {{CompanyId?:string,BookingId?:string,InternalReferenceId?:string,CheckoutUrl?:string,ConfirmationUrl?:string,PaymentOrigin?:PaymentOrigin,Language?:string,TestMode?:boolean,Articles?:ArticleToCreate[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company id. */
    CompanyId;
    /**
     * @type {string}
     * @description An internal reference id (Could be booking, rebate code etc.) */
    BookingId;
    /**
     * @type {string}
     * @description An internal reference id (Could be booking, rebate code etc.) */
    InternalReferenceId;
    /**
     * @type {string}
     * @description Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason. */
    CheckoutUrl;
    /**
     * @type {string}
     * @description Optional to set your own confirmation url after payment completed. */
    ConfirmationUrl;
    /**
     * @type {PaymentOrigin}
     * @description The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3 */
    PaymentOrigin;
    /**
     * @type {string}
     * @description If you want to have another language (sv, fi, dk, no, en) than the default language in system settings, specify it here. Leave empty if default language should be used. */
    Language;
    /**
     * @type {boolean}
     * @description Determins if it's a test call */
    TestMode;
    /**
     * @type {ArticleToCreate[]}
     * @description Articles (Could be Service, rebate code types, etc.. */
    Articles;
}
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 QvicklyV1CreateCheckout 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 /payment/billmate/v1/checkout HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","BookingId":"String","InternalReferenceId":"String","PaymentOrigin":"HomePage","Language":"String","TestMode":false,"Articles":[{"ArticleId":0,"ArticleTypeId":0,"Quantity":0}]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Number":0,"Url":"String","Status":"String"}