BokaMera.API.Host

PaysonV1CreateCheckout

The following routes are available for this service:
POST	/payment/payson/v1/checkout	Create an checkout for Booking. Note if existing checkouts already exists, i will invalidate those.	Create payson checkout (requires settings for Payson Checkout 1.0)


export enum Payson2CheckoutStatus
{
    None = 'None',
    Created = 'Created',
    FormsFilled = 'FormsFilled',
    ReadyToPay = 'ReadyToPay',
    ProcessingPayment = 'ProcessingPayment',
    ReadyToShip = 'ReadyToShip',
    Shipped = 'Shipped',
    PaidToAccount = 'PaidToAccount',
    Canceled = 'Canceled',
    Credited = 'Credited',
    Expired = 'Expired',
    Denied = 'Denied',
}

export class PaysonCheckoutV2Response
{
    /** @description The checkout id */
    // @ApiMember(Description="The checkout id")
    public Id: string;

    /** @description The code snippet to for checkout module */
    // @ApiMember(Description="The code snippet to for checkout module")
    public Snippet: string;

    /** @description The checkout status */
    // @ApiMember(Description="The checkout status")
    public Status: Payson2CheckoutStatus;

    public constructor(init?: Partial<PaysonCheckoutV2Response>) { (Object as any).assign(this, init); }
}

export enum PaymentOrigin
{
    HomePage = 'HomePage',
    Embedded = 'Embedded',
    Admin = 'Admin',
    Apps = 'Apps',
    HomePageNew = 'HomePageNew',
}

export class PaysonV1CreateCheckout implements ICompany
{
    /** @description The company id. */
    // @ApiMember(Description="The company id.", IsRequired=true)
    public CompanyId: string;

    /** @description Internal reference id (Could be booking, could be Article..) */
    // @ApiMember(Description="Internal reference id (Could be booking, could be Article..)")
    public InternalReferenceId: string;

    /** @description The booking id. */
    // @ApiMember(Description="The booking id.", IsRequired=true)
    public BookingId: number;

    /** @description Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason. */
    // @ApiMember(Description="Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason.")
    public CheckoutUrl: string;

    /** @description Optional to set your own confirmation url after payment completed. */
    // @ApiMember(Description="Optional to set your own confirmation url after payment completed.")
    public ConfirmationUrl: string;

    /** @description The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3, 4 = HomePageNew */
    // @ApiMember(Description="The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3, 4 = HomePageNew", IsRequired=true)
    public PaymentOrigin: PaymentOrigin;

    /** @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. */
    // @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)
    public Language: string;

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

    /** @description Determins if it's a test call */
    // @ApiMember(Description="Determins if it's a test call")
    public TestMode: string;

    public constructor(init?: Partial<PaysonV1CreateCheckout>) { (Object as any).assign(this, init); }
}

export class ArticleToCreate
{
    public ArticleId: number;
    public ArticleTypeId: number;
    public Quantity: number;

    public constructor(init?: Partial<ArticleToCreate>) { (Object as any).assign(this, init); }
}

TypeScript PaysonV1CreateCheckout DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payment/payson/v1/checkout HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","InternalReferenceId":"String","BookingId":0,"PaymentOrigin":"HomePage","Language":"String","Articles":[{"ArticleId":0,"ArticleTypeId":0,"Quantity":0}],"TestMode":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Snippet":"String","Status":"None"}