BokaMera.API.Host

<back to all web services

QvicklyCheckoutIpnCallBack

The following routes are available for this service:
POST/payment/billmate/v1/ipncallbackIPN callback for Qvickly checkout 1.0IPN callback for Qvickly checkout 1.0
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IpnCallBackResponse:
    message: Optional[str] = None
    success: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServerDataResponse:
    htt_p__h_o_s_t: Optional[str] = None
    htt_p__c_o_n_n_e_c_t_i_o_n: Optional[str] = None
    htt_p__c_a_c_h_e__c_o_n_t_r_o_l: Optional[str] = None
    htt_p__a_c_c_e_p_t: Optional[str] = None
    htt_p__u_s_e_r__a_g_e_n_t: Optional[str] = None
    htt_p__a_c_c_e_p_t__e_n_c_o_d_i_n_g: Optional[str] = None
    htt_p__a_c_c_e_p_t__l_a_n_g_u_a_g_e: Optional[str] = None
    path: Optional[str] = None
    serve_r__s_o_f_t_w_a_r_e: Optional[str] = None
    serve_r__n_a_m_e: Optional[str] = None
    serve_r__a_d_d_r: Optional[str] = None
    serve_r__p_o_r_t: Optional[str] = None
    remot_e__a_d_d_r: Optional[str] = None
    remot_e__p_o_r_t: Optional[str] = None
    gatewa_y__i_n_t_e_r_f_a_c_e: Optional[str] = None
    serve_r__p_r_o_t_o_c_o_l: Optional[str] = None
    reques_t__m_e_t_h_o_d: Optional[str] = None
    quer_y__s_t_r_i_n_g: Optional[str] = None
    reques_t__t_i_m_e: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CredentialsResponse:
    hash: Optional[str] = None
    id: Optional[str] = None
    version: Optional[str] = None
    client: Optional[str] = None
    serverdata: Optional[ServerDataResponse] = None
    time: Optional[str] = None
    test: Optional[str] = None
    language: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QvicklyIpnCallbackResponseData:
    number: Optional[str] = None
    status: Optional[str] = None
    orderid: Optional[str] = None
    url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QvicklyCheckoutIpnCallBack(ICompany):
    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(Description="Internal reference id (Could be booking, could be Article..)")
    booking_id: Optional[str] = None
    """
    Internal reference id (Could be booking, could be Article..)
    """


    # @ApiMember(Description="The payment credentials.")
    credentials: Optional[CredentialsResponse] = None
    """
    The payment credentials.
    """


    # @ApiMember(Description="The payment ipn callback data.")
    data: Optional[QvicklyIpnCallbackResponseData] = None
    """
    The payment ipn callback data.
    """


    # @ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)
    article_type_id: int = 0
    """
    Article type (Could be Service, rebate code types, etc..
    """

Python QvicklyCheckoutIpnCallBack 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/billmate/v1/ipncallback HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","BookingId":"String","credentials":{"hash":"String","id":"String","version":"String","client":"String","serverdata":{"HTTP_HOST":"String","HTTP_CONNECTION":"String","HTTP_CACHE_CONTROL":"String","HTTP_ACCEPT":"String","HTTP_USER_AGENT":"String","HTTP_ACCEPT_ENCODING":"String","HTTP_ACCEPT_LANGUAGE":"String","PATH":"String","SERVER_SOFTWARE":"String","SERVER_NAME":"String","SERVER_ADDR":"String","SERVER_PORT":"String","REMOTE_ADDR":"String","REMOTE_PORT":"String","GATEWAY_INTERFACE":"String","SERVER_PROTOCOL":"String","REQUEST_METHOD":"String","QUERY_STRING":"String","REQUEST_TIME":"String"},"time":"String","test":"String","language":"String"},"data":{"number":"String","status":"String","orderid":"String","url":"String"},"ArticleTypeId":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Message":"String","Success":false}