BokaMera.API.Host

<back to all web services

PaysonV2CreateCheckout

The following routes are available for this service:
POST/payment/payson/v2/checkoutCreate an checkout for Booking. Note if existing checkouts already exists, i will invalidate those.Create payson checkout (requires settings for Payson Checkout 2.0)
PaysonV2CreateCheckout Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?YesThe company id.
BookingIdbodystringNoThe reference id. (Could be booking, could be rebate code etc.)
InternalReferenceIdbodystringYesThe reference id. (Could be booking, could be 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.
CountryCodebodystringYesCountry code for checkout
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
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 .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/payson/v2/checkout HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PaysonV2CreateCheckout 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" />
  <CountryCode>String</CountryCode>
  <InternalReferenceId>String</InternalReferenceId>
  <Language>String</Language>
  <PaymentOrigin>HomePage</PaymentOrigin>
  <TestMode>false</TestMode>
</PaysonV2CreateCheckout>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaysonCheckoutV2Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Snippet>String</Snippet>
  <Status>None</Status>
</PaysonCheckoutV2Response>