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
"use strict";
export class IpnCallBackResponse {
    /** @param {{Message?:string,Success?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Message;
    /** @type {boolean} */
    Success;
}
export class ServerDataResponse {
    /** @param {{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}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    HTTP_HOST;
    /** @type {string} */
    HTTP_CONNECTION;
    /** @type {string} */
    HTTP_CACHE_CONTROL;
    /** @type {string} */
    HTTP_ACCEPT;
    /** @type {string} */
    HTTP_USER_AGENT;
    /** @type {string} */
    HTTP_ACCEPT_ENCODING;
    /** @type {string} */
    HTTP_ACCEPT_LANGUAGE;
    /** @type {string} */
    PATH;
    /** @type {string} */
    SERVER_SOFTWARE;
    /** @type {string} */
    SERVER_NAME;
    /** @type {string} */
    SERVER_ADDR;
    /** @type {string} */
    SERVER_PORT;
    /** @type {string} */
    REMOTE_ADDR;
    /** @type {string} */
    REMOTE_PORT;
    /** @type {string} */
    GATEWAY_INTERFACE;
    /** @type {string} */
    SERVER_PROTOCOL;
    /** @type {string} */
    REQUEST_METHOD;
    /** @type {string} */
    QUERY_STRING;
    /** @type {string} */
    REQUEST_TIME;
}
export class CredentialsResponse {
    /** @param {{hash?:string,id?:string,version?:string,client?:string,serverdata?:ServerDataResponse,time?:string,test?:string,language?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    hash;
    /** @type {string} */
    id;
    /** @type {string} */
    version;
    /** @type {string} */
    client;
    /** @type {ServerDataResponse} */
    serverdata;
    /** @type {string} */
    time;
    /** @type {string} */
    test;
    /** @type {string} */
    language;
}
export class QvicklyIpnCallbackResponseData {
    /** @param {{number?:string,status?:string,orderid?:string,url?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    number;
    /** @type {string} */
    status;
    /** @type {string} */
    orderid;
    /** @type {string} */
    url;
}
export class QvicklyCheckoutIpnCallBack {
    /** @param {{CompanyId?:string,BookingId?:string,credentials?:CredentialsResponse,data?:QvicklyIpnCallbackResponseData,ArticleTypeId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description Internal reference id (Could be booking, could be Article..) */
    BookingId;
    /**
     * @type {CredentialsResponse}
     * @description The payment credentials. */
    credentials;
    /**
     * @type {QvicklyIpnCallbackResponseData}
     * @description The payment ipn callback data. */
    data;
    /**
     * @type {number}
     * @description Article type (Could be Service, rebate code types, etc.. */
    ArticleTypeId;
}

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

<QvicklyCheckoutIpnCallBack xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ArticleTypeId>0</ArticleTypeId>
  <BookingId>String</BookingId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <credentials>
    <client>String</client>
    <hash>String</hash>
    <id>String</id>
    <language>String</language>
    <serverdata>
      <GATEWAY_INTERFACE>String</GATEWAY_INTERFACE>
      <HTTP_ACCEPT>String</HTTP_ACCEPT>
      <HTTP_ACCEPT_ENCODING>String</HTTP_ACCEPT_ENCODING>
      <HTTP_ACCEPT_LANGUAGE>String</HTTP_ACCEPT_LANGUAGE>
      <HTTP_CACHE_CONTROL>String</HTTP_CACHE_CONTROL>
      <HTTP_CONNECTION>String</HTTP_CONNECTION>
      <HTTP_HOST>String</HTTP_HOST>
      <HTTP_USER_AGENT>String</HTTP_USER_AGENT>
      <PATH>String</PATH>
      <QUERY_STRING>String</QUERY_STRING>
      <REMOTE_ADDR>String</REMOTE_ADDR>
      <REMOTE_PORT>String</REMOTE_PORT>
      <REQUEST_METHOD>String</REQUEST_METHOD>
      <REQUEST_TIME>String</REQUEST_TIME>
      <SERVER_ADDR>String</SERVER_ADDR>
      <SERVER_NAME>String</SERVER_NAME>
      <SERVER_PORT>String</SERVER_PORT>
      <SERVER_PROTOCOL>String</SERVER_PROTOCOL>
      <SERVER_SOFTWARE>String</SERVER_SOFTWARE>
    </serverdata>
    <test>String</test>
    <time>String</time>
    <version>String</version>
  </credentials>
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QvicklyIntegration.Models.Payment">
    <d2p1:number>String</d2p1:number>
    <d2p1:orderid>String</d2p1:orderid>
    <d2p1:status>String</d2p1:status>
    <d2p1:url>String</d2p1:url>
  </data>
</QvicklyCheckoutIpnCallBack>

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

<IpnCallBackResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Message>String</Message>
  <Success>false</Success>
</IpnCallBackResponse>