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)
import 'package:servicestack/servicestack.dart';

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

class PaysonCheckoutV2Response implements IConvertible
{
    /**
    * The checkout id
    */
    // @ApiMember(Description="The checkout id")
    String? Id;

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

    /**
    * The checkout status
    */
    // @ApiMember(Description="The checkout status")
    Payson2CheckoutStatus? Status;

    PaysonCheckoutV2Response({this.Id,this.Snippet,this.Status});
    PaysonCheckoutV2Response.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Snippet = json['Snippet'];
        Status = JsonConverters.fromJson(json['Status'],'Payson2CheckoutStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Snippet': Snippet,
        'Status': JsonConverters.toJson(Status,'Payson2CheckoutStatus',context!)
    };

    getTypeName() => "PaysonCheckoutV2Response";
    TypeContext? context = _ctx;
}

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

class ArticleToCreate implements IConvertible
{
    int? ArticleId;
    int? ArticleTypeId;
    int? Quantity;

    ArticleToCreate({this.ArticleId,this.ArticleTypeId,this.Quantity});
    ArticleToCreate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ArticleId = json['ArticleId'];
        ArticleTypeId = json['ArticleTypeId'];
        Quantity = json['Quantity'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ArticleId': ArticleId,
        'ArticleTypeId': ArticleTypeId,
        'Quantity': Quantity
    };

    getTypeName() => "ArticleToCreate";
    TypeContext? context = _ctx;
}

class PaysonV2CreateCheckout implements ICompany, IConvertible
{
    /**
    * The company id.
    */
    // @ApiMember(Description="The company id.", IsRequired=true)
    String? CompanyId;

    /**
    * 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)
    String? InternalReferenceId;

    /**
    * 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.")
    Uri? CheckoutUrl;

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

    /**
    * 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)
    PaymentOrigin? PaymentOrigin;

    /**
    * 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)
    String? Language;

    /**
    * Country code for checkout
    */
    // @ApiMember(Description="Country code for checkout", IsRequired=true)
    String? CountryCode;

    /**
    * Determins if it's a test call
    */
    // @ApiMember(Description="Determins if it's a test call")
    bool? TestMode;

    /**
    * Articles (Could be Service, rebate code types, etc..
    */
    // @ApiMember(Description="Articles (Could be Service, rebate code types, etc..", IsRequired=true)
    List<ArticleToCreate>? Articles;

    PaysonV2CreateCheckout({this.CompanyId,this.InternalReferenceId,this.CheckoutUrl,this.ConfirmationUrl,this.PaymentOrigin,this.Language,this.CountryCode,this.TestMode,this.Articles});
    PaysonV2CreateCheckout.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        InternalReferenceId = json['InternalReferenceId'];
        CheckoutUrl = JsonConverters.fromJson(json['CheckoutUrl'],'Uri',context!);
        ConfirmationUrl = JsonConverters.fromJson(json['ConfirmationUrl'],'Uri',context!);
        PaymentOrigin = JsonConverters.fromJson(json['PaymentOrigin'],'PaymentOrigin',context!);
        Language = json['Language'];
        CountryCode = json['CountryCode'];
        TestMode = json['TestMode'];
        Articles = JsonConverters.fromJson(json['Articles'],'List<ArticleToCreate>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'InternalReferenceId': InternalReferenceId,
        'CheckoutUrl': JsonConverters.toJson(CheckoutUrl,'Uri',context!),
        'ConfirmationUrl': JsonConverters.toJson(ConfirmationUrl,'Uri',context!),
        'PaymentOrigin': JsonConverters.toJson(PaymentOrigin,'PaymentOrigin',context!),
        'Language': Language,
        'CountryCode': CountryCode,
        'TestMode': TestMode,
        'Articles': JsonConverters.toJson(Articles,'List<ArticleToCreate>',context!)
    };

    getTypeName() => "PaysonV2CreateCheckout";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'Payson2CheckoutStatus': TypeInfo(TypeOf.Enum, enumValues:Payson2CheckoutStatus.values),
    'PaysonCheckoutV2Response': TypeInfo(TypeOf.Class, create:() => PaysonCheckoutV2Response()),
    'PaymentOrigin': TypeInfo(TypeOf.Enum, enumValues:PaymentOrigin.values),
    'ArticleToCreate': TypeInfo(TypeOf.Class, create:() => ArticleToCreate()),
    'PaysonV2CreateCheckout': TypeInfo(TypeOf.Class, create:() => PaysonV2CreateCheckout()),
    'Uri': TypeInfo(TypeOf.Class, create:() => Uri()),
    'List<ArticleToCreate>': TypeInfo(TypeOf.Class, create:() => <ArticleToCreate>[]),
});

Dart 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: testapi.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>
  <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>