| POST | /payment/payson/v2/checkout | Create an checkout for Booking. Note if existing checkouts already exists, i will invalidate those. | Create payson checkout (requires settings for Payson Checkout 2.0) |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type Payson2CheckoutStatus =
| None = 0
| Created = 1
| FormsFilled = 2
| ReadyToPay = 3
| ProcessingPayment = 4
| ReadyToShip = 5
| Shipped = 6
| PaidToAccount = 7
| Canceled = 8
| Credited = 9
| Expired = 10
| Denied = 11
[<AllowNullLiteral>]
type PaysonCheckoutV2Response() =
///<summary>
///The checkout id
///</summary>
[<ApiMember(Description="The checkout id")>]
member val Id:Guid = new Guid() with get,set
///<summary>
///The code snippet to for checkout module
///</summary>
[<ApiMember(Description="The code snippet to for checkout module")>]
member val Snippet:String = null with get,set
///<summary>
///The checkout status
///</summary>
[<ApiMember(Description="The checkout status")>]
member val Status:Payson2CheckoutStatus = new Payson2CheckoutStatus() with get,set
type PaymentOrigin =
| HomePage = 0
| Embedded = 1
| Admin = 2
| Apps = 3
| HomePageNew = 4
[<AllowNullLiteral>]
type PaysonV2CreateCheckout() =
///<summary>
///The company id.
///</summary>
[<ApiMember(Description="The company id.", IsRequired=true)>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///The reference id. (Could be booking, could be rebate code etc.)
///</summary>
[<ApiMember(Description="The reference id. (Could be booking, could be rebate code etc.)")>]
member val BookingId:String = null with get,set
///<summary>
///The reference id. (Could be booking, could be rebate code etc.)
///</summary>
[<ApiMember(Description="The reference id. (Could be booking, could be rebate code etc.)", IsRequired=true)>]
member val InternalReferenceId:String = null with get,set
///<summary>
///Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason.
///</summary>
[<ApiMember(Description="Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason.")>]
member val CheckoutUrl:Uri = null with get,set
///<summary>
///Optional to set your own confirmation url after payment completed.
///</summary>
[<ApiMember(Description="Optional to set your own confirmation url after payment completed.")>]
member val ConfirmationUrl:Uri = null with get,set
///<summary>
///The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3
///</summary>
[<ApiMember(Description="The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3", IsRequired=true)>]
member val PaymentOrigin:PaymentOrigin = new PaymentOrigin() with get,set
///<summary>
///If you want to have another language (sv, fi, dk, no, en) than the default language in system settings, specify it here. Leave empty if default language should be used.
///</summary>
[<ApiMember(Description="If you want to have another language (sv, fi, dk, no, en) than the default language in system settings, specify it here. Leave empty if default language should be used.", IsRequired=true)>]
member val Language:String = null with get,set
///<summary>
///Country code for checkout
///</summary>
[<ApiMember(Description="Country code for checkout", IsRequired=true)>]
member val CountryCode:String = null with get,set
///<summary>
///Determins if it's a test call
///</summary>
[<ApiMember(Description="Determins if it's a test call")>]
member val TestMode:Boolean = new Boolean() with get,set
///<summary>
///Articles (Could be Service, rebate code types, etc..
///</summary>
[<ApiMember(Description="Articles (Could be Service, rebate code types, etc..", IsRequired=true)>]
member val Articles:ArticleToCreate[] = [||] with get,set
[<AllowNullLiteral>]
type ArticleToCreate() =
member val ArticleId:Int32 = new Int32() with get,set
member val ArticleTypeId:Int32 = new Int32() with get,set
member val Quantity:Int32 = new Int32() with get,set
F# PaysonV2CreateCheckout DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /payment/payson/v2/checkout HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PaysonV2CreateCheckout 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>
<BookingId>String</BookingId>
<CheckoutUrl i:nil="true" />
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<ConfirmationUrl i:nil="true" />
<CountryCode>String</CountryCode>
<InternalReferenceId>String</InternalReferenceId>
<Language>String</Language>
<PaymentOrigin>HomePage</PaymentOrigin>
<TestMode>false</TestMode>
</PaysonV2CreateCheckout>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <PaysonCheckoutV2Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <Id>00000000-0000-0000-0000-000000000000</Id> <Snippet>String</Snippet> <Status>None</Status> </PaysonCheckoutV2Response>