BokaMera.API.Host

QvicklyV1CreateCheckout

The following routes are available for this service:
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)

**QvicklyV1CreateCheckout** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	body	Guid?	Yes	The company id.
BookingId	body	string	No	An internal reference id (Could be booking, rebate code etc.)
InternalReferenceId	body	string	Yes	An internal reference id (Could be booking, rebate code etc.)
CheckoutUrl	body	Uri	No	Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason.
ConfirmationUrl	body	Uri	No	Optional to set your own confirmation url after payment completed.
PaymentOrigin	body	PaymentOrigin	Yes	The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3
Language	body	string	Yes	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.
TestMode	body	bool	No	Determins if it's a test call
Articles	body	ArticleToCreate[]	Yes	Articles (Could be Service, rebate code types, etc..

**PaymentOrigin** Enum:
HomePage
Embedded
Admin
Apps
HomePageNew

**ArticleToCreate** Parameters:
Name	Parameter	Data Type	Required
ArticleId	form	int	No
ArticleTypeId	form	int	No
Quantity	form	int	No

**QvicklyCheckoutQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Number	form	int	No	The checkout id
Url	form	string	No	The url for checkout module to be placed in a iframe
Status	form	string	No	The checkout status

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

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