| POST | /payment/payson/v1/checkout | Create an checkout for Booking. Note if existing checkouts already exists, i will invalidate those. | Create payson checkout (requires settings for Payson Checkout 1.0) |
|---|
import Foundation
import ServiceStack
public class PaysonV1CreateCheckout : ICompany, Codable
{
/**
* The company id.
*/
// @ApiMember(Description="The company id.", IsRequired=true)
public var companyId:String?
/**
* Internal reference id (Could be booking, could be Article..)
*/
// @ApiMember(Description="Internal reference id (Could be booking, could be Article..)")
public var internalReferenceId:String
/**
* The booking id.
*/
// @ApiMember(Description="The booking id.", IsRequired=true)
public var bookingId:Int
/**
* 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, 4 = HomePageNew
*/
// @ApiMember(Description="The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3, 4 = HomePageNew", 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
/**
* Articles (Could be Service, rebate code types, etc..
*/
// @ApiMember(Description="Articles (Could be Service, rebate code types, etc..", IsRequired=true)
public var articles:[ArticleToCreate] = []
/**
* Determins if it's a test call
*/
// @ApiMember(Description="Determins if it's a test call")
public var testMode:String
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 PaysonCheckoutV2Response : Codable
{
/**
* The checkout id
*/
// @ApiMember(Description="The checkout id")
public var id:String
/**
* The code snippet to for checkout module
*/
// @ApiMember(Description="The code snippet to for checkout module")
public var snippet:String
/**
* The checkout status
*/
// @ApiMember(Description="The checkout status")
public var status:Payson2CheckoutStatus
required public init(){}
}
public enum Payson2CheckoutStatus : String, Codable
{
case None
case Created
case FormsFilled
case ReadyToPay
case ProcessingPayment
case ReadyToShip
case Shipped
case PaidToAccount
case Canceled
case Credited
case Expired
case Denied
}
Swift PaysonV1CreateCheckout DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /payment/payson/v1/checkout HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
InternalReferenceId: String,
BookingId: 0,
PaymentOrigin: HomePage,
Language: String,
Articles:
[
{
ArticleId: 0,
ArticleTypeId: 0,
Quantity: 0
}
],
TestMode: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Snippet: String,
Status: None
}