BokaMera.API.Host

<back to all web services

QvicklyV1CreateCheckout

The following routes are available for this service:
POST/payment/billmate/v1/checkoutCreate an checkout for Booking. Note if existing checkouts already exists, i will invalidate those.Create Qvickly checkout (requires settings for Billmat Checkout 1.0)
QvicklyV1CreateCheckout Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?YesThe company id.
BookingIdbodystringNoAn internal reference id (Could be booking, rebate code etc.)
InternalReferenceIdbodystringYesAn internal reference id (Could be booking, rebate code etc.)
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
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.
TestModebodyboolNoDetermins if it's a test call
ArticlesbodyArticleToCreate[]YesArticles (Could be Service, rebate code types, etc..
PaymentOrigin Enum:
HomePage
Embedded
Admin
Apps
HomePageNew
ArticleToCreate Parameters:
NameParameterData TypeRequiredDescription
ArticleIdformintNo
ArticleTypeIdformintNo
QuantityformintNo
QvicklyCheckoutQueryResponse Parameters:
NameParameterData TypeRequiredDescription
NumberformintNoThe checkout id
UrlformstringNoThe url for checkout module to be placed in a iframe
StatusformstringNoThe checkout status

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
Content-Length: length

{"Number":0,"Url":"String","Status":"String"}