| 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 Foundation
import ServiceStack
public class QvicklyV1CreateCheckout : ICompany, Codable
{
/**
* The company id.
*/
// @ApiMember(Description="The company id.", IsRequired=true)
public var companyId:String?
/**
* An internal reference id (Could be booking, rebate code etc.)
*/
// @ApiMember(Description="An internal reference id (Could be booking, rebate code etc.)")
public var bookingId:String
/**
* An internal reference id (Could be booking, rebate code etc.)
*/
// @ApiMember(Description="An internal reference id (Could be booking, rebate code etc.)", IsRequired=true)
public var internalReferenceId:String
/**
* 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 var checkoutUrl:Uri
/**
* Optional to set your own confirmation url after payment completed.
*/
// @ApiMember(Description="Optional to set your own confirmation url after payment completed.")
public var confirmationUrl:Uri
/**
* 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)
public var 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)
public var language:String
/**
* Determins if it's a test call
*/
// @ApiMember(Description="Determins if it's a test call")
public var testMode:Bool
/**
* Articles (Could be Service, rebate code types, etc..
*/
// @ApiMember(Description="Articles (Could be Service, rebate code types, etc..", IsRequired=true)
public var articles:[ArticleToCreate] = []
required public init(){}
}
public enum PaymentOrigin : String, Codable
{
case HomePage
case Embedded
case Admin
case Apps
case HomePageNew
}
public class ArticleToCreate : Codable
{
public var articleId:Int
public var articleTypeId:Int
public var quantity:Int
required public init(){}
}
public class QvicklyCheckoutQueryResponse : Codable
{
/**
* The checkout id
*/
// @ApiMember(Description="The checkout id")
public var number:Int
/**
* The url for checkout module to be placed in a iframe
*/
// @ApiMember(Description="The url for checkout module to be placed in a iframe")
public var url:String
/**
* The checkout status
*/
// @ApiMember(Description="The checkout status")
public var status:String
required public init(){}
}
Swift QvicklyV1CreateCheckout DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","BookingId":"String","InternalReferenceId":"String","PaymentOrigin":"HomePage","Language":"String","TestMode":false,"Articles":[{"ArticleId":0,"ArticleTypeId":0,"Quantity":0}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Number":0,"Url":"String","Status":"String"}