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)
import java.math.*
import java.util.*
import net.servicestack.client.*


open class CreateStripeCheckoutEmbeddedSessionV1 : ICompany
{
    /**
    * The company id.
    */
    @ApiMember(Description="The company id.", IsRequired=true)
    var CompanyId:UUID? = null

    /**
    * Country code for checkout
    */
    @ApiMember(Description="Country code for checkout", IsRequired=true)
    var CountryCode:String? = null

    /**
    * Articles (Could be Service, rebate code types, etc..
    */
    @ApiMember(Description="Articles (Could be Service, rebate code types, etc..", IsRequired=true)
    var Articles:ArrayList<ArticleToCreate>? = null

    /**
    * An internal reference id (Could be booking, rebate code etc.)
    */
    @ApiMember(Description="An internal reference id (Could be booking, rebate code etc.)", IsRequired=true)
    var InternalReferenceId:String? = null
}

open class ArticleToCreate
{
    var ArticleId:Int? = null
    var ArticleTypeId:Int? = null
    var Quantity:Int? = null
}

open class StripeCheckoutQueryResponse
{
    /**
    * The checkout session id
    */
    @ApiMember(Description="The checkout session id")
    var Number:String? = null

    /**
    * The url for checkout module to be placed in a iframe
    */
    @ApiMember(Description="The url for checkout module to be placed in a iframe")
    var Url:String? = null

    /**
    * The checkout status
    */
    @ApiMember(Description="The checkout status")
    var Status:String? = null
}

Kotlin CreateStripeCheckoutEmbeddedSessionV1 DTOs

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>