BokaMera.API.Host

<back to all web services

CreateStripeCheckoutEmbeddedSessionV1

The following routes are available for this service:
POST/payment/stripe/v1/checkoutCreate an checkout for Payble entity. Note if existing checkouts already exists, it will invalidate those.Create Stripe checkout (requires settings for Stripe Checkout 1.0)
CreateStripeCheckoutEmbeddedSessionV1 Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?YesThe company id.
CountryCodebodystringYesCountry code for checkout
ArticlesbodyArticleToCreate[]YesArticles (Could be Service, rebate code types, etc..
InternalReferenceIdbodystringYesAn internal reference id (Could be booking, rebate code etc.)
ArticleToCreate Parameters:
NameParameterData TypeRequiredDescription
ArticleIdformintNo
ArticleTypeIdformintNo
QuantityformintNo
StripeCheckoutQueryResponse Parameters:
NameParameterData TypeRequiredDescription
NumberformstringNoThe checkout session 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 .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/stripe/v1/checkout HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateStripeCheckoutEmbeddedSessionV1 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>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CountryCode>String</CountryCode>
  <InternalReferenceId>String</InternalReferenceId>
</CreateStripeCheckoutEmbeddedSessionV1>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StripeCheckoutQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Number>String</Number>
  <Status>String</Status>
  <Url>String</Url>
</StripeCheckoutQueryResponse>