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 .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/stripe/v1/checkout HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","CountryCode":"String","Articles":[{"ArticleId":0,"ArticleTypeId":0,"Quantity":0}],"InternalReferenceId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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