BokaMera.API.Host

<back to all web services

StripeV1CreateCheckout

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)
StripeV1CreateCheckout 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.)
ConfirmationUrlbodystringNoOptional to set your own confirmation url after payment completed.
CancelUrlbodystringNoIf set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is embedded.
UiModebodystringYesThe UI mode of the Session. Defaults to hosted; One of: embedded, or hosted
ArticleToCreate Parameters:
NameParameterData TypeRequiredDescription
ArticleIdformintNo
ArticleTypeIdformintNo
QuantityformintNo
StripeCheckoutQueryResponse Parameters:
NameParameterData TypeRequiredDescription
SessionIdformstringNoThe checkout session id
UrlformstringNoThe url for checkout module to be placed in a iframe
StatusformstringNoThe checkout status
ClientSecretformstringNoClient secret to be used when initializing Stripe.js embedded checkout.

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

{"SessionId":"String","Url":"String","Status":"String","ClientSecret":"String"}