BokaMera.API.Host

<back to all web services

CreateCompanyCreditCard

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/billing/company/creditcardAdd a new credit card with Ticket Id from payment solution.Add new credit card from payment solution with their ticket id.
"use strict";
export class CompanyCreditCardQueryResponse {
    /** @param {{Id?:number,Name?:string,Active?:boolean,IsValid?:boolean,Type?:string,ExpYear?:string,ExpMonth?:string,TicketId?:string,Created?:string,Updated?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The credit card id */
    Id;
    /**
     * @type {string}
     * @description The credit card name */
    Name;
    /**
     * @type {boolean}
     * @description If the credit card is active */
    Active;
    /**
     * @type {boolean}
     * @description If the credit card is valid (active and not expired) */
    IsValid;
    /**
     * @type {string}
     * @description The credit card type */
    Type;
    /**
     * @type {string}
     * @description The credit card expiration Year */
    ExpYear;
    /**
     * @type {string}
     * @description The credit card expiration month */
    ExpMonth;
    /**
     * @type {string}
     * @description The credit card ticket name. This is secret information and won't be displayed */
    TicketId;
    /**
     * @type {?string}
     * @description The date when the credit card was saved. */
    Created;
    /**
     * @type {?string}
     * @description The date when the credit card was updated. */
    Updated;
}
export class CreateCompanyCreditCard {
    /** @param {{CompanyId?:string,Name?:string,Type?:string,ExpYear?:string,ExpMonth?:string,TicketId?:string}} [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 The credit card name */
    Name;
    /**
     * @type {string}
     * @description The credit card type. In example Mastercard, Visa */
    Type;
    /**
     * @type {string}
     * @description The credit card expiration Year */
    ExpYear;
    /**
     * @type {string}
     * @description The credit card expiration month */
    ExpMonth;
    /**
     * @type {string}
     * @description The credit card ticket name. This is secret information and won't be displayed */
    TicketId;
}

JavaScript CreateCompanyCreditCard 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 /billing/company/creditcard HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateCompanyCreditCard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ExpMonth>String</ExpMonth>
  <ExpYear>String</ExpYear>
  <Name>String</Name>
  <TicketId>String</TicketId>
  <Type>String</Type>
</CreateCompanyCreditCard>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyCreditCardQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <Created>0001-01-01T00:00:00</Created>
  <ExpMonth>String</ExpMonth>
  <ExpYear>String</ExpYear>
  <Id>0</Id>
  <IsValid>false</IsValid>
  <Name>String</Name>
  <TicketId>String</TicketId>
  <Type>String</Type>
  <Updated>0001-01-01T00:00:00</Updated>
</CompanyCreditCardQueryResponse>