BokaMera.API.Host

<back to all web services

PaysonV1CreateCheckout

The following routes are available for this service:
POST/payment/payson/v1/checkoutCreate an checkout for Booking. Note if existing checkouts already exists, i will invalidate those.Create payson checkout (requires settings for Payson Checkout 1.0)
PaysonV1CreateCheckout Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?YesThe company id.
InternalReferenceIdbodystringNoInternal reference id (Could be booking, could be Article..)
BookingIdbodyintYesThe booking id.
CheckoutUrlbodyUriNoOptional to set the checkout url. This url will be redirected to if payment is interupted for some reason.
ConfirmationUrlbodyUriNoOptional to set your own confirmation url after payment completed.
PaymentOriginbodyPaymentOriginYesThe payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3, 4 = HomePageNew
LanguagebodystringYesIf 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.
ArticlesbodyArticleToCreate[]YesArticles (Could be Service, rebate code types, etc..
TestModebodystringNoDetermins if it's a test call
PaymentOrigin Enum:
HomePage
Embedded
Admin
Apps
HomePageNew
ArticleToCreate Parameters:
NameParameterData TypeRequiredDescription
ArticleIdformintNo
ArticleTypeIdformintNo
QuantityformintNo
PaysonCheckoutV2Response Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNoThe checkout id
SnippetformstringNoThe code snippet to for checkout module
StatusformPayson2CheckoutStatusNoThe checkout status
Payson2CheckoutStatus Enum:
None
Created
FormsFilled
ReadyToPay
ProcessingPayment
ReadyToShip
Shipped
PaidToAccount
Canceled
Credited
Expired
Denied

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
}