BokaMera.API.Host

<back to all web services

PaysonV2CreateCheckout

The following routes are available for this service:
POST/payment/payson/v2/checkoutCreate an checkout for Booking. Note if existing checkouts already exists, i will invalidate those.Create payson checkout (requires settings for Payson Checkout 2.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;
using PaysonIntegrationCO2.Models.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 PaysonCheckoutV2Response
    {
        ///<summary>
        ///The checkout id
        ///</summary>
        [ApiMember(Description="The checkout id")]
        public virtual Guid Id { get; set; }

        ///<summary>
        ///The code snippet to for checkout module
        ///</summary>
        [ApiMember(Description="The code snippet to for checkout module")]
        public virtual string Snippet { get; set; }

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

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

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

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

        ///<summary>
        ///The reference id. (Could be booking, could be rebate code etc.)
        ///</summary>
        [ApiMember(Description="The reference id. (Could be booking, could be 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>
        ///Country code for checkout
        ///</summary>
        [ApiMember(Description="Country code for checkout", IsRequired=true)]
        public virtual string CountryCode { 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,
    }

}

namespace PaysonIntegrationCO2.Models.Enums
{
    public enum Payson2CheckoutStatus
    {
        None,
        Created,
        FormsFilled,
        ReadyToPay,
        ProcessingPayment,
        ReadyToShip,
        Shipped,
        PaidToAccount,
        Canceled,
        Credited,
        Expired,
        Denied,
    }

}

C# PaysonV2CreateCheckout DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payment/payson/v2/checkout HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	BookingId: String,
	InternalReferenceId: String,
	PaymentOrigin: HomePage,
	Language: String,
	CountryCode: String,
	TestMode: False,
	Articles: 
	[
		{
			ArticleId: 0,
			ArticleTypeId: 0,
			Quantity: 0
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Snippet: String,
	Status: None
}