| POST | /payment/billmate/v1/checkout | Create 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 'package:servicestack/servicestack.dart';
class QvicklyCheckoutQueryResponse implements IConvertible
{
/**
* The checkout id
*/
// @ApiMember(Description="The checkout id")
int? Number;
/**
* The url for checkout module to be placed in a iframe
*/
// @ApiMember(Description="The url for checkout module to be placed in a iframe")
String? Url;
/**
* The checkout status
*/
// @ApiMember(Description="The checkout status")
String? Status;
QvicklyCheckoutQueryResponse({this.Number,this.Url,this.Status});
QvicklyCheckoutQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Number = json['Number'];
Url = json['Url'];
Status = json['Status'];
return this;
}
Map<String, dynamic> toJson() => {
'Number': Number,
'Url': Url,
'Status': Status
};
getTypeName() => "QvicklyCheckoutQueryResponse";
TypeContext? context = _ctx;
}
enum PaymentOrigin
{
HomePage,
Embedded,
Admin,
Apps,
HomePageNew,
}
class QvicklyV1CreateCheckout implements ICompany, IConvertible
{
/**
* The company id.
*/
// @ApiMember(Description="The company id.", IsRequired=true)
String? CompanyId;
/**
* An internal reference id (Could be booking, rebate code etc.)
*/
// @ApiMember(Description="An internal reference id (Could be booking, rebate code etc.)")
String? BookingId;
/**
* An internal reference id (Could be booking, rebate code etc.)
*/
// @ApiMember(Description="An internal reference id (Could be booking, 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;
/**
* 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;
QvicklyV1CreateCheckout({this.CompanyId,this.BookingId,this.InternalReferenceId,this.CheckoutUrl,this.ConfirmationUrl,this.PaymentOrigin,this.Language,this.TestMode,this.Articles});
QvicklyV1CreateCheckout.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
BookingId = json['BookingId'];
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'];
TestMode = json['TestMode'];
Articles = JsonConverters.fromJson(json['Articles'],'List<ArticleToCreate>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'BookingId': BookingId,
'InternalReferenceId': InternalReferenceId,
'CheckoutUrl': JsonConverters.toJson(CheckoutUrl,'Uri',context!),
'ConfirmationUrl': JsonConverters.toJson(ConfirmationUrl,'Uri',context!),
'PaymentOrigin': JsonConverters.toJson(PaymentOrigin,'PaymentOrigin',context!),
'Language': Language,
'TestMode': TestMode,
'Articles': JsonConverters.toJson(Articles,'List<ArticleToCreate>',context!)
};
getTypeName() => "QvicklyV1CreateCheckout";
TypeContext? context = _ctx;
}
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;
}
TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
'QvicklyCheckoutQueryResponse': TypeInfo(TypeOf.Class, create:() => QvicklyCheckoutQueryResponse()),
'PaymentOrigin': TypeInfo(TypeOf.Enum, enumValues:PaymentOrigin.values),
'QvicklyV1CreateCheckout': TypeInfo(TypeOf.Class, create:() => QvicklyV1CreateCheckout()),
'Uri': TypeInfo(TypeOf.Class, create:() => Uri()),
'List<ArticleToCreate>': TypeInfo(TypeOf.Class, create:() => <ArticleToCreate>[]),
'ArticleToCreate': TypeInfo(TypeOf.Class, create:() => ArticleToCreate()),
});
Dart QvicklyV1CreateCheckout DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<QvicklyV1CreateCheckout 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" />
<InternalReferenceId>String</InternalReferenceId>
<Language>String</Language>
<PaymentOrigin>HomePage</PaymentOrigin>
<TestMode>false</TestMode>
</QvicklyV1CreateCheckout>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QvicklyCheckoutQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <Number>0</Number> <Status>String</Status> <Url>String</Url> </QvicklyCheckoutQueryResponse>