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)

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Enums;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class ArticleToCreate
    {
        public virtual int ArticleId { get; set; }
        public virtual int ArticleTypeId { get; set; }
        public virtual int Quantity { get; set; }
    }

    public partial class QvicklyCheckoutQueryResponse
    {
        ///<summary>
        ///The checkout id
        ///</summary>
        [ApiMember(Description="The checkout id")]
        public virtual int Number { get; set; }

        ///<summary>
        ///The url for checkout module to be placed in a iframe
        ///</summary>
        [ApiMember(Description="The url for checkout module to be placed in a iframe")]
        public virtual string Url { get; set; }

        ///<summary>
        ///The checkout status
        ///</summary>
        [ApiMember(Description="The checkout status")]
        public virtual string Status { get; set; }
    }

    public partial class QvicklyV1CreateCheckout
        : ICompany
    {
        public QvicklyV1CreateCheckout()
        {
            Articles = new ArticleToCreate[]{};
        }

        ///<summary>
        ///The company id.
        ///</summary>
        [ApiMember(Description="The company id.", IsRequired=true)]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///An internal reference id (Could be booking, rebate code etc.)
        ///</summary>
        [ApiMember(Description="An internal reference id (Could be booking, rebate code etc.)")]
        public virtual string BookingId { get; set; }

        ///<summary>
        ///An internal reference id (Could be booking, rebate code etc.)
        ///</summary>
        [ApiMember(Description="An internal reference id (Could be booking, rebate code etc.)", IsRequired=true)]
        public virtual string InternalReferenceId { get; set; }

        ///<summary>
        ///Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason.
        ///</summary>
        [ApiMember(Description="Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason.")]
        public virtual Uri CheckoutUrl { get; set; }

        ///<summary>
        ///Optional to set your own confirmation url after payment completed.
        ///</summary>
        [ApiMember(Description="Optional to set your own confirmation url after payment completed.")]
        public virtual Uri ConfirmationUrl { get; set; }

        ///<summary>
        ///The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3
        ///</summary>
        [ApiMember(Description="The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3", IsRequired=true)]
        public virtual PaymentOrigin PaymentOrigin { get; set; }

        ///<summary>
        ///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.
        ///</summary>
        [ApiMember(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.", IsRequired=true)]
        public virtual string Language { get; set; }

        ///<summary>
        ///Determins if it's a test call
        ///</summary>
        [ApiMember(Description="Determins if it's a test call")]
        public virtual bool TestMode { get; set; }

        ///<summary>
        ///Articles (Could be Service, rebate code types, etc..
        ///</summary>
        [ApiMember(Description="Articles (Could be Service, rebate code types, etc..", IsRequired=true)]
        public virtual ArticleToCreate[] Articles { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Enums
{
    public enum PaymentOrigin
    {
        HomePage,
        Embedded,
        Admin,
        Apps,
        HomePageNew,
    }

}

C# QvicklyV1CreateCheckout 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 /payment/billmate/v1/checkout HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QvicklyV1CreateCheckout xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Articles>
    <ArticleToCreate>
      <ArticleId>0</ArticleId>
      <ArticleTypeId>0</ArticleTypeId>
      <Quantity>0</Quantity>
    </ArticleToCreate>
  </Articles>
  <BookingId>String</BookingId>
  <CheckoutUrl i:nil="true" />
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ConfirmationUrl i:nil="true" />
  <InternalReferenceId>String</InternalReferenceId>
  <Language>String</Language>
  <PaymentOrigin>HomePage</PaymentOrigin>
  <TestMode>false</TestMode>
</QvicklyV1CreateCheckout>

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

<QvicklyCheckoutQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Number>0</Number>
  <Status>String</Status>
  <Url>String</Url>
</QvicklyCheckoutQueryResponse>