BokaMera.API.Host

StripeV1CreateCheckout

The following routes are available for this service:
POST	/payment/stripe/v1/checkout	Create 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 Foundation
import ServiceStack

public class StripeV1CreateCheckout : ICompany, Codable
{
    /**
    * The company id.
    */
    // @ApiMember(Description="The company id.", IsRequired=true)
    public var companyId:String?

    /**
    * Country code for checkout
    */
    // @ApiMember(Description="Country code for checkout", IsRequired=true)
    public var countryCode:String

    /**
    * Articles (Could be Service, rebate code types, etc..
    */
    // @ApiMember(Description="Articles (Could be Service, rebate code types, etc..", IsRequired=true)
    public var articles:[ArticleToCreate] = []

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

    /**
    * Optional to set your own confirmation url after payment completed.
    */
    // @ApiMember(Description="Optional to set your own confirmation url after payment completed.")
    public var confirmationUrl:String

    /**
    * If 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 <c>embedded</c>.
    */
    // @ApiMember(Description="If 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 <c>embedded</c>.")
    public var cancelUrl:String

    /**
    * The UI mode of the Session. Defaults to <c>hosted</c>; One of: <c>embedded</c>, or <c>hosted</c>
    */
    // @ApiMember(Description="The UI mode of the Session. Defaults to <c>hosted</c>; One of: <c>embedded</c>, or <c>hosted</c>", IsRequired=true)
    public var uiMode:String

    required public init(){}
}

public class ArticleToCreate : Codable
{
    public var articleId:Int
    public var articleTypeId:Int
    public var quantity:Int

    required public init(){}
}

public class StripeCheckoutQueryResponse : Codable
{
    /**
    * The checkout session id
    */
    // @ApiMember(Description="The checkout session id")
    public var number:String

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

    /**
    * The checkout status
    */
    // @ApiMember(Description="The checkout status")
    public var status:String

    /**
    * Client secret to be used when initializing Stripe.js embedded checkout.
    */
    // @ApiMember(Description="Client secret to be used when initializing Stripe.js embedded checkout.")
    public var clientSecret:String

    required public init(){}
}

Swift StripeV1CreateCheckout 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

<StripeV1CreateCheckout 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>
  <CancelUrl>String</CancelUrl>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ConfirmationUrl>String</ConfirmationUrl>
  <CountryCode>String</CountryCode>
  <InternalReferenceId>String</InternalReferenceId>
  <UiMode>String</UiMode>
</StripeV1CreateCheckout>

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">
  <ClientSecret>String</ClientSecret>
  <Number>String</Number>
  <Status>String</Status>
  <Url>String</Url>
</StripeCheckoutQueryResponse>