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)

import java.math.*
import java.util.*
import net.servicestack.client.*


open class QvicklyV1CreateCheckout : ICompany
{
    /**
    * The company id.
    */
    @ApiMember(Description="The company id.", IsRequired=true)
    var CompanyId:UUID? = null

    /**
    * An internal reference id (Could be booking, rebate code etc.)
    */
    @ApiMember(Description="An internal reference id (Could be booking, rebate code etc.)")
    var BookingId:String? = null

    /**
    * An internal reference id (Could be booking, rebate code etc.)
    */
    @ApiMember(Description="An internal reference id (Could be booking, rebate code etc.)", IsRequired=true)
    var InternalReferenceId:String? = null

    /**
    * Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason.
    */
    @ApiMember(Description="Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason.")
    var CheckoutUrl:Uri? = null

    /**
    * Optional to set your own confirmation url after payment completed.
    */
    @ApiMember(Description="Optional to set your own confirmation url after payment completed.")
    var ConfirmationUrl:Uri? = null

    /**
    * The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3
    */
    @ApiMember(Description="The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3", IsRequired=true)
    var PaymentOrigin:PaymentOrigin? = null

    /**
    * 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.
    */
    @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)
    var Language:String? = null

    /**
    * Determins if it's a test call
    */
    @ApiMember(Description="Determins if it's a test call")
    var TestMode:Boolean? = null

    /**
    * Articles (Could be Service, rebate code types, etc..
    */
    @ApiMember(Description="Articles (Could be Service, rebate code types, etc..", IsRequired=true)
    var Articles:ArrayList<ArticleToCreate>? = null
}

enum class PaymentOrigin
{
    HomePage,
    Embedded,
    Admin,
    Apps,
    HomePageNew,
}

open class ArticleToCreate
{
    var ArticleId:Int? = null
    var ArticleTypeId:Int? = null
    var Quantity:Int? = null
}

open class QvicklyCheckoutQueryResponse
{
    /**
    * The checkout id
    */
    @ApiMember(Description="The checkout id")
    var Number:Int? = null

    /**
    * The url for checkout module to be placed in a iframe
    */
    @ApiMember(Description="The url for checkout module to be placed in a iframe")
    var Url:String? = null

    /**
    * The checkout status
    */
    @ApiMember(Description="The checkout status")
    var Status:String? = null
}

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