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

export class IpnCallBackResponse
{
    public Message: string;
    public Success: boolean;

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

export class QvicklyIpnCallbackResponseData
{
    public number: string;
    public status: string;
    public orderid: string;
    public url: string;

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

export class QvicklyCheckoutIpnCallBack implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    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 BookingId: string;

    /** @description The payment ipn callback data. */
    // @ApiMember(Description="The payment ipn callback data.")
    public Data: QvicklyIpnCallbackResponseData;

    /** @description Article type (Could be Service, rebate code types, etc.. */
    // @ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)
    public ArticleTypeId: number;

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

TypeScript 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>
  <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>