BokaMera.API.Host

<back to all web services

QvicklyV1CreateCheckout

The following routes are available for this service:
POST/payment/billmate/v1/checkoutCreate 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.*;

public class dtos
{

    public static class QvicklyV1CreateCheckout implements ICompany
    {
        /**
        * The company id.
        */
        @ApiMember(Description="The company id.", IsRequired=true)
        public UUID CompanyId = null;

        /**
        * An internal reference id (Could be booking, rebate code etc.)
        */
        @ApiMember(Description="An internal reference id (Could be booking, rebate code etc.)")
        public String BookingId = 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)
        public String InternalReferenceId = 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.")
        public Uri CheckoutUrl = null;

        /**
        * Optional to set your own confirmation url after payment completed.
        */
        @ApiMember(Description="Optional to set your own confirmation url after payment completed.")
        public Uri ConfirmationUrl = 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)
        public 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)
        public String Language = null;

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

        /**
        * Articles (Could be Service, rebate code types, etc..
        */
        @ApiMember(Description="Articles (Could be Service, rebate code types, etc..", IsRequired=true)
        public ArrayList<ArticleToCreate> Articles = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public QvicklyV1CreateCheckout setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getBookingId() { return BookingId; }
        public QvicklyV1CreateCheckout setBookingId(String value) { this.BookingId = value; return this; }
        public String getInternalReferenceId() { return InternalReferenceId; }
        public QvicklyV1CreateCheckout setInternalReferenceId(String value) { this.InternalReferenceId = value; return this; }
        public Uri getCheckoutUrl() { return CheckoutUrl; }
        public QvicklyV1CreateCheckout setCheckoutUrl(Uri value) { this.CheckoutUrl = value; return this; }
        public Uri getConfirmationUrl() { return ConfirmationUrl; }
        public QvicklyV1CreateCheckout setConfirmationUrl(Uri value) { this.ConfirmationUrl = value; return this; }
        public PaymentOrigin getPaymentOrigin() { return PaymentOrigin; }
        public QvicklyV1CreateCheckout setPaymentOrigin(PaymentOrigin value) { this.PaymentOrigin = value; return this; }
        public String getLanguage() { return Language; }
        public QvicklyV1CreateCheckout setLanguage(String value) { this.Language = value; return this; }
        public Boolean isTestMode() { return TestMode; }
        public QvicklyV1CreateCheckout setTestMode(Boolean value) { this.TestMode = value; return this; }
        public ArrayList<ArticleToCreate> getArticles() { return Articles; }
        public QvicklyV1CreateCheckout setArticles(ArrayList<ArticleToCreate> value) { this.Articles = value; return this; }
    }

    public static enum PaymentOrigin
    {
        HomePage,
        Embedded,
        Admin,
        Apps,
        HomePageNew;
    }

    public static class ArticleToCreate
    {
        public Integer ArticleId = null;
        public Integer ArticleTypeId = null;
        public Integer Quantity = null;
        
        public Integer getArticleId() { return ArticleId; }
        public ArticleToCreate setArticleId(Integer value) { this.ArticleId = value; return this; }
        public Integer getArticleTypeId() { return ArticleTypeId; }
        public ArticleToCreate setArticleTypeId(Integer value) { this.ArticleTypeId = value; return this; }
        public Integer getQuantity() { return Quantity; }
        public ArticleToCreate setQuantity(Integer value) { this.Quantity = value; return this; }
    }

    public static class QvicklyCheckoutQueryResponse
    {
        /**
        * The checkout id
        */
        @ApiMember(Description="The checkout id")
        public Integer Number = 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")
        public String Url = null;

        /**
        * The checkout status
        */
        @ApiMember(Description="The checkout status")
        public String Status = null;
        
        public Integer getNumber() { return Number; }
        public QvicklyCheckoutQueryResponse setNumber(Integer value) { this.Number = value; return this; }
        public String getUrl() { return Url; }
        public QvicklyCheckoutQueryResponse setUrl(String value) { this.Url = value; return this; }
        public String getStatus() { return Status; }
        public QvicklyCheckoutQueryResponse setStatus(String value) { this.Status = value; return this; }
    }

}

Java QvicklyV1CreateCheckout DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
Content-Length: length

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