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)
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class ArticleToCreate
            Public Overridable Property ArticleId As Integer
            Public Overridable Property ArticleTypeId As Integer
            Public Overridable Property Quantity As Integer
        End Class

        Public Partial Class CreateStripeCheckoutEmbeddedSessionV1
            Implements ICompany
            Public Sub New()
                Articles = New ArticleToCreate(){}
            End Sub

            '''<Summary>
            '''The company id.
            '''</Summary>
            <ApiMember(Description:="The company id.", IsRequired:=true)>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''Country code for checkout
            '''</Summary>
            <ApiMember(Description:="Country code for checkout", IsRequired:=true)>
            Public Overridable Property CountryCode As String

            '''<Summary>
            '''Articles (Could be Service, rebate code types, etc..
            '''</Summary>
            <ApiMember(Description:="Articles (Could be Service, rebate code types, etc..", IsRequired:=true)>
            Public Overridable Property Articles As ArticleToCreate()

            '''<Summary>
            '''An internal reference id (Could be booking, rebate code etc.)
            '''</Summary>
            <ApiMember(Description:="An internal reference id (Could be booking, rebate code etc.)", IsRequired:=true)>
            Public Overridable Property InternalReferenceId As String
        End Class

        Public Partial Class StripeCheckoutQueryResponse
            '''<Summary>
            '''The checkout session id
            '''</Summary>
            <ApiMember(Description:="The checkout session id")>
            Public Overridable Property Number As String

            '''<Summary>
            '''The url for checkout module to be placed in a iframe
            '''</Summary>
            <ApiMember(Description:="The url for checkout module to be placed in a iframe")>
            Public Overridable Property Url As String

            '''<Summary>
            '''The checkout status
            '''</Summary>
            <ApiMember(Description:="The checkout status")>
            Public Overridable Property Status As String
        End Class
    End Namespace
End Namespace

VB.NET CreateStripeCheckoutEmbeddedSessionV1 DTOs

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"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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