BokaMera.API.Host

PaysonV2CreateCheckout

The following routes are available for this service:
POST	/payment/payson/v2/checkout	Create an checkout for Booking. Note if existing checkouts already exists, i will invalidate those.	Create payson checkout (requires settings for Payson Checkout 2.0)

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


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

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

    /**
    * The reference id. (Could be booking, could be rebate code etc.)
    */
    @ApiMember(Description="The reference id. (Could be booking, could be 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

    /**
    * Country code for checkout
    */
    @ApiMember(Description="Country code for checkout", IsRequired=true)
    var CountryCode: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 PaysonCheckoutV2Response
{
    /**
    * The checkout id
    */
    @ApiMember(Description="The checkout id")
    var Id:UUID? = null

    /**
    * The code snippet to for checkout module
    */
    @ApiMember(Description="The code snippet to for checkout module")
    var Snippet:String? = null

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

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

Kotlin PaysonV2CreateCheckout 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/payson/v2/checkout HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PaysonV2CreateCheckout 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" />
  <CountryCode>String</CountryCode>
  <InternalReferenceId>String</InternalReferenceId>
  <Language>String</Language>
  <PaymentOrigin>HomePage</PaymentOrigin>
  <TestMode>false</TestMode>
</PaysonV2CreateCheckout>

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

<PaysonCheckoutV2Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Snippet>String</Snippet>
  <Status>None</Status>
</PaysonCheckoutV2Response>