BokaMera.API.Host

<back to all web services

PaysonV1CreateCheckout

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

public class dtos
{

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

        /**
        * Internal reference id (Could be booking, could be Article..)
        */
        @ApiMember(Description="Internal reference id (Could be booking, could be Article..)")
        public String InternalReferenceId = null;

        /**
        * The booking id.
        */
        @ApiMember(Description="The booking id.", IsRequired=true)
        public Integer BookingId = 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, 4 = HomePageNew
        */
        @ApiMember(Description="The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3, 4 = HomePageNew", 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;

        /**
        * 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;

        /**
        * Determins if it's a test call
        */
        @ApiMember(Description="Determins if it's a test call")
        public String TestMode = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public PaysonV1CreateCheckout setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getInternalReferenceId() { return InternalReferenceId; }
        public PaysonV1CreateCheckout setInternalReferenceId(String value) { this.InternalReferenceId = value; return this; }
        public Integer getBookingId() { return BookingId; }
        public PaysonV1CreateCheckout setBookingId(Integer value) { this.BookingId = value; return this; }
        public Uri getCheckoutUrl() { return CheckoutUrl; }
        public PaysonV1CreateCheckout setCheckoutUrl(Uri value) { this.CheckoutUrl = value; return this; }
        public Uri getConfirmationUrl() { return ConfirmationUrl; }
        public PaysonV1CreateCheckout setConfirmationUrl(Uri value) { this.ConfirmationUrl = value; return this; }
        public PaymentOrigin getPaymentOrigin() { return PaymentOrigin; }
        public PaysonV1CreateCheckout setPaymentOrigin(PaymentOrigin value) { this.PaymentOrigin = value; return this; }
        public String getLanguage() { return Language; }
        public PaysonV1CreateCheckout setLanguage(String value) { this.Language = value; return this; }
        public ArrayList<ArticleToCreate> getArticles() { return Articles; }
        public PaysonV1CreateCheckout setArticles(ArrayList<ArticleToCreate> value) { this.Articles = value; return this; }
        public String getTestMode() { return TestMode; }
        public PaysonV1CreateCheckout setTestMode(String value) { this.TestMode = 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 PaysonCheckoutV2Response
    {
        /**
        * The checkout id
        */
        @ApiMember(Description="The checkout id")
        public UUID Id = null;

        /**
        * The code snippet to for checkout module
        */
        @ApiMember(Description="The code snippet to for checkout module")
        public String Snippet = null;

        /**
        * The checkout status
        */
        @ApiMember(Description="The checkout status")
        public Payson2CheckoutStatus Status = null;
        
        public UUID getId() { return Id; }
        public PaysonCheckoutV2Response setId(UUID value) { this.Id = value; return this; }
        public String getSnippet() { return Snippet; }
        public PaysonCheckoutV2Response setSnippet(String value) { this.Snippet = value; return this; }
        public Payson2CheckoutStatus getStatus() { return Status; }
        public PaysonCheckoutV2Response setStatus(Payson2CheckoutStatus value) { this.Status = value; return this; }
    }

    public static enum Payson2CheckoutStatus
    {
        None,
        Created,
        FormsFilled,
        ReadyToPay,
        ProcessingPayment,
        ReadyToShip,
        Shipped,
        PaidToAccount,
        Canceled,
        Credited,
        Expired,
        Denied;
    }

}

Java PaysonV1CreateCheckout DTOs

POST /payment/payson/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","InternalReferenceId":"String","BookingId":0,"PaymentOrigin":"HomePage","Language":"String","Articles":[{"ArticleId":0,"ArticleTypeId":0,"Quantity":0}],"TestMode":"String"}

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

{"Snippet":"String","Status":"None"}